Skip to main content

Statistical learning for neuroimaging in Python

Project description

Pypi Package PyPI - Python Version Github Actions Build Status Coverage Status Azure Build Status

nilearn

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.

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 our on Discord server 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 nilearn/setup.cfg.

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 http://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.10.1rc1.tar.gz (13.1 MB view details)

Uploaded Source

Built Distribution

nilearn-0.10.1rc1-py3-none-any.whl (9.7 MB view details)

Uploaded Python 3

File details

Details for the file nilearn-0.10.1rc1.tar.gz.

File metadata

  • Download URL: nilearn-0.10.1rc1.tar.gz
  • Upload date:
  • Size: 13.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nilearn-0.10.1rc1.tar.gz
Algorithm Hash digest
SHA256 72cbe504d2758ba2e16983c5d9ab47aa6dc1a9d66fd26be69a9e36804ca2e58d
MD5 bc116949a39d78472dfd952e2f71b814
BLAKE2b-256 99771e884e81e432c43106c422abbc63cece8a67490c71feebf70b84685e3f54

See more details on using hashes here.

Provenance

File details

Details for the file nilearn-0.10.1rc1-py3-none-any.whl.

File metadata

  • Download URL: nilearn-0.10.1rc1-py3-none-any.whl
  • Upload date:
  • Size: 9.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for nilearn-0.10.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 5c7815dd2368c1c74f442cf275ef8ae6d6ece722af91bf640ea6750c016154e0
MD5 bf83f218aecca2f3e0a068dd7ce2cecb
BLAKE2b-256 2b546267ba5ce26cdaeb1dd52291a60f0e992b5e41bdf3deb0e4498f59169fb0

See more details on using hashes here.

Provenance

Supported by

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