Skip to main content

A collection of wxPython widgets used by FSLeyes

Project description

https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets/badges/master/build.svg https://git.fmrib.ox.ac.uk/fsl/fsleyes/widgets/badges/master/coverage.svg https://img.shields.io/pypi/v/fsleyes-widgets.svg https://anaconda.org/conda-forge/fsleyes-widgets/badges/version.svg

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
fsleyes_widgets-0.7.2-py2.py3-none-any.whl (102.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
fsleyes-widgets-0.7.2.tar.gz (1.1 MB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page