User Guide: Inspecting an NWBFile

Neurodata Without Borders (NWB) provides a common self-describing format ideal for archiving neurophysiology data and sharing it with colleagues.

A very important aspect of efficient data sharing and reuse is not only to harness the standardized NWB data types, but also to follow Best Practices when constructing metadata, organizing object locations within a file, and using advanced I/O features such as compression.

This guide will make every attempt to walk you through the tools available to aid you in adjusting your data conversion code in PyNWB or MatNWB to adhere more strictly to the officially encouraged Best Practices.

• Installation
• Using the Command Line Interface (CLI)
  • Using the DANDI Configuration
  • Streaming
  • Formatting the Report
  • Saving the Report
  • Faster Inspection
  • Skipping Specific Checks
  • Selecting Specific Checks
  • External Modules
• Using the Library
  • InspectorMesssage objects
  • Inspect a single NWBFile
  • Inspect a Directory or List of Paths to NWBFiles
  • Using the DANDI Configuration
  • Inspect a Dandiset
  • Examining the Default Check Registry
• Using the Library: Advanced
  • Yielding and Iterating
  • Fetching and inspecting individual DANDI assets
  • Format Reports