Skip to content

pulkitgoyal56/fnirsPy

Repository files navigation

fnirsPy

This library is currently in pre-alpha.

fnirsPy is an open-source wrapper built on MNE-Python (Gramfort et al., 2014) and MNE-NIRS (Luke et al., 2021) that makes it easy to deploy complete yet customizable end-to-end data processing pipelines for custom near-infrared spectroscopy (NIRS) data with only a few lines of code. It is an imperative-style high-level API designed to be Pythonic, which focuses on minimum redundancy in code, so it augments and does not replace MNE, the functions of which users can still utilize harmoniously. It aims to implement a standardized procedure for handling fNIRS data to foster reproducibility in analysis and includes a default pipeline based on growing recommendations for standardized fNIRS data preprocessing steps in literature so that users can focus on the scientific question without much toil over writing code. The package also implements new methods that are not available in the underlying MNE software suite. Furthermore, a few additional plotting functions are included with fNIRS publication conventions in mind along with some handy utilities that provide frequently used functions.

The library is currently in pre-alpha and few of its functions are specifically developed for the in-development OptoHive fNIRS device by RELab (ETH Zürich) (Wyser et al., 2017), which will be changed later.

In the next stages of development, complete support for the BIDS standard for neuroimaging data will be added among other features.

Setup (for Debian-Based Linux)

Update System Packages

sudo apt update
sudo apt -y upgrade

Install Node

sudo apt install -y nodejs

Install Graphics Dependencies

These are probably more than necessary

sudo apt install -y ffmpeg libsm6 libxext6 python-qt4 libgl1-mesa-glx xvfb

Install Miniconda

wget https://repo.anaconda.com/miniconda/Miniconda3-py310_22.11.1-1-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh

Create Conda Environment

conda env create -f environment.yml

Run Jupyter Lab

jupyter lab --ip 0.0.0.0 --no-browser