Skip to content

Commit

Permalink
enhance testing section in README [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
bnavigator committed May 23, 2020
1 parent 47e3201 commit 6039956
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.rst
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

0 comments on commit 6039956

Please sign in to comment.