Skip to content

Small documentation updates #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slivingston merged 10 commits into from
Dec 31, 2016
Merged

Small documentation updates #123

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dbf0a9d
DOC: updated Slycot URL to github.com/python-control
murrayrm Dec 27, 2016
4cbd4cb
DOC: default method for sample_system was incorrect
murrayrm Dec 27, 2016
06b5fe4
DOC: created conventions section in manual + moved doc for time serie…
murrayrm Dec 27, 2016
c253d33
DOC: added documentation for return_x
murrayrm Dec 27, 2016
2111117
DOC: removed redundant entries for frequency domain plots
murrayrm Dec 27, 2016
1f15678
add robust module to list of included files
murrayrm Dec 27, 2016
92570bc
TRV: use double quotes for multi-line comment
murrayrm Dec 27, 2016
303480f
DOC: add missing functions to documentation list
murrayrm Dec 27, 2016
93b50b1
Add documentation for custom configurations
murrayrm Dec 27, 2016
349025b
DOC: updated installation instructions (including conda as an option)
murrayrm Dec 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
DOC: updated installation instructions (including conda as an option)
  • Loading branch information
@murrayrm
murrayrm committed Dec 29, 2016
commit 349025b4dfcec8f99dc46bd5db422a0d9a1a007f
35 changes: 28 additions & 7 deletions doc/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,38 @@ some thing to keep in mind:
Installation
------------

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

To install using pip::

pip install slycot # optional
pip install control

Many parts of `python-control` will work without `slycot`, but some
functionality is limited or absent, and installation of `slycot` is
recommended.

*Note*: the `slycot` library only works on some platforms, mostly
linux-based. Users should check to insure that slycot is installed
correctly by running the command::

python -c "import slycot"

and verifying that no error message appears. It may be necessary to install
`slycot` from source, which requires a working FORTRAN compiler and the
`lapack` library. More information on the slycot package can be obtained
from the `slycot project page <https://github.com/python-control/Slycot>`_.

For users with a working the Anaconda distribution of Python, the following

@slivingston slivingston Dec 31, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be "...with the Anaconda distribution..."?

@murrayrm If you agree, I can merge and then delete the words "a working".

@slivingston slivingston Dec 31, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change is trivial, if the text should indeed be different, and can be applied directly to master branch.

command can be used::

conda install -c python-control -c cyclus slycot python-control

This installs `slycot` and `python-control` from the `python-control`
channel and uses the `cyclus` channel to obtain the required `lapack`
package.

Alternatively, to use setuptools, first `download the source <https://github.com/python-control/python-control/releases>`_ and unpack
it. To install in your home directory, use::

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

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

Getting Started
---------------
Expand Down