MNE-NIRS: Near-Infrared Spectroscopy Analysis
MNE-NIRS is an MNE-Python compatible near-infrared spectroscopy processing package.
MNE-Python provides support for fNIRS analysis, this package extends that functionality and adds GLM analysis, helper functions, additional algorithms, data quality metrics, plotting, and file format support.
Documentation
Documentation for this project is hosted here.
You can find a list of examples within the documentation.
Features
MNE-NIRS and MNE-Python provide a wide variety of tools to use when processing fNIRS data including:
Loading data from a wide variety of devices, including SNIRF files.
Apply 3D sensor locations from common digitisation systems such as Polhemus.
Standard preprocessing including optical density calculation and Beer-Lambert Law conversion, filtering, etc.
Data quality metrics including scalp coupling index and peak power.
GLM analysis with a wide variety of customisation including including FIR or canonical HRF analysis, higher order autoregressive noise models, short channel regression, region of interest analysis, etc.
Visualisation tools for all stages of processing from raw data to processed waveforms, GLM result visualisation, including both sensor and cortical surface projections.
Data cleaning functions including popular short channel techniques and negative correlation enhancement.
Group level analysis using (robust) linear mixed effects models and waveform averaging.
And much more! Check out the documentation examples and the API for more details.
Contributing
Contributions are welcome (more than welcome!). Contributions can be feature requests, improved documentation, bug reports, code improvements, new code, etc. Anything will be appreciated. Note: this package adheres to the same contribution standards as MNE.
Acknowledgements
This package is built on top of many other great packages. If you use MNE-NIRS you should also acknowledge these packages.
MNE-Python: https://mne.tools/dev/overview/cite.html
Nilearn: http://nilearn.github.io/authors.html#citing
statsmodels: https://www.statsmodels.org/stable/index.html#citation
Until there is a journal article specifically on MNE-NIRS, please cite this article.
Docker
To start a jupyter lab server with a specified MNE-NIRS version, and mount a local directory on a mac or nix computer use:
docker run -p 8888:8888 -v `pwd`:/home/mne_user ghcr.io/mne-tools/mne-nirs:v0.1.2 jupyter-lab --ip="*"Or on windows:
docker run -p 8888:8888 -v %cd%:/home/mne_user ghcr.io/mne-tools/mne-nirs:v0.1.2 jupyter-lab --ip="*"1 maintainer
Metadata
1 maintainer
Release files for mne-nirs 0.7.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mne_nirs-0.7.3.tar.gz | 100.0 kB | With provenance | Details for mne_nirs-0.7.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mne_nirs-0.7.3-py3-none-any.whl | Python 3 | none | any | Details for mne_nirs-0.7.3-py3-none-any.whl |
Total release size: 233.3 kB
Release files / mne_nirs-0.7.3.tar.gz
| Download URL | mne_nirs-0.7.3.tar.gz |
|---|---|
| Size | 100.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3a757d9669015616aeebab32fe2d01aa4e59dfb74deecb5f65899aeae911fc72
|
|
BLAKE2b-256 checksum How to use checksums |
4bb769854488af691d65583951d7e3771e32d04fc7518f74739e8294a36f8a8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2025.
Transparency logRelease files / mne_nirs-0.7.3-py3-none-any.whl
| Download URL | mne_nirs-0.7.3-py3-none-any.whl |
|---|---|
| Size | 133.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6655c958ba6160bd616bf985f308b39bd70af56b2e22d1a121227534da240aed
|
|
BLAKE2b-256 checksum How to use checksums |
6666fbd28f919c437711df399eefd8bd6496fd6ba4f7996757bbab6238fda338
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2025.
Transparency logSecurity for mne-nirs 0.7.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for mne_nirs-0.7.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
