Skip to main content

Statistical learning for neuroimaging in Python

Project description

Pypi Package PyPI - Python Version Github Actions Doc Build Status Github Actions Test Status Coverage Status https://zenodo.org/badge/DOI/10.5281/zenodo.8397156.svg Bluesky YouTube Channel Subscribers Mastodon Discord

nilearn

Nilearn enables approachable and versatile analyses of brain volumes and surfaces. 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 modeling, classification, decoding, or connectivity analysis.

Install

Latest release

1. Setup a virtual environment

We recommend that you install nilearn in a virtual Python environment, either managed with the standard library venv or with conda (see miniconda for instance). Either way, create and activate a new python environment.

With venv:

python3 -m venv /<path_to_new_env>
source /<path_to_new_env>/bin/activate

Windows users should change the last line to \<path_to_new_env>\Scripts\activate.bat in order to activate their virtual environment.

With conda:

conda create -n nilearn python=3.9
conda activate nilearn

2. Install nilearn with pip

Execute the following command in the command prompt / terminal in the proper python environment:

python -m pip install -U nilearn

Development version

Please find all development setup instructions in the contribution guide.

Check installation

Try importing nilearn in a python / iPython session:

import nilearn

If no error is raised, you have installed nilearn correctly.

Drop-in Hours

The Nilearn team organizes regular online drop-in hours to answer questions, discuss feature requests, or have any Nilearn-related discussions. Nilearn drop-in hours occur every Wednesday 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 Jitsi Meet and are fully open, anyone is welcome to join! For more information and ways to engage with the Nilearn team see How to get help.

Dependencies

The required dependencies to use the software are listed in the file pyproject.toml.

If you are using nilearn plotting functionalities or running the examples, matplotlib >= 3.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 >= 6.0.0 and pytest-cov for coverage reporting.

Development

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

Project details


Download files

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

Source Distribution

nilearn-0.12.0.tar.gz (26.0 MB view details)

Uploaded Source

Built Distribution

nilearn-0.12.0-py3-none-any.whl (10.6 MB view details)

Uploaded Python 3

File details

Details for the file nilearn-0.12.0.tar.gz.

File metadata

  • Download URL: nilearn-0.12.0.tar.gz
  • Upload date:
  • Size: 26.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nilearn-0.12.0.tar.gz
Algorithm Hash digest
SHA256 8fe53f117c87872bef6b93de7a383a1c70f182dbd186459a6594e6c9d70574a6
MD5 c500cf10c8414f6483558917af8d279a
BLAKE2b-256 7cbf71980e4d21fd985653526acbf179a98fb007118cb93b8bc9fb182861f691

See more details on using hashes here.

File details

Details for the file nilearn-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: nilearn-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 10.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nilearn-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2818ffa26dd7325c60f0569d521c7d87defe5847b6ded83031e6c687f283bf41
MD5 06b7dfb23984f6cd7280910b32829710
BLAKE2b-256 a7977db1c7ed4b8fbe25e1e74135f7b6ee0b4563e1f53a55297d56a4c5286ded

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page