Skip to content

Commit dd8ac27

Browse files
murrayrmmurrayrm
committed
updated README to capture conflicted changes from PR python-control#22 
1 parent fdcc0ef commit dd8ac27

1 file changed

Lines changed: 43 additions & 42 deletions

File tree

‎README.rst‎

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
Slycot
2-
=============
2+
======
3+
4+
.. image:: https://img.shields.io/pypi/v/slycot.svg
5+
:target: https://pypi.org/project/slycot/
6+
7+
.. image:: https://anaconda.org/conda-forge/slycot/badges/version.svg
8+
:target: https://anaconda.org/conda-forge/slycot
39

410
.. image:: https://travis-ci.org/python-control/slycot.svg?branch=master
5-
:target: https://travis-ci.org/python-control/slycot
11+
:target: https://travis-ci.org/python-control/slycot
12+
613
.. image:: https://coveralls.io/repos/python-control/slycot/badge.png
7-
:target: https://coveralls.io/r/python-control/slycot
14+
:target: https://coveralls.io/r/python-control/slycot
815

916
Python wrapper for selected SLICOT routines, notably including solvers for
1017
Riccati, Lyapunov, and Sylvester equations.
1118

1219

13-
Prerequisites:
14-
--------------
20+
Dependencies
21+
------------
1522

1623
Slycot depends on Numpy and, if you are installing a binary distribution,
1724
Numpy should be the only prerequisite (though you may need the LAPACK
@@ -23,13 +30,13 @@ compiler, such as gfortran, and BLAS/LAPACK libraries.
2330
On Debian derivatives you should be able to install all the above with a
2431
single command::
2532

26-
sudo apt-get build-dep python-scipy
33+
sudo apt-get build-dep python-scipy
2734

2835
On Mac, you will first need to install the `developer tools
2936
<https://developer.apple.com/xcode/>`_. You can then install gfortran using
3037
`homebrew <http://brew.sh>`_ with::
3138

32-
brew install gcc
39+
brew install gcc
3340

3441
On Windows, we suggest installing on top of the Python(x,y) distribution, and
3542
grabbing BLAS and LAPACK libraries from:
@@ -39,64 +46,65 @@ http://icl.cs.utk.edu/lapack-for-windows/libraries/VisualStudio/3.4.1/Dynamic-MI
3946
* install dll files in C:\Python27\DLLs
4047
* install lib files in C:\Python27\libs
4148

42-
4349
Installing
4450
-----------
4551

4652
Using pip
4753
~~~~~~~~~
4854

49-
Slycot supports the pip packaging system. You must first have
50-
pip installed.
55+
Slycot supports the pip packaging system. You must first have pip installed.
5156

52-
On debian linux based systems you can install pip with the command::
57+
On Debian Linux based systems you can install pip with the command::
5358

54-
sudo apt-get install pip
59+
sudo apt-get install pip
5560

56-
Pip can then be used to install Slycot wih the command::
61+
Pip can then be used to install Slycot with the command::
5762

58-
sudo pip install slycot
63+
pip install slycot
5964

60-
There are some binary "wheels" available on PyPI, so if those versions match
61-
with your system, you may be able to avoid installing from source.
65+
Note that installing with pip may or may not require having the build
66+
dependencies installed. There are some binary "wheels" available on PyPI,
67+
so if those versions match with your system, you may be able to avoid
68+
installing from source.
6269

6370
Using conda
6471
~~~~~~~~~~~
6572

66-
If you use `Anaconda or conda <http://continuum.io/downloads>`_ on Linux or Mac,
67-
it should be straighforward to install Slycot, without needing any compilers or
68-
other prerequisites. Slycot is not included in the standard conda package
69-
repository, but there are packages available on conda-forge for Linux and
70-
Mac. You can install with the following command::
71-
72-
conda install -c conda-forge slycot
73+
Slycot can be installed for Linux or Mac via the conda package manager from
74+
the conda-forge channel with the following command::
7375

76+
conda install -c conda-forge slycot
7477

75-
From Source
78+
From source
7679
~~~~~~~~~~~
7780

78-
Unpack to a directory of your choice, say /path/to/slycot_src/, and execute::
81+
Unpack the course code to a directory of your choice,
82+
e.g. ``/path/to/slycot_src/``, and execute::
7983

80-
cd /path/to/slycot_src/
81-
# python setup.py install
84+
cd /path/to/slycot_src/
85+
python setup.py install
8286

8387
Where # is for commands that needs to be executed as root/administrator.
8488

8589
If the build fails and you are on a 64bit OS you may want to try::
8690

87-
cd /path/to/slycot_src/
88-
python setup.py config_fc --arch="-march=x86-64" build
89-
# python setup.py install
91+
python setup.py config_fc --arch="-march=x86-64" build
92+
python setup.py install
93+
94+
You can also use conda to build and install slycot from source::
95+
96+
conda build conda-recipe
97+
conda install --use-local slycot
9098

9199
For Windows, and using Python(x,y), specify that you are using the
92-
mingw compiler. Create a file
100+
mingw compiler. Create a file
93101

94-
C:\\Python27\\Lib\\distutils\\distutils.cfg
102+
C:\\Python27\\Lib\\distutils\\distutils.cfg
95103

96-
with as contents::
104+
with contents::
97105

98-
[build]
99-
compiler=mingw32
106+
[build]
107+
compiler=mingw32
100108

101109
Additional tips for how to install slycot from source can be found in the
102110
.travis.yml (commands used for Travis CI) and conda-recipe/ (conda
@@ -110,10 +118,3 @@ properly with Python. If you are using conda, you can also get working
110118
Note that in some cases you may need to set the LIBRARY_PATH environment
111119
variable to pick up dependencies such as -lpythonN.m (where N.m is the
112120
version of python you are using).
113-
114-
115-
To-Do
116-
------
117-
118-
- write unit tests, already added test script, and simple test
119-
- add examples in the doc-strings

0 commit comments

Comments
 (0)