diff --git a/README.md b/README.md index 19ec59c..32a1dff 100644 --- a/README.md +++ b/README.md @@ -38,17 +38,17 @@ source activate myenv # On MacOSX or Linux but they haven't been tested thoroughly. -### Latest release, from ODM2 anaconda.org channel +### Latest release, from conda-forge anaconda.org channel The [latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases) is available on the -[ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api) +[conda-forge anaconda.org channel](https://anaconda.org/conda-forge/odm2api) for all major OS paltforms (linux, OSX, win32/win64). To install it on an existing conda environment: ``` -conda install -c odm2 odm2api +conda install -c conda-forge odm2api ``` All dependencies are installed, @@ -57,33 +57,38 @@ including Pandas and its dependencies (numpy, etc). To create a new environment "myenv" with the `odm2api` package: ``` -conda create -n myenv -c odm2 python=2.7 odm2api +conda create -n myenv -c conda-forge python=2.7 odm2api ``` -### Installing the development version from the `master` branch on github - -**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. - -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: - -```bash -conda env create -n myenv --file py2_conda_environment.yml -``` - -Activate the new environment, then install `odm2api` into the environment: - -```bash -activate myenv # On Windows -source activate myenv # On MacOSX or Linux - -pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git -``` +### Installing the development version from the `development` branch on github + +Note: We follow the [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for development. + +1. Download both `requirements.txt` and `requirements-dev.txt`. + ``` bash + wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt + wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt + ``` + +2. Create conda environment `odm2api_dev` from the two `requirements*` text files. + ```bash + conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt + ``` + +3. Activate conda environment. + - MacOSX/Linux: + ```bash + source activate odm2api_dev + ``` + - Windows: + ``` + activate odm2api_dev + ``` + +4. Install the latest commit from the development branch + ```bash + pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api + ``` ## Credits diff --git a/docs/source/installing.rst b/docs/source/installing.rst index a135c24..4064f0f 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -12,7 +12,7 @@ OS X and Linux, it's something like To activate a conda environment, say, "myenv": -.. code:: bash +.. code-block:: bash activate myenv # On Windows source activate myenv # On MacOSX or Linux @@ -21,17 +21,17 @@ To activate a conda environment, say, "myenv": changes have been made to support Python 3.x, but they haven't been tested thoroughly. -Latest release, from ODM2 anaconda.org channel +Latest release, from conda-forge anaconda.org channel ---------------------------------------------- -The `latest release `__ is available -on the `ODM2 anaconda.org channel `__ +The `latest release `_ is available +on the `conda-forge anaconda.org channel `_ for all major OS platforms (linux, OS X, win32/win64). To install it on an existing conda environment: :: - conda install odm2api --channel odm2 + conda install -c conda-forge odm2api All dependencies are installed, including Pandas and its dependencies (numpy, etc). @@ -40,23 +40,42 @@ To create a new environment "myenv" with the ``odm2api`` package: :: - conda create -n myenv -c odm2 python=2.7 odm2api + conda create -n myenv -c conda-forge python=2.7 odm2api -Installing the development version +Installing the development version from the ``development`` branch on github ---------------------------------- -To create a new environment "myenv" with ``odm2api``, first clone the repository. -Then, on a terminal shell: - -.. code:: bash - - conda create --name myenv python=2.7 --file requirements.txt --file requirements-dev.txt -c odm2 - -Activate the new environment, then install ``odm2api`` into the -environment: - -.. code:: bash - - activate myenv # On Windows - source activate myenv # On OS X or Linux +Note: We follow the `Gitflow workflow `__ for development. + +1. Download both ``requirements.txt`` and ``requirements-dev.txt``. + + .. code-block:: bash + + wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements.txt + wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt + +2. Create conda environment ``odm2api_dev`` from the two ``requirements*`` text files. + + .. code-block:: bash + + conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt + +3. Activate conda environment. + - MacOSX/Linux: + + .. code-block:: bash + + source activate odm2api_dev + + - Windows: + + .. code-block:: bash + + activate odm2api_dev + +4. Install the latest commit from the development branch + + .. code-block:: bash + + pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api