README.md

Snirf Validator 🔬

Table of Contents

• Background
• Installation
• Usage
  • Flowchart
  • Demo
• API
• Maintainers
• Contributors
• License

Background 💡

Installation 💾

Usage 📋

The Snirf.py mainly performs two functions: read a snirf file and save the result. The saved file can pass: SNIRF validator, HDFviewer, and Homer3. The idea of how snirf.py works and a demo of how to use can be found below.

Flowchart

Demo

To run this app you must have python installed. To run this app you must indicate where the dataset is loacted. This is done by passing the location of the dataset to oneSnirfClass and using build-in function SnirfLoad. A minimal exmaple of how to run snirf.py is:

import Snirf

oneSnirfClass=Snirf.SnirfLoad('/Users/Jiazhenliu/Downloads/resting_state_2/Subj86/resting_hrf_20.snirf')

To save the result, you must use buid-in funciton SnirfSave. A minimal example of how to save the result is:

Snirf.SnirfSave(oneSnirfClass,'/Users/Jiazhenliu/Desktop/testingresult.snirf')

API

Maintainers 🛠️

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

Contributors

This project exsists thanks to all people who contribute.

License