Skip to content

enhance testing section in README #132

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 1 commit into from
May 23, 2020
Merged

enhance testing section in README #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ you'll have to choose the right recipe directory.
On Linux you can choose between ``conda-recipe-openblas`` and
``conda-recipe-mkl``

On macOS you should use ``conda-recipe-apple``. See the
On macOS you should use ``conda-recipe-apple``. See the
`conda-build documentation`_ how to get the required macOS SDK.

.. _conda-build documentation: https://docs.conda.io/projects/conda-build/en/latest/resources/compiler-tools.html#macos-sdk
Expand Down Expand Up @@ -129,9 +129,16 @@ install Slycot (this example creates a Python 3.8 environment)::
conda activate build-slycot

python setup.py install
pytest

The final ``pytest`` command is optional; it runs the Slycot unit tests.
Testing
~~~~~~~
To test if the installation was successful, you can run the slycot unit tests::

pytest --pyargs slycot

Running ``pytest`` without ``--pyargs slycot`` from inside the source directory
will fail, unless either ``setup.cfg`` or the compiled wrapper library have
been installed into that directory.

General notes on compiling
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down