Skip to content

USArhythms/ingestion_scripts

Repository files navigation

Neurodata Without Borders (NWB) back-end conversion scripts

Scripts are useful in converting data from prorpritary formats into NWB format. Scripts are expected to be used as back-end to U19 data sharing portals: usarhythms.ucsd.edu, highandlow.dk.ucsd.edu

Currently supported experimental data is:

  1. Extracellular electrophysiology (Intan -> NWB data conversion)
  2. Widefield Imaging (Matlab & python)
  3. 2-Photon Imaging (terminal)
  4. Behavioral (Matlab or python)
  5. fMRI (terminal)

Steps for running python code (manual - terminal) -> send to data portal:

1. Activate python virtual environment with required modules (nwb on my computer) *see requirements.txt for installed modules
2. Download and complete Excel sheet that most closely correponds to experiment
3. Run with 'python share.py' and add terminal arguments as needed

Steps for running python (manual - terminal) -> just conversion:

1. Activate python virtual environment with required modules (nwb on my computer) *see requirements.txt for installed modules
2. Download and complete Excel sheet that most closely correponds to experiment
3. Run with 'python prep.py' and add terminal arguments as needed

Steps for running python (manual - Jupyter Notebook):

1. Activate python virtual environment with required modules (nwb on my computer) *see requirements.txt for installed modules
2. Open jupyter notebook corresponding to experiment type
3. Edit constants (file paths at top file) and run

Note: You will need input.xlsx for electrophysiology experiments (sample coming) for inclusion of raw data

Steps for Matlab (Widefield & Behavioral) -> just conversion:

1. Install MatNWB as Matlab Add-On (Add-Ons button on top ribbon, search for 'nwb'; and click 'Add' button)
2. Install Image Processing toolbox Add-On (Add-Ons button on top ribbon, search for 'Image Processing Toolbox'; and click 'Add' button)

Features


  • Conversion for Intan format to NWB format (ePhys)
  • Ability to add tif image stacks to NWB files (Widefield, Behavioral)
  • Integration with back-end relational database (in progress), NoSQL database (in progress)
  • Ability to aggregate NWB containers (for uploading to NIH-approved respositories)

Python Installation


  1. create virtual environment in home directory (e.g. 'C:/Users/Duane/') python -m venv nwb
  2. Activate virtual environment C:/Users/Duane/nwb/Scripts/activate.ps1
  3. Install required modules pip install -r requirements.txt

Contribute


[Issue Tracker] (https://github.com/ActiveBrainAtlas2/nwb/issues)

[Source Code] (https://github.com/ActiveBrainAtlas2/nwb)

Support


If you are having issues, please let me know. Duane Rinehart drinehart[at]ucsd.edu

License


The project is licensed under the MIT license.


Last update: 9-JUL-2024

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •