Skip to content

Commit 59115f5

Browse files
authored
Update installing.rst
1 parent 50d0db4 commit 59115f5

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

docs/source/installing.rst

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ OS X and Linux, it's something like
1212

1313
To activate a conda environment, say, "myenv":
1414

15-
.. code:: bash
15+
.. code-block:: bash
1616
1717
activate myenv # On Windows
1818
source activate myenv # On MacOSX or Linux
@@ -21,17 +21,17 @@ To activate a conda environment, say, "myenv":
2121
changes have been made to support Python 3.x, but they haven't been
2222
tested thoroughly.
2323

24-
Latest release, from ODM2 anaconda.org channel
24+
Latest release, from conda-forge anaconda.org channel
2525
----------------------------------------------
2626

27-
The `latest release <https://github.com/ODM2/ODM2PythonAPI/releases>`__ is available
28-
on the `ODM2 anaconda.org channel <https://anaconda.org/odm2/odm2api>`__
27+
The `latest release <https://github.com/ODM2/ODM2PythonAPI/releases>`_ is available
28+
on the `conda-forge anaconda.org channel <https://anaconda.org/conda-forge/odm2api>`_
2929
for all major OS platforms (linux, OS X, win32/win64). To install it on
3030
an existing conda environment:
3131

3232
::
3333

34-
conda install odm2api --channel odm2
34+
conda install -c conda-forge odm2api
3535

3636
All dependencies are installed, including Pandas and its dependencies
3737
(numpy, etc).
@@ -40,23 +40,42 @@ To create a new environment "myenv" with the ``odm2api`` package:
4040

4141
::
4242

43-
conda create -n myenv -c odm2 python=2.7 odm2api
43+
conda create -n myenv -c conda-forge python=2.7 odm2api
4444

4545

46-
Installing the development version
46+
Installing the development version from the ``development`` branch on github
4747
----------------------------------
4848

49-
To create a new environment "myenv" with ``odm2api``, first clone the repository.
50-
Then, on a terminal shell:
51-
52-
.. code:: bash
53-
54-
conda create --name myenv python=2.7 --file requirements.txt --file requirements-dev.txt -c odm2
55-
56-
Activate the new environment, then install ``odm2api`` into the
57-
environment:
58-
59-
.. code:: bash
60-
61-
activate myenv # On Windows
62-
source activate myenv # On OS X or Linux
49+
Note: We follow the `Gitflow workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`__ for development.
50+
51+
1. Download both ``requirements.txt`` and ``requirements-dev.txt``.
52+
53+
.. code-block:: bash
54+
55+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt
56+
wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt
57+
58+
2. Create conda environment ``odm2api_dev`` from the two ``requirements*`` text files.
59+
60+
.. code-block:: bash
61+
62+
conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt
63+
64+
3. Activate conda environment.
65+
- MacOSX/Linux:
66+
67+
.. code-block:: bash
68+
69+
source activate odm2api_dev
70+
71+
- Windows:
72+
73+
.. code-block:: bash
74+
75+
activate odm2api_dev
76+
77+
4. Install the latest commit from the development branch
78+
79+
.. code-block:: bash
80+
81+
pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api

0 commit comments

Comments
 (0)