Skip to main content
https://git.fmrib.ox.ac.uk/fsl/fslpy/badges/master/build.svg https://git.fmrib.ox.ac.uk/fsl/fslpy/badges/master/coverage.svg https://img.shields.io/pypi/v/fslpy.svg

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

Installation

Install fslpy and its core dependencies via pip:

pip install fslpy

Dependencies

All of the core dependencies of fslpy are listed in the requirements.txt file.

Some extra dependencies are listed in requirements.txt which provide addditional functionality:

  • wxPython: The fsl.utils.idle module has functionality to schedule functions on the wx idle loop.

  • indexed_gzip: The fsl.data.image.Image class can use indexed_gzip to keep large compressed images on disk instead of decompressing and loading them into memory..

  • trimesh/rtree: The fsl.data.mesh.TriangleMesh class has some methods which use trimesh to perform geometric queries on the mesh.

To install these additional dependencies, you first need to install wxPython, which is still in pre-relaes.

  • macOS: pip install --pre wxPython

  • Linux (change the URL for your specific platform): pip install --only-binary wxpython -f https://extras.wxpython.org/wxPython4/extras/linux/gtk2/ubuntu-16.04/ wxpython

The rtree library also assumes that libspatialindex is installed on your system.

Once wxPython has been installed, you can simply type the following to install the rest of the extra dependencies:

pip install fslpy[extras]

Documentation

fslpy is documented using sphinx. 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.

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/.

Credits

The fsl.data.dicom module is little more than a thin wrapper around Chris Rorden’s dcm2niix program.

The example.mgz file, used for testing, originates from the nibabel test data set.

Download files

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

Source Distribution

fslpy-1.6.0.tar.gz (3.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fslpy-1.6.0-py2.py3-none-any.whl (142.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file fslpy-1.6.0.tar.gz.

File metadata

  • Download URL: fslpy-1.6.0.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fslpy-1.6.0.tar.gz
Algorithm Hash digest
SHA256 2b6fb866a8b647beeb4fe703bce69820d9b239a469ef680c71b893e04d130cda
MD5 d18c61ad6ebe714e6748f263dc04122d
BLAKE2b-256 c3f1081ecf8e669c542c0c17ec9ef5cdc1785c73ee8261e7c0ce5572870e9f6f

See more details on using hashes here.

File details

Details for the file fslpy-1.6.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fslpy-1.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d55b91985646ab607df02a725f4d05192a926c8d85537beab027fa354f6b7200
MD5 a95be8542fc6351e2f8db31f7a0fd012
BLAKE2b-256 7e6a452d0f4d79c596aac40dcb3b2621fcbafc210125d31d837733063a0dbcfc

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page