Skip to content

Commit 7e8da87

Browse files
authored
feat: include NWB file naming conventions (#30)
* feat: include NWB file naming conventions * chore: follow naming structure in the lightsheet realm * chore: fix session name * chore: fix session name
1 parent 18a1832 commit 7e8da87

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/source/philosophy/data_organization.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,12 @@ When naming files, we should:
171171
- Do this: EFIP_655568_2022-04-26_11-48-09
172172
- Do not include illegal filename characters in tokens
173173

174+
## NWB file naming conventions
175+
176+
NWB files are saved out as `Zarr` files according to the standard defined in [aind-file-standards](https://github.com/AllenNeuralDynamics/aind-file-standards/blob/main/docs/file_formats/nwb.md). NWB files are saved as a processed output for each modality acquired during the acquisition session. Within the derived asset, NWB files should be named `<modality>.nwb.zarr` at the root level of the derived asset along with the core aind-data-schema metadata files.
177+
178+
When NWB files are combined together, post QC validation, they will be saved as a new derived data asset with merged, core aind-data-schema metadata files. The NWB file will will be saved at the root directory of the derived asset along with the metadata and will be named `<primary-session-name>.nwb.zarr`.
179+
174180
## AIND Implementation
175181

176182
### On-premise systems should not be used for persistent, long-term data storage.

0 commit comments

Comments
 (0)