Skip to content

Commit

Permalink
Merge pull request #345 from willfurnass/accidental_install_from_pypi
Browse files Browse the repository at this point in the history
Docs: guard against accidentally installing from PyPI instead of Git clone
  • Loading branch information
jarmarshall authored Sep 16, 2019
2 parents 8810f1c + fc16a7d commit 511c47a
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,21 @@ Installing MuMoT within a Conda environment

.. code:: sh
source activate mumot-env # on macOS/Linux
source activate mumot-env # on macOS/Linux with older versions of conda
conda activate mumot-env # on macOS/Linux with newer versions of conda
activate mumot-env # on Windows
#. *Install* MuMoT and dependencies into this conda environment:


.. code:: sh
conda install graphviz
python -m pip install path/to/clone/of/MuMoT/repository
NB if your clone of the MuMot repository is a subdirectory of the current directory,
make sure you run ``python3 -m pip install ./MuMoT`` instead of ``python3 -m pip install MuMoT``
(to ensure MuMoT is installed from your Git clone and not :ref:`from PyPI<pypi_inst>`).

.. _venv_inst:

Expand Down Expand Up @@ -111,6 +116,12 @@ Installing MuMoT within a VirtualEnv
python3 -m pip install path/to/clone/of/MuMoT/repository
jupyter nbextension enable --py widgetsnbextension --sys-prefix
NB if your clone of the MuMot repository is a subdirectory of the current directory,
make sure you run ``python3 -m pip install ./MuMoT`` instead of ``python3 -m pip install MuMoT``
(to ensure MuMoT is installed from your Git clone and not :ref:`from PyPI<pypi_inst>`).

.. _pypi_inst:

Installing MuMoT from PyPI
--------------------------

Expand Down

0 comments on commit 511c47a

Please sign in to comment.