Skip to content

Commit a658a26

Browse files
committed
Update README.md
Added conda installation instructions
1 parent eb5040c commit a658a26

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,27 @@ A Python-based application programmer's interface for the Observations Data Mode
66
### Credits
77

88
This work was supported by National Science Foundation Grants [EAR-1224638](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1224638) and [ACI-1339834](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1339834). Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
9+
10+
### Installation
11+
12+
Currently the easiest and most reliable way to install the ODM2 Python API (`odm2api`) is using the [Conda package management system](http://conda.pydata.org/docs/) via either [Anaconda](https://www.continuum.io/downloads) or [Miniconda](http://conda.pydata.org/miniconda.html). To create a new `odm2api` environment, first download the conda environment file [condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml). Then, on a terminal shell:
13+
14+
1. Go to the directory where `condaenvironment_1.yml` was downloaded.
15+
2. Create a new conda environment. This command will create an environment called 'odm2api_env1':
16+
17+
```bash
18+
conda env create -f condaenvironment_1.yml
19+
```
20+
3. Activate the new environment:
21+
22+
```bash
23+
activate odm2api_env1 # On Windows
24+
```
25+
```bash
26+
source activate odm2api_env1 # On OS X or Linux
27+
```
28+
4. Install the `odm2api` package into the environment:
29+
30+
```bash
31+
pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
32+
```

0 commit comments

Comments
 (0)