Software for reading and writing NWB data

NWB provides two APIs for easily reading and writing NWB data: PyNWB for Python and MatNWB for MATLAB.

Each neurodata type defined in the NWB schema has a corresponding class in both PyNWB and MatNWB. Like neurodata types, these classes relate to each other through inheritance and composition. For example, the PyNWB class TimeSeries serves as the base class (superclass) for more specialized time series classes, such as, ElectricalSeries, and a LFP object can contain one or more ElectricalSeries objects, just like how the corresponding neurodata types are defined in the NWB schema.

Next steps

To learn more about:

how to install and use the APIs, see the PyNWB and MatNWB documentation
how to convert your data to NWB, see Converting neurophysiology data to NWB.
the broad range of core tools available for NWB see the Glossary of Core NWB Tools
community tools available for NWB see the Analysis and Visualization Tools section.
the NWB schema, please see the NWB Schema documentation.

Navigating the NWB Documentation

NWB defines a large software ecosystem and as such there are many different documentation resources available depending on what aspect of NWB and what type of information you want to learn more about. The following sketch provides an overview of the main areas of the NWB documentation. As we navigate from the top of the pyramid to the bottom, the level of detail and depth of the documentation increases. Most end-users will typically only interact with the top half of the pyramid. If you are new to NWB and want to learn more; good news you are at the right place!

../_images/nwb_documentation_overview.png

At the top (dark blue), we have the NWB.org website, which focuses on the NWB project at large and provides information about the overall organization, goals, community, and policies of the NWB project and provides a first entry point to NWB.

Next we have the NWB Overview (i.e., this website) (black), which serves as an entry point for researchers and developers interested in using NWB and in learning more about the NWB software ecosystem.

A growing collection of Analysis and Visualization Tools (gray) developed by the neurophysiology community along with a broad range of core tools (red) help users with conversion, extension, validation and use of NWB data files. Commonly, these tools build on the PyNWB (Python) and MatNWB (Matlab) reference APIs (lilac) to read and write NWB files. Each of the APIs and tools provides their own in-depth tutorials and documentation to help guide users in adopting and using the software.

Underlying all of this, is the NWB Format Specification, which formally defines and governs the NWB data standard.

Last but not least, NWB provides and builds on a broad range of data modeling tools and technologies (light blue), e.g., HDMF and the HDMF Common Schema, the Neurodata Extension Catalog, as well as the specification language and data storage specifications.