Skip to content

Commit 349025b

Browse files
committed
DOC: updated installation instructions (including conda as an option)
1 parent 93b50b1 commit 349025b

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

doc/intro.rst

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,38 @@ some thing to keep in mind:
3535
Installation
3636
------------
3737

38-
The `python-control` package may be installed using pip or the standard
39-
distutils/setuptools mechanisms.
38+
The `python-control` package may be installed using pip, conda or the
39+
standard distutils/setuptools mechanisms.
4040

4141
To install using pip::
4242

4343
pip install slycot # optional
4444
pip install control
4545

46+
Many parts of `python-control` will work without `slycot`, but some
47+
functionality is limited or absent, and installation of `slycot` is
48+
recommended.
49+
50+
*Note*: the `slycot` library only works on some platforms, mostly
51+
linux-based. Users should check to insure that slycot is installed
52+
correctly by running the command::
53+
54+
python -c "import slycot"
55+
56+
and verifying that no error message appears. It may be necessary to install
57+
`slycot` from source, which requires a working FORTRAN compiler and the
58+
`lapack` library. More information on the slycot package can be obtained
59+
from the `slycot project page <https://github.com/python-control/Slycot>`_.
60+
61+
For users with a working the Anaconda distribution of Python, the following
62+
command can be used::
63+
64+
conda install -c python-control -c cyclus slycot python-control
65+
66+
This installs `slycot` and `python-control` from the `python-control`
67+
channel and uses the `cyclus` channel to obtain the required `lapack`
68+
package.
69+
4670
Alternatively, to use setuptools, first `download the source <https://github.com/python-control/python-control/releases>`_ and unpack
4771
it. To install in your home directory, use::
4872

@@ -54,11 +78,8 @@ or to install for all users (on Linux or Mac OS)::
5478
sudo python setup.py install
5579

5680
The package requires `numpy` and `scipy`, and the plotting routines require
57-
`matplotlib`. In addition, some routines use a module called `slycot`, which is
58-
a Python wrapper around some FORTRAN routines. Many parts of `python-control`
59-
will work without `slycot`, but some functionality is limited or absent, and
60-
installation of `slycot` is recommended. For more information, see the GitHub
61-
repository for `slycot <https://github.com/python-control/Slycot>`_.
81+
`matplotlib`. In addition, some routines require the `slycot` module,
82+
described above.
6283

6384
Getting Started
6485
---------------

0 commit comments

Comments
 (0)