The fslpy project is a FSL programming library written in Python. It is used by FSLeyes.
fslpy is tested against Python versions 3.10, 3.11, 3.12, and 3.13.
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 pyproject.toml file.
Some optional dependencies (labelled extra in pyproject.toml) 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.
Pillow: The fsl.data.bitmap.Bitmap class uses Pillow to load image files.
If you are using Linux, you need to install wxPython first, as binaries are not available on PyPI. Install wxPython like so, changing the URL for your specific platform:
pip install -f https://extras.wxpython.org/wxPython4/extras/linux/gtk2/ubuntu-16.04/ wxpython
Once wxPython has been installed, you can type the following to install the remaining optional dependencies:
pip install "fslpy[extra]"
Dependencies for testing and documentation are also listed in pyproject.toml, and are respectively labelled as test and doc.
Non-Python dependencies
The fsl.data.dicom module requires the presence of Chris Rorden’s dcm2niix program.
The rtree library assumes that libspatialindex is installed on your system.
The fsl.transform.x5 module uses h5py, which requires libhdf5.
Documentation
API documentation for fslpy is hosted at https://open.win.ox.ac.uk/pages/fsl/fslpy/.
fslpy is documented using sphinx. You can build the API documentation by running:
pip install ".[doc]" sphinx-build doc html
The HTML documentation will be generated and saved in the html/ directory.
Tests
Run the test suite via:
pip install ".[test]" pytest
Some tests will only pass if the test environment meets certain criteria - refer to the tool.pytest.init_options section of [pyproject.toml](pyproject.toml) for a list of [pytest marks](https://docs.pytest.org/en/7.1.x/example/markers.html) which can be selectively enabled or disabled.
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.
1 maintainer
Release files for fslpy 3.29.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fslpy-3.29.1.tar.gz | 4.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fslpy-3.29.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.6 MB
Release files / fslpy-3.29.1.tar.gz
| Download URL | fslpy-3.29.1.tar.gz |
|---|---|
| Size | 4.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d406171c8928a5e6db6d21e6effb90fc4a0c28e904a084095e37c97fd755431
|
|
BLAKE2b-256 checksum How to use checksums |
bd15fb744e5d5b74807fc9e0fd86495cb8cb0c84385324b71697bf9091a5cdcc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / fslpy-3.29.1-py3-none-any.whl
| Download URL | fslpy-3.29.1-py3-none-any.whl |
|---|---|
| Size | 4.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
046c1c0dd5e9f936828d7cc1826fb3442f3a5b256212035413d6c100d7e934f6
|
|
BLAKE2b-256 checksum How to use checksums |
2a9b78cd85cfb5c43b190ebe315da2ae5dac384ed90773ded350e96bbfe536a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
