Skip to content

hemolearn/hemolearn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Travis_ Codecov_

image

HemoLearn

HemoLearn is a Python module to estimate the Haemodynamic Response Function (HRF) in brain from resting-state or task fMRI data (BOLD signal). It relies on a Blind Deconvolution Analysis (BDA) to distangles the neurovascular coupling from the the neural activity.

This package was used to produce the results of the Cherkaoui et a.l., (submitted to) NeuroImage 2021, paper

Important links

Dependencies

The required dependencies to use the software are:

  • Numba >= 0.51.2
  • Joblib >= 0.11
  • Numpy >= 1.14.0
  • Scipy >= 1.0.0
  • Matplotlib >= 2.1.2
  • Nilearn >= 0.5.2
  • Sklearn >= 0.22.1
  • Threadpoolctl >= 1.0.0
  • Prox_tv

License

All material is Free Software: BSD license (3 clause).

Installation

In order to perform the installation, run the following command from the hemolearn directory:

python3 setup.py install --user

To run all the tests, run the following command from the hemolearn directory:

python3 -m pytest

Documentation

In order to build the documentation, run the following command from the doc/ directory:

make html

Development

Code

GIT

You can check the latest sources with the command:

git clone https://github.com/hemolearn/hemolearn.git