Skip to content

Commit

Permalink
Merge pull request #526 from juanchopanza/install-docs
Browse files Browse the repository at this point in the history
Simplify installation instructions.
  • Loading branch information
juanchopanza authored Oct 11, 2016
2 parents 02f61e7 + 4d5d229 commit c3cc0bc
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 21 deletions.
24 changes: 10 additions & 14 deletions doc/source/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,16 @@ Build and runtime

``NeuroM`` requires Python version 2.6 or higher (but not version 3.x).
When installed using `pip <https://pip.pypa.io/en/stable/>`_, ``NeuroM``
will take care of installing unmet dependencies.
However, for best performance, it may be preferable to pre-install the following
subset into your system before installing ``NeuroM``. These typically have installation
packages available for must common Linux distributions and Mac OSX:

* `numpy <http://www.numpy.org/>`_
* `scipy <http://www.scipy.org/>`_
* `matplotlib <http://www.matplotlib.org/>`_
* `h5py <http://www.h5py.org/>`_

These remaining dependencies are lightweight and can be left to the automatic installation:

* `enum34 <https://pypi.python.org/pypi/enum34/>`_
* `pyyaml <http://www.pyyaml.org/>`_
will take care of installing unmet dependencies, although it is also possible
to pre-install before ``NeuroM``.

* `numpy <http://www.numpy.org/>`_ >= 1.8.0
* `scipy <http://www.scipy.org/>`_ >= 0.17.0
* `matplotlib <http://www.matplotlib.org/>`_ >= 1.3.1
* `h5py <http://www.h5py.org/>`_ >= 2.2.1
* `enum34 <https://pypi.python.org/pypi/enum34/>`_ >= 1.0.4
* `pyyaml <http://www.pyyaml.org/>`_ >= 3.10.0
* `tqdm <https://pypi.python.org/pypi/tqdm/>`_ tqdm >= 4.8.4


Installing and building
Expand Down
17 changes: 11 additions & 6 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,18 @@ Virtualenv setup

.. code-block:: bash
$ virtualenv --system-site-packages nrm # creates a virtualenv called "nrm" in nrm directory
$ source nrm/bin/activate # activates virtualenv
(nrm)$ # now we are in the nrm virtualenv
$ virtualenv nrm # creates a virtualenv called "nrm" in nrm directory
$ source nrm/bin/activate # activates virtualenv
(nrm)$ # now we are in the nrm virtualenv
This will create a virtualenv that is isolated from system-wide python packages. If you
prefer to use :ref:`pre-installed dependencies<pre-dep-label>`, you may use
the ``--system-site-packages`` option, which allows globally installed python packages
to be used inside the ``virtualenv``:

Here, the ``--system-site-packages`` option has been used. This is because dependencies such as
``matplotlib`` aren't trivial to build in a ``virtualenv``. This setting allows python packages
installed in the system to be used inside the ``virtualenv``.
.. code-block:: bash
$ virtualenv --system-site-packages nrm # creates a virtualenv called "nrm" in nrm directory
The prompt indicates that the ``virtualenv`` has been activated.

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
from optparse import Option


VERSION = "1.1.0"
VERSION = "1.1.1"


def parse_reqs(reqs_file):
Expand Down

0 comments on commit c3cc0bc

Please sign in to comment.