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.5.0.tar.gz (620.3 kB view hashes)

Uploaded source

Built Distribution

mne_nirs-0.5.0-py3-none-any.whl (96.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page