Skip to content

Commit a0afc51

Browse files
authored
Update README.md
1 parent 7caff69 commit a0afc51

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ extract_model
55
[![License:MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
66
[![Documentation Status](https://img.shields.io/readthedocs/extract_model/latest.svg?style=for-the-badge)](https://extract_model.readthedocs.io/en/latest/?badge=latest)
77
[![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)
8+
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/extract_model.svg?style=for-the-badge)](https://anaconda.org/conda-forge/extract_model)
89

910

1011
Facilitates read-in and extraction for ocean model output.
@@ -15,26 +16,33 @@ Facilitates read-in and extraction for ocean model output.
1516

1617
## Installation
1718

19+
### From conda-forge
20+
21+
```
22+
conda install -c conda-forge extract_model
23+
```
24+
25+
### With environment
26+
1827
Clone the repo:
1928
``` bash
2029
$ git clone https://github.com/axiom-data-science/extract_model.git
2130
```
2231

2332
In the `extract_model` directory, install conda environment:
24-
* for Mac:
2533
``` bash
26-
$ conda env create -f environment-mac.yml
27-
```
28-
* for Linux:
29-
``` bash
30-
$ conda env create -f environment-linux.yml
34+
$ conda env create -f environment.yml
3135
```
3236

33-
For local package install, in the `extract_model` directory:
37+
### Local
38+
39+
For local package install, after cloning the repository, in the `extract_model` directory:
3440
``` bash
3541
$ pip install -e .
3642
```
3743

44+
### Development
45+
3846
To also develop this package, install additional packages with:
3947
``` bash
4048
$ conda install --file requirements-dev.txt

0 commit comments

Comments
 (0)