| Name | nilearn JSON |
| Version |
0.11.0
JSON |
| download |
| home_page | None |
| Summary | Statistical learning for neuroimaging in Python |
| upload_time | 2024-12-02 12:11:46 |
| maintainer | None |
| docs_url | None |
| author | Nilearn developers |
| requires_python | >=3.9 |
| license | new BSD |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
.. image:: https://img.shields.io/pypi/v/nilearn.svg
:target: https://pypi.org/project/nilearn/
:alt: Pypi Package
.. image:: https://img.shields.io/pypi/pyversions/nilearn.svg
:target: https://pypi.org/project/nilearn/
:alt: PyPI - Python Version
.. image:: https://github.com/nilearn/nilearn/workflows/build/badge.svg?branch=main&event=push
:target: https://github.com/nilearn/nilearn/actions
:alt: Github Actions Build Status
.. image:: https://codecov.io/gh/nilearn/nilearn/graph/badge.svg?token=KpYArSdyXv
:target: https://codecov.io/gh/nilearn/nilearn
:alt: Coverage Status
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8397156.svg
:target: https://doi.org/10.5281/zenodo.8397156
.. image:: http://img.shields.io/twitter/follow/nilearn.svg
:target: https://twitter.com/nilearn
:alt: Twitter
.. image:: https://img.shields.io/mastodon/follow/109669703955432270?domain=https%3A%2F%2Ffosstodon.org%2F
:target: https://fosstodon.org/@nilearn
:alt: Mastodon
.. image:: https://img.shields.io/discord/711993354929569843
:target: https://discord.gg/SsQABEJHkZ
:alt: Discord
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 <https://scikit-learn.org>`_ Python toolbox for multivariate statistics with applications such as predictive modelling, classification, decoding, or connectivity analysis.
Important links
===============
- Official source code repo: https://github.com/nilearn/nilearn/
- HTML documentation (stable release): https://nilearn.github.io/
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 <https://docs.conda.io/en/latest/miniconda.html>`_ for instance).
Either way, create and activate a new python environment.
With ``venv``:
.. code-block:: bash
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``:
.. code-block:: bash
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:
.. code-block:: bash
python -m pip install -U nilearn
Development version
-------------------
Please find all development setup instructions in the
`contribution guide <https://nilearn.github.io/stable/development.html#setting-up-your-environment>`_.
Check installation
------------------
Try importing nilearn in a python / iPython session:
.. code-block:: python
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 <https://meet.jit.si/nilearn-drop-in-hours>`_ 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 <https://nilearn.github.io/stable/development.html#how-to-get-help>`_.
Dependencies
============
The required dependencies to use the software are listed in the file `pyproject.toml <https://github.com/nilearn/nilearn/blob/main/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
Raw data
{
"_id": null,
"home_page": null,
"name": "nilearn",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Bertrand Thirion <bertrand.thirion@inria.fr>",
"keywords": null,
"author": "Nilearn developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a9/63/8fcb0656c88de7e20bd6543aa0a870dd02228d0795a80f14b4674833d656/nilearn-0.11.0.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/nilearn.svg\n :target: https://pypi.org/project/nilearn/\n :alt: Pypi Package\n\n.. image:: https://img.shields.io/pypi/pyversions/nilearn.svg\n :target: https://pypi.org/project/nilearn/\n :alt: PyPI - Python Version\n\n.. image:: https://github.com/nilearn/nilearn/workflows/build/badge.svg?branch=main&event=push\n :target: https://github.com/nilearn/nilearn/actions\n :alt: Github Actions Build Status\n\n.. image:: https://codecov.io/gh/nilearn/nilearn/graph/badge.svg?token=KpYArSdyXv\n :target: https://codecov.io/gh/nilearn/nilearn\n :alt: Coverage Status\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8397156.svg\n :target: https://doi.org/10.5281/zenodo.8397156\n\n.. image:: http://img.shields.io/twitter/follow/nilearn.svg\n :target: https://twitter.com/nilearn\n :alt: Twitter\n\n.. image:: https://img.shields.io/mastodon/follow/109669703955432270?domain=https%3A%2F%2Ffosstodon.org%2F\n :target: https://fosstodon.org/@nilearn\n :alt: Mastodon\n\n.. image:: https://img.shields.io/discord/711993354929569843\n :target: https://discord.gg/SsQABEJHkZ\n :alt: Discord\n\n\n\n\nnilearn\n=======\n\nNilearn enables approachable and versatile analyses of brain volumes. It provides statistical and machine-learning tools, with instructive documentation & friendly community.\n\nIt supports general linear model (GLM) based analysis and leverages the `scikit-learn <https://scikit-learn.org>`_ Python toolbox for multivariate statistics with applications such as predictive modelling, classification, decoding, or connectivity analysis.\n\nImportant links\n===============\n\n- Official source code repo: https://github.com/nilearn/nilearn/\n- HTML documentation (stable release): https://nilearn.github.io/\n\nInstall\n=======\n\nLatest release\n--------------\n\n**1. Setup a virtual environment**\n\nWe recommend that you install ``nilearn`` in a virtual Python environment,\neither managed with the standard library ``venv`` or with ``conda``\n(see `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ for instance).\nEither way, create and activate a new python environment.\n\nWith ``venv``:\n\n.. code-block:: bash\n\n python3 -m venv /<path_to_new_env>\n source /<path_to_new_env>/bin/activate\n\nWindows users should change the last line to ``\\<path_to_new_env>\\Scripts\\activate.bat`` in order to activate their virtual environment.\n\nWith ``conda``:\n\n.. code-block:: bash\n\n conda create -n nilearn python=3.9\n conda activate nilearn\n\n**2. Install nilearn with pip**\n\nExecute the following command in the command prompt / terminal\nin the proper python environment:\n\n.. code-block:: bash\n\n python -m pip install -U nilearn\n\nDevelopment version\n-------------------\n\nPlease find all development setup instructions in the\n`contribution guide <https://nilearn.github.io/stable/development.html#setting-up-your-environment>`_.\n\nCheck installation\n------------------\n\nTry importing nilearn in a python / iPython session:\n\n.. code-block:: python\n\n import nilearn\n\nIf no error is raised, you have installed nilearn correctly.\n\nDrop-in Hours\n=============\n\nThe Nilearn team organizes regular online drop-in hours to answer questions,\ndiscuss feature requests, or have any Nilearn-related discussions. Nilearn\ndrop-in hours occur *every Wednesday from 4pm to 5pm UTC*, and we make sure that at\nleast one member of the core-developer team is available. These events are held\non `Jitsi Meet <https://meet.jit.si/nilearn-drop-in-hours>`_ and are fully open,\nanyone is welcome to join!\nFor more information and ways to engage with the Nilearn team see\n`How to get help <https://nilearn.github.io/stable/development.html#how-to-get-help>`_.\n\nDependencies\n============\n\nThe required dependencies to use the software are listed in the file `pyproject.toml <https://github.com/nilearn/nilearn/blob/main/pyproject.toml>`_.\n\nIf you are using nilearn plotting functionalities or running the examples, matplotlib >= 3.3.0 is required.\n\nSome plotting functions in Nilearn support both matplotlib and plotly as plotting engines.\nIn 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.\n\nIf you want to run the tests, you need pytest >= 6.0.0 and pytest-cov for coverage reporting.\n\nDevelopment\n===========\n\nDetailed instructions on how to contribute are available at\nhttps://nilearn.github.io/stable/development.html\n",
"bugtrack_url": null,
"license": "new BSD",
"summary": "Statistical learning for neuroimaging in Python",
"version": "0.11.0",
"project_urls": {
"Changelog": "https://nilearn.github.io/stable/changes/whats_new.html",
"Development": "https://github.com/nilearn/nilearn",
"Discussions": "https://neurostars.org/tag/nilearn",
"Homepage": "https://nilearn.github.io"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "54fff5b57cb39dca01297267471978607326d1a50d9106f92378818ceb512dad",
"md5": "882af821a13fa9795a119028c7c2e55d",
"sha256": "3652ff5edb346542ef5c208a29214a8214ffd30f6a8ae45f185201426cb0af82"
},
"downloads": -1,
"filename": "nilearn-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "882af821a13fa9795a119028c7c2e55d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10458319,
"upload_time": "2024-12-02T12:11:28",
"upload_time_iso_8601": "2024-12-02T12:11:28.280581Z",
"url": "https://files.pythonhosted.org/packages/54/ff/f5b57cb39dca01297267471978607326d1a50d9106f92378818ceb512dad/nilearn-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a9638fcb0656c88de7e20bd6543aa0a870dd02228d0795a80f14b4674833d656",
"md5": "511514c8b2cd021ae8ac91f01c2fa999",
"sha256": "2a5b71434a6fdfda94a2d343de0c116cfffcc5d050a01789a6b968b533a8f787"
},
"downloads": -1,
"filename": "nilearn-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "511514c8b2cd021ae8ac91f01c2fa999",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12463577,
"upload_time": "2024-12-02T12:11:46",
"upload_time_iso_8601": "2024-12-02T12:11:46.984067Z",
"url": "https://files.pythonhosted.org/packages/a9/63/8fcb0656c88de7e20bd6543aa0a870dd02228d0795a80f14b4674833d656/nilearn-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 12:11:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nilearn",
"github_project": "nilearn",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"circle": true,
"tox": true,
"lcname": "nilearn"
}
