Quickstart

fmralign

Functional alignment for fMRI (functional Magnetic Resonance Imaging) data.

This light-weight Python library provides access to a range of functional alignment methods, including Procrustes and Optimal Transport. It is compatible with and inspired by Nilearn. Alternative implementations of these ideas can be found in the pymvpa, brainiak or neuroboros packages.

Getting Started

Installation

You can access the latest stable version of fmralign directly with the PyPi package installer:

pip install fmralign

Optimal Transport methods can be installed with the optional dependency [ot], which installs both supported backends (geomloss and POT):

pip install fmralign[ot]

If you only need one backend, you can install it individually:

pip install fmralign[ot_geomloss]  # geomloss backend only
pip install fmralign[ot_pot]       # POT backend only

For development or bleeding-edge features, fmralign can also be installed directly from source:

git clone https://github.com/fmralign/fmralign
cd fmralign
pip install -e .

Documentation

You can find an introduction to functional alignment, a user guide and some examples on how to use the package on the documentation website.

License

This project is licensed under the Simplified BSD License.

Acknowledgments

This project has received funding from the European Union’s Horizon 2020 Research and Innovation Programme under Grant Agreement No. 785907 (HBP SGA2). This project was supported by Digiteo.