INSTALLATION.rst

Installation

Dependencies

Using

• numpy
• scipy

Testing

• pytest

Documenting

• sphinx >= 3.1
• matplotlib

Installing

$ python setup.py install

Testing

$ pytest

Building the Documentation

$ python setup.py build_sphinx

If the figures do not update

$ touch docs/_autosummary/*.rst

and repeat.

If the documentation seems not to build correctly in other respects:

$ python setup.py build_sphinx --all-files --fresh-env

Documentation can be found in :file:`{STEPPYNGSTOUNES}/build/sphinx/html`.