Skip to main content

Functional alignment of fMRI data in Python

Project description

# fmralign [Functional alignment and template estimation library](https://parietal-inria.github.io/fmralign-docs) for functional Magnetic Resonance Imaging (fMRI) data

This library is meant to be a light-weight Python library that handles functional alignment tasks. It is compatible with and inspired from [Nilearn](http://nilearn.github.io).

Alternative implementations of these ideas can be found in the [pymvpa](http://www.pymvpa.org) or [brainiak](http://brainiak.org) packages.

## Getting Started

### Prerequisites

fmralign requires a Python installation and the following dependencies: * Python >= 3.6 * Numpy >= 1.16.2 * SciPy >= 1.2.2 * Scikit-learn >= 0.20 * Matplotlib >= 3.1.1 * Nibabel >= 2.5.0 * Nilearn >= 1.5.0

### Installation

Open a terminal window, go the location where you want to install it. Then run:

` pip install fmralign `

Or if you want the latest version available (for example to develop):

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

Optionally, if you want to use optimal transport based method, you should also run:

` pip install POT `

You’re up and running!

### Documentation

You can found an introduction to functional alignment, a user guide and some examples on how to use the package at https://parietal-inria.github.io/fmralign-docs.

## 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](http://www.digiteo.fr).

Download files

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

Files for fmralign, version 0.0.2a0
Filename, size File type Python version Upload date Hashes
Filename, size fmralign-0.0.2a0-py3-none-any.whl (34.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size fmralign-0.0.2a0.tar.gz (26.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page