Skip to content

Commit 00ee921

Browse files
committed
Update README.md
Updated Installation instructions. Added instructions for installing from the new ODM2 anaconda.org channel; and improved the other instructions.
1 parent 69231f0 commit 00ee921

File tree

1 file changed

+43
-24
lines changed

1 file changed

+43
-24
lines changed

README.md

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,48 @@ A Python-based application programmer's interface for the Observations Data Mode
55

66
[List of current and planned functions included in the API](https://github.com/ODM2/ODM2PythonAPI/blob/master/doc/APIFunctionList.md)
77

8-
### Installation
9-
10-
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:
11-
12-
1. Add conda to the PATH; on MacOSX and Linux, it's something like `export PATH=$HOME/miniconda/bin:$PATH`, but the exact path may vary.
13-
2. Go to the directory where `condaenvironment_1.yml` was downloaded.
14-
3. Create a new conda environment. This command will create an environment called 'odm2api_env1':
15-
16-
```bash
17-
conda env create -f condaenvironment_1.yml
18-
```
19-
4. Activate the new environment:
20-
21-
```bash
22-
activate odm2api_env1 # On Windows
23-
source activate odm2api_env1 # On MacOSX or Linux
24-
```
25-
5. Install the `odm2api` package into the environment:
26-
27-
```bash
28-
pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
29-
```
30-
31-
### Credits
8+
## Installation
9+
10+
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 start using conda (if it's not your system default), add conda to the PATH; on MacOSX and Linux, it's something like `export PATH=$HOME/miniconda/bin:$PATH`, but the exact path may vary.
11+
12+
To activate a conda environment, say, "myenv":
13+
```bash
14+
activate myenv # On Windows
15+
source activate myenv # On MacOSX or Linux
16+
```
17+
18+
**Note:** `odm2api` currently is only tested on Python 2.7. Some changes have been made to support Python 3.x, but they haven't been tested thoroughly.
19+
20+
21+
### Latest release, from ODM2 anaconda.org channel
22+
23+
The [latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases) is available on the [ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api) for all major OS paltforms (linux, OSX, win32/win64). To install it on an existing conda environment:
24+
```
25+
conda install -c odm2 odm2api
26+
```
27+
All dependencies are installed, including Pandas and its dependencies (numpy, etc).
28+
29+
To create a new environment "myenv" with the `odm2api` package:
30+
```
31+
conda create -n myenv -c odm2 python=2.7 odm2api
32+
```
33+
34+
### Installing the development version from the `master` branch on github
35+
36+
**Note from 4/26/2016:** These instructions may be slightly outdated. Follow these directions for installing the bleeding edge github master branch, mainly for development and testing purposes.
37+
38+
To create a new environment "myenv" with `odm2api`, first download the conda environment file [condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml). Go to the directory where `condaenvironment_1.yml` was downloaded. Then, on a terminal shell:
39+
```bash
40+
conda env create -n myenv --file py2_conda_environment.yml
41+
```
42+
Activate the new environment, then install `odm2api` into the environment:
43+
```bash
44+
activate odm2api_env1 # On Windows
45+
source activate odm2api_env1 # On MacOSX or Linux
46+
47+
pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
48+
```
49+
50+
## Credits
3251

3352
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.

0 commit comments

Comments
 (0)