Skip to content

Commit 74d2028

Browse files
committed
Update README DOCS
1 parent 42679df commit 74d2028

File tree

1 file changed

+23
-28
lines changed

1 file changed

+23
-28
lines changed

README.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ source activate myenv # On MacOSX or Linux
3838
but they haven't been tested thoroughly.
3939

4040

41-
### Latest release, from ODM2 anaconda.org channel
41+
### Latest release, from conda-forge anaconda.org channel
4242

4343
The
4444
[latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases)
4545
is available on the
46-
[ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api)
46+
[conda-forge anaconda.org channel](https://anaconda.org/conda-forge/odm2api)
4747
for all major OS paltforms (linux, OSX, win32/win64).
4848
To install it on an existing conda environment:
4949

5050
```
51-
conda install -c odm2 odm2api
51+
conda install -c conda-forge odm2api
5252
```
5353

5454
All dependencies are installed,
@@ -57,33 +57,28 @@ including Pandas and its dependencies (numpy, etc).
5757
To create a new environment "myenv" with the `odm2api` package:
5858

5959
```
60-
conda create -n myenv -c odm2 python=2.7 odm2api
60+
conda create -n myenv -c conda-forge python=2.7 odm2api
6161
```
6262

63-
### Installing the development version from the `master` branch on github
64-
65-
**Note from 4/26/2016:** These instructions may be slightly outdated.
66-
Follow these directions for installing the bleeding edge GitHub master branch,
67-
mainly for development and testing purposes.
68-
69-
To create a new environment "myenv" with `odm2api`,
70-
first download the conda environment file
71-
[condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml).
72-
Go to the directory where `condaenvironment_1.yml` was downloaded.
73-
Then, on a terminal shell:
74-
75-
```bash
76-
conda env create -n myenv --file py2_conda_environment.yml
77-
```
78-
79-
Activate the new environment, then install `odm2api` into the environment:
80-
81-
```bash
82-
activate myenv # On Windows
83-
source activate myenv # On MacOSX or Linux
84-
85-
pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
86-
```
63+
### Installing the development version from the `development` branch on github
64+
65+
Note: We follow the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for development.
66+
67+
1. Download both `requirements.txt` and `requirements-dev.txt`.
68+
``` bash
69+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt
70+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt
71+
```
72+
73+
2. Create conda environment from the two text files.
74+
```bash
75+
conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt
76+
```
77+
78+
3. Install the latest commit from the development branch
79+
```bash
80+
pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api
81+
```
8782

8883
## Credits
8984

0 commit comments

Comments
 (0)