Skip to content

Commit 70f0a02

Browse files
committed
update documentation with pip install for optional dependencies
1 parent a3470d4 commit 70f0a02

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

source/userguide_doc.rst

+26-6
Original file line numberDiff line numberDiff line change
@@ -903,10 +903,9 @@ Parallel parameter scans
903903
When performing large multi-dimensional parameter scans, PySCeS has the option
904904
to perform the computation in parallel, either on a single machine with a
905905
multi-core CPU, or on a multi-node cluster. This requires a working
906-
`ipyparallel`_ installation. The functionality is accessed via the
907-
``pysces.ParScanner`` class, which has the same methods as the
908-
``pysces.Scanner`` class (see above) with a few multiprocessing-specific
909-
additions.
906+
`ipyparallel`_ installation (see also :ref:`Installation`). The functionality is accessed
907+
via the ``pysces.ParScanner`` class, which has the same methods as the ``pysces.Scanner``
908+
class (see above) with a few multiprocessing-specific additions.
910909

911910
The parallel scanner class is instantiated with a loaded PySCeS model object: ::
912911

@@ -1260,6 +1259,9 @@ the following packages/modules are also installed:
12601259
- *Assimulo* to enable CVODE support. This can be installed on Anaconda via the
12611260
*conda-forge* channel, or compiled from source
12621261
(https://jmodelica.org/assimulo).
1262+
1263+
- *ipyparallel* for parallel parameter scans (see
1264+
https://ipyparallel.readthedocs.io/)
12631265

12641266
- *pysces_metatool* (available via https://github.com/PySCeS/pysces-metatool)
12651267
to add elementary mode analysis support to PySCeS.
@@ -1269,6 +1271,7 @@ non-linear solver. This software is distributed under its own
12691271
non-commercial licence. Please see https://github.com/PySCeS/pysces
12701272
for details.
12711273

1274+
.. _Installation:
12721275

12731276
Installation
12741277
------------
@@ -1278,13 +1281,30 @@ provided. Anaconda users can conveniently install PySCeS with: ::
12781281

12791282
$ conda install -c conda-forge -c pysces pysces
12801283
1281-
Any dependencies will be installed automatically.
1284+
Any dependencies will be installed automatically, including the optional dependencies
1285+
*Assimulo*, *ipyparallel* and *libSBML*.
12821286

1283-
Alternatively, you can use *pip* to install PySCeS from PyPI. Again,
1287+
Alternatively, you can use *pip* to install PySCeS from PyPI. Core
12841288
dependencies will be installed automatically. ::
12851289

12861290
$ pip install pysces
12871291
1292+
To install the optional dependences:
1293+
1294+
- ``pip install "pysces[parscan]"`` - for *ipyparallel*
1295+
- ``pip install "pysces[sbml]"`` - for *libSBML*
1296+
- ``pip install "pysces[cvode]"`` - for *Assimulo*
1297+
- ``pip install "pysces[all]"`` - for all of the above
1298+
1299+
.. note::
1300+
1301+
Installation of *Assimulo* via ``pip`` may well require C and Fortran compilers to be
1302+
properly set up on your system, as binary packages are only provided for a
1303+
very limited number of Python versions and operating systems on PyPI.
1304+
**This is not guaranteed to work!** If you require Assimulo, the conda
1305+
install is by far the easier option as up-to-date binaries are supplied
1306+
for all OS and recent Python versions.
1307+
12881308
Compilation from source
12891309
-----------------------
12901310

0 commit comments

Comments
 (0)