noahbenson / nilearn Goto Github PK

Nilearn enables approachable and versatile analyses of brain volumes. It provides statistical and machine-learning tools, with instructive documentation & friendly community.

It supports general linear model (GLM) based analysis and leverages the scikit-learn Python toolbox for multivariate statistics with applications such as predictive modelling, classification, decoding, or connectivity analysis.

• Official source code repo: https://github.com/nilearn/nilearn/
• HTML documentation (stable release): http://nilearn.github.io/

The nilearn team organizes regular online office hours to answer questions, discuss feature requests, or have any Nilearn-related discussions. Nilearn office hours occur every Friday from 4pm to 5pm UTC, and we make sure that at least one member of the core-developer team is available. These events are held on our on Discord server and are fully open, anyone is welcome to join!

The required dependencies to use the software are listed in the file nilearn/setup.cfg.

If you are using nilearn plotting functionalities or running the examples, matplotlib >= 3.0 is required.

Some plotting functions in Nilearn support both matplotlib and plotly as plotting engines. In order to use the plotly engine in these functions, you will need to install both plotly and kaleido, which can both be installed with pip and anaconda.

If you want to run the tests, you need pytest >= 3.9 and pytest-cov for coverage reporting.

First make sure you have installed all the dependencies listed above. Then you can install nilearn by running the following command in a command prompt:

pip install -U --user nilearn

More detailed instructions are available at http://nilearn.github.io/introduction.html#installation.

Detailed instructions on how to contribute are available at http://nilearn.github.io/development.html