Skip to main content

An MNE compatible package for processing near-infrared spectroscopy data

Project description

https://img.shields.io/badge/docs-master-brightgreen https://github.com/mne-tools/mne-nirs/workflows/linux%20/%20pip/badge.svg https://github.com/mne-tools/mne-nirs/workflows/macos%20/%20conda/badge.svg https://github.com/mne-tools/mne-nirs/workflows/linux%20/%20conda/badge.svg https://codecov.io/gh/mne-tools/mne-nirs/branch/main/graph/badge.svg https://badge.fury.io/py/mne-nirs.svg

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:

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="*"

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

mne_nirs-0.7.1.tar.gz (99.4 kB view details)

Uploaded Source

Built Distribution

mne_nirs-0.7.1-py3-none-any.whl (131.3 kB view details)

Uploaded Python 3

File details

Details for the file mne_nirs-0.7.1.tar.gz.

File metadata

  • Download URL: mne_nirs-0.7.1.tar.gz
  • Upload date:
  • Size: 99.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for mne_nirs-0.7.1.tar.gz
Algorithm Hash digest
SHA256 c2cd6b0ee0057a2f26695d91d97e4b65e9fc7aaada90e1b2af0bbc5af255663e
MD5 eb601a7ab1330f2bc8069b5ad8810d11
BLAKE2b-256 cc6dcb984fccf419a53f35751825a9844f821ba46177be8f85f5e90eaf7dd720

See more details on using hashes here.

Provenance

File details

Details for the file mne_nirs-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: mne_nirs-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 131.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for mne_nirs-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7e6cddb97c43193d57c4653ae032f668175ca636a3ced74d720e671d025f988f
MD5 7a46bc790e1012442e7a0bb5bab6539f
BLAKE2b-256 1764219f8655297d641ede8af9dc0850d0a0cd458f9c52cc18ccb74ffff3d737

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