Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit 030d807

Browse files
authored
Merge pull request #522 from juanchopanza/master
Update installation documentation.
2 parents 04259cf + 4edd31a commit 030d807

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

doc/source/install.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ It is recommended that you use `pip <https://pip.pypa.io/en/stable/>`_ to instal
3737
``NeuroM`` into a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_. For details on
3838
how to set it up, see :ref:`venv-label`
3939

40-
Once the :ref:`virtualenv is set up<venv-label>` is set up and the
41-
:ref:`pre-installed dependencies<pre-dep-label>` are taken care of,
40+
Once the :ref:`virtualenv is set up<venv-label>` is set up,
4241
there are three ways to install ``NeuroM``
4342

4443
#. From the official Python Package Index server (PyPI)
@@ -106,7 +105,21 @@ Here, the ``--system-site-packages`` option has been used. This is because depen
106105
``matplotlib`` aren't trivial to build in a ``virtualenv``. This setting allows python packages
107106
installed in the system to be used inside the ``virtualenv``.
108107

109-
The prompt indicates that the ``virtualenv`` has been activated. To de-activate it,
108+
The prompt indicates that the ``virtualenv`` has been activated.
109+
110+
For efficient installation of dependencies with C extensions, it is recommended to
111+
use ``pip`` version 8 or higher. You can check your ``virtuanenv``'s version
112+
with ``pip --version``, and upgrade if it is too low:
113+
114+
.. code-block:: bash
115+
116+
$(nrm) pip --version # Check pip version. Should output version >= 8.0.0
117+
$(nrm) pip install --upgrade pip # Install newest pip inside virtualenv if version too old.
118+
$(nrm) pip --version # New version should be >= 8.0.0
119+
120+
This will allow use of pre-compiled python packages most platforms.
121+
122+
To de-activate the virtualenvr run the ``deactivate`` command:
110123

111124
.. code-block:: bash
112125

0 commit comments

Comments
 (0)