Skip to content

Commit

Permalink
updated readme, not pypi anymore
Browse files Browse the repository at this point in the history
  • Loading branch information
kthyng committed May 18, 2021
1 parent 2cd3500 commit af12335
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
File renamed without changes.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ extract_model
[![Build Status](https://img.shields.io/github/workflow/status/axiom-data-science/extract_model/Tests?logo=github&style=for-the-badge)](https://github.com/axiom-data-science/extract_model/actions)
[![Code Coverage](https://img.shields.io/codecov/c/github/axiom-data-science/extract_model.svg?style=for-the-badge)](https://codecov.io/gh/axiom-data-science/extract_model)
[![License:MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![pypi](https://img.shields.io/pypi/v/extract_model.svg?style=for-the-badge)](https://pypi.org/project/extract_model)
[![Documentation Status](https://img.shields.io/readthedocs/extract_model/latest.svg?style=for-the-badge)](https://extract_model.readthedocs.io/en/latest/?badge=latest)
[![Code Style Status](https://img.shields.io/github/workflow/status/axiom-data-science/extract_model/linting%20with%20pre-commit?label=Code%20Style&style=for-the-badge)](https://github.com/axiom-data-science/extract_model/actions)


Facilitates read-in and extraction for ocean model output.

--------
Expand All @@ -14,7 +16,12 @@ Facilitates read-in and extraction for ocean model output.

## Installation

To install conda environment:
Clone the repo:
``` bash
$ git clone https://github.com/axiom-data-science/extract_model.git
```

In the `extract_model` directory, install conda environment:
* for Mac:
``` bash
$ conda env create -f environment-mac.yml
Expand All @@ -24,6 +31,11 @@ $ conda env create -f environment-mac.yml
$ conda env create -f environment-linux.yml
```

For local package install, in the `extract_model` directory:
``` bash
$ pip install -e .
```

To also develop this package, install additional packages with:
``` bash
$ conda install --file requirements-dev.txt
Expand Down

0 comments on commit af12335

Please sign in to comment.