Skip to content

Update README.rst build instructions #101

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
roryyorke merged 11 commits into from
May 10, 2020
Merged

Update README.rst build instructions #101

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b85b63d
Update README.rst build instructions
roryyorke Apr 11, 2020
7e11225
Apply suggestions from code review
roryyorke Apr 12, 2020
1f02173
Correct coveralls URLs
roryyorke Apr 12, 2020
dc3ac50
Re-arrange to emphasize conda-forge binaries; new Windows build example
roryyorke Apr 25, 2020
e277d0b
Remove buggy and unsupported Windows conda-recipe build scripts
roryyorke Apr 25, 2020
5ac22a9
Add info on getting the required macOS SDK
roryyorke Apr 25, 2020
a292586
Renaming CREDITS to AUTHORS
roryyorke May 2, 2020
1b692cd
Update copyright and authors
roryyorke May 2, 2020
976b332
Fix-up MANIFEST.in
roryyorke May 2, 2020
cb791af
Change README.rst version specifiers, Windows build instructions
roryyorke May 2, 2020
f8891e4
Expand heading and fix typo in README.rst
roryyorke May 2, 2020
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
Next Next commit
Update README.rst build instructions 
- note tests depend on scipy
- remove reference to deleted conda-build
- added conda instructions per platform (Linux, macOS, Windows)
- remove instruction installing "plain" LAPACK from conda
- minor rewording and fixes
  • Loading branch information
@roryyorke
roryyorke committed May 2, 2020
commit b85b63d410f77d63c2c2f6131117b5d9ccebcf42
44 changes: 24 additions & 20 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Riccati, Lyapunov, and Sylvester equations.
Dependencies
------------

Slycot supports Python versions 2.7 and >=3.5.
Slycot supports Python versions 2.7, and 3.5 or later.

To run the compiled Slycot package, the following must be installed as
dependencies:
Expand All @@ -32,12 +32,14 @@ following dependencies:

- Python 2.7, 3.5+
- NumPy
- scikit-build >=0.8.1
- cmake
- scikit-build
- CMake
- C compiler (e.g. gcc, MS Visual C++)
- FORTRAN compiler (e.g. gfortran, ifort, flang)
- BLAS/LAPACK (e.g. OpenBLAS, ATLAS, MKL)

To run the Slycot unit tests and examples, you'll also need scipy.

There are a variety of ways to install these dependencies on different
operating systems. See the individual packages' documentation for options.

Expand Down Expand Up @@ -87,34 +89,36 @@ before running the install::
# Windows:
set FC=D:\path\to\my\fortran.exe

To build and install execute::
To build and install, execute::

cd /path/to/slycot_src/
python setup.py install

You can also use conda to build and install Slycot from source::
You can also use conda to build and install Slycot from source, but
you'll have to choose the right recipe directory.

conda build conda-recipe
conda install --use-local slycot
On Linux you can choose between conda-recipe-openblas and
conda-recipe-mkl

If you prefer to use the OpenBLAS library, a conda recipe is available in
``conda-recipe-openblas``.
On macOS you should use conda-recipe-apple.

Additional tips for how to install Slycot from source can be found in the
``.travis.yml`` (commands used for Travis CI) and conda-recipe/ (conda
pre-requisites) both which are included in the source code repository.
On Windows you can try either conda-recipe-openblas or
conda-recipe-mkl; they allow for Windows builds, but we don't
regularly test on that OS. The Windows builds use flang, which is
incompatible with Python 2.7.

The hardest part about installing from source is getting a working version of
FORTRAN and LAPACK installed on your system and working properly with Python.
On Windows, the build system currently uses flang, which can be installed from
conda-forge. Note that flang is incompatible with Python 2.7.
For example, to build with the OpenBLAS recipe::

If you are using conda, you can also get working (binary) copies of LAPACK from
conda-forge using the command::
conda build conda-recipe-openblas
conda install --use-local slycot

conda install -c conda-forge lapack
Additional tips for how to install Slycot from source can be found in the
``.travis.yml`` (commands used for Travis CI) and conda-recipe/ (conda
pre-requisites) both which are included in the source code repository.

Slycot will also work with the OpenBLAS libraries.
The hardest part about installing from source is getting a working
version of FORTRAN and LAPACK (provided by OpenBLAS, MKL, etc.)
installed on your system and working properly with Python.

Note that in some cases you may need to set the ``LIBRARY_PATH`` environment
variable to pick up dependencies such as ``-lpythonN.m`` (where N.m is the
Expand Down