Skip to main content
https://git.fmrib.ox.ac.uk/fsl/fslpy/badges/master/build.svg https://zenodo.org/badge/DOI/10.5281/zenodo.1470750.svg https://git.fmrib.ox.ac.uk/fsl/fslpy/badges/master/coverage.svg https://img.shields.io/pypi/v/fslpy.svg https://anaconda.org/conda-forge/fslpy/badges/version.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

fslpy is also available on conda-forge:

conda install -c conda-forge 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.

If you are using Linux, 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

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]

Dependencies for testing and documentation are listed in the requirements-dev.txt file.

Documentation

fslpy 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

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

Contributing

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

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.13.1.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

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

fslpy-01.13.1-py2.py3-none-any.whl (179.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: fslpy-1.13.1.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

File hashes

Hashes for fslpy-1.13.1.tar.gz
Algorithm Hash digest
SHA256 cf6f0100e0ef04656729f2442e4952a2e7b5ac6c69258b403232f72c6de94290
MD5 59b9a5ad4a25cfd1ba6a06348d4d133e
BLAKE2b-256 7109b59d8dd1ed6c8f1c9478c170beb24eaa27e5a2d766e6816f2f03273642f3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fslpy-01.13.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 179.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

File hashes

Hashes for fslpy-01.13.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9720d3595e2b097c3f91f762a3ebe8adeb6729c538e0cadb52b742297632cea6
MD5 45aa348951bba85c91eeccd9767221b3
BLAKE2b-256 5e818bb977583fd9522437ae5731c512e0a328473904a596ac0022d1250756a2

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 Sentry Error logging StatusPage Status page