Output Folder Format

Attention

This output format is not set in stone. Please get in contact with any preferences on how you would like to see this organised.

Here are two example output folders, depending on whether sessions runs were concatenated and processing was performed per-shank.

Below are shown in NeuroBlueprint style, with outputs placed in the root folder as rawdata, in a folder called derivatives.

However, the output folder can be overridden by passing the output_path argument to spikewrap.Session.

Runs concatenated, split by shank

`
└── derivatives/
    └── sub-001/
        └── ses-001  /
            └── ephys/
                └── concat_run/
                    ├── preprocessed/
                    │   ├── shank_0/
                    │   │   └── si_recording/
                    │   │       └── <spikeinterface binary>
                    │   └── shank_1/
                    │       └── si_recording/
                    │           └── <spikeinterface binary> 
                    └── sync/
                    │   └── sync_channel.npy
                    └── orig_run_names.txt

Here, the concatenated runs are stored in a folder with the canonical name concat_run. The names of the original runs and their concatenation order are stored in orig_runb_names.txt.

No run concatenation, not split by shank

   └── derivatives/
       └── sub-001/
           └── ses-001/
               └── ephys/
                   ├── run-001_g0_imec0/
                   │   ├── preprocessed/
                   │   │   └── si_recording/
                   │   │       └── <spikeinterface binary>
                   │   └── sync/
                   │       └── sync_channel.npy
                   └── run-002_g0_imec0/
                       └── ...