ConvertTEMPLATE

Template structure for converting data to NWB format.

TEMPLATE DESCRIPTION

This repository provides a template for managing and converting data files into the neurodata without borders format.

This template follows the general purpose ProjectTemplate layout from StructuredScience.

For information on how to use this template in a project, see the HSUPipeline Guide.

Note: if copying this template for use, this section can be removed.

Overview

Provide an overview of the analysis project here, for example:

This repository is for managing and converting data files for the XX task, processing and converting the data into the neurodata without borders format.

This conversion follows the ConvertTEMPLATE.

Requirements

Fill in any extra requirements here.

This repository requires Python >= 3.7.

As well as typical scientific Python packages, dependencies include:

• pynwb
• convnwb

The full list of dependencies is listed in requirements.txt.

Repository Layout

This repository is set up in the following way:

• conv/ inherits from convnwb and contains any extra custom code for converting data
• notebooks/ contains notebooks that demonstrate examples of data conversion
• metadata/ contains config files that define metadata fields and task descriptions
• scripts/ contains stand alone scripts to process data files

Run Procedures

Data files can be processed by running the scripts available in the scripts folder.

The procedures are also detailed through the notebooks.

For a detailed description of how this approach works, and instructions on making updates, see the ConvertTEMPLATE.