README.md

snirf2BIDS

Conveniently generate BIDS files from SNIRF files.

Installation

pip install snirf2bids

snirf2bids requires Python > 3.

Usage

SNIRF files with valid BIDS names can be converted into BIDS metadata text files.

For use with snirf2bids, a SNIRF file name must include at least the sub- and task- entitites and end in _nirs.snirf, i.e. sub-01_task-tapping_nirs.snirf.

Create BIDS text files from a SNIRF file

snirf2bids.snirf2bids('<path to snirf file>', '<folder to generate files in>')

Export BIDS text files in JSON Format

s = snirf2bids.snirf2json('<path to snirf file>')  # Returns serialized JSON in which keys are filenames and values are their contents

Contributors

Developed by BU BME Senior Design Group 3 (2022): Christian Arthur, Jeonghoon Choi, Jiazhen Liu, Juncheng Zhang and the Boston University Neurophotonics Center.

@Christian Arthur 🍈
@Juncheng Zhang 🍊
@Jeonghoon Choi 🍍
@Jiazhen Liu 🍇

This project exists thanks to: