fslpy

The fslpy project is a FSL programming library written in Python. It is used by FSLeyes.

Dependencies

All of the dependencies of fslpy are listed in the requirements.txt file. Some fslpy modules require wxPython 3.0.2.0.

Documentation

fslpy is documented using sphinx. You can build the API documentation by installing sphinx and sphinx-rtd-theme, and running:

python setup.py doc

The HTML documentation will be generated and saved in the doc/html/ directory.

If you are interested in contributing to fslpy, check out the contributing guide.

Tests

To run the tests, install mock, pytest, pytest-runner, pytest-html, and pytest-cov, and then run:

python setup.py test

A test report will be generated at report.html, and a code coverage report will be generated in htmlcov/.