Metadata-Version: 2.0
Name: fslpy
Version: 1.0.1
Summary: FSL Python library
Home-page: https://git.fmrib.ox.ac.uk/fsl/fslpy
Author: Paul McCarthy
Author-email: pauldmccarthy@gmail.com
License: Apache License Version 2.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: indexed-gzip (<0.4,>=0.3.3)
Requires-Dist: nibabel (<3.0,>=2.1)
Requires-Dist: numpy (>=1.11.1,<2.0)
Requires-Dist: six (>=1.10.0,<2.0)
Requires-Dist: wxPython (<=4.0.0a2,>=3.0.2.0)

fslpy
=====


The `fslpy` project is a [FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/)
programming library written in Python. It is used by
[FSLeyes](https://git.fmrib.ox.ac.uk/paulmc/fsleyes/).


Dependencies
------------


All of the dependencies of `fslpy` are listed in the
[requirements.txt](requirements.txt) file. Some `fslpy` modules require
[wxPython](http://www.wxpython.org) 3.0.2.0.


Documentation
-------------

`fslpy` is documented using [sphinx](http://http://sphinx-doc.org/). You can
build the API documentation by 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](doc/contributing.rst).


Tests
-----

Run the test suite via:

    python setup.py test

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


