fsleyes-widgets 0.17.0

A collection of wxPython widgets used by FSLeyes

The fsleyes-widgets package contains a collection of GUI widgets and utilities, based on wxPython. These widgets are used by fsleyes-props and FSLeyes,

Installation

You can install fsleyes-widgets via pip. If you are using Linux, you need to install wxPython first, as binaries are not available on PyPI. Change the URL for your specific platform:

pip install -f https://extras.wxpython.org/wxPython4/extras/linux/gtk2/ubuntu-16.04/ wxpython

Then install fsleyes-widgets like so:

pip install fsleyes-widgets

fsleyes-widgets is also available on conda-forge:

conda install -c conda-forge fsleyes-widgets

Dependencies

All of the dependencies of fsleyes-widgets are listed in the requirements.txt file.

Requirements for running tests and building the documentation are listed in the requirements-dev.txt file.

Documentation

API documentation for fsleyes-widgets can be found at https://open.win.ox.ac.uk/pages/fsl/fsleyes/widgets/.

fsleyes-widgets is documented using sphinx. You can build the API documentation by running:

pip install -r requirements-dev.txt
python setup.py doc

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

Tests

Run the test suite via:

pip install -r requirements-dev.txt
python setup.py test

Many of the tests assume that a display is accessible - if you are running on a headless machine, you may need to run the tests using xvfb-run.

Contributing

If you would like to contribute to fsleyes-widgets, take a look at the fslpy contributing guide.