MatNWB Logo

Get Started

  • Overview
    • Who is it for?
    • What you can do with MatNWB
    • How it works
    • Common questions you may encounter (and where to find answers)
    • Important caveats when working with MatNWB:
    • Related resources
    • Cite MatNWB
  • Installation
    • Quick install
    • Prerequisites
    • Choose an installation method
    • Verify your installation
    • Update or uninstall
    • Troubleshooting
    • Next steps
  • Quickstart: Read and write NWB files
    • Goal
    • Prerequisites
    • Introduction
    • Step 1 — Create a minimal NWB file
    • Step 2 — Add a TimeSeries
    • Step 3 — Write the File
    • Verify — Read the File Back
    • That’s it!
    • Next steps

Tutorials

  • General Tutorials
    • Getting Started with MatNWB
    • Reading NWB Files with MatNWB
    • Reading NWB Files with MatNWB on DandiHub
    • Basic Usage of MatNWB
    • Mapping Dimensions without DataPipes
    • Mapping Dimensions with DataPipes
    • Converting Trials to NWB Format
    • Using Dynamic Tables in MatNWB
    • Working with Scratch Space in MatNWB
  • Domain-Specific Tutorials
    • Behavior Data
    • Extracellular Electrophysiology 🎬
    • Intracellular Electrophysiology
    • Image Data
    • Optogenetics
    • Calcium Imaging 🎬
  • Advanced I/O
    • Advanced Writing Using DataPipes 🎬
    • Implementing Dynamically Loaded Filters
    • Reading NWB Files from Remote Locations

How-tos

  • Use Extensions
    • Generating Extension API
    • Installing Published Extensions
  • Optimize Storage
    • Use compression profiles

Concepts

  • Dimension Ordering in MatNWB
    • Data Dimensions
  • Reading NWB Files
    • Working with the NwbFile Object
    • The Dynamic Table Type
    • Utility Types in MatNWB
    • Schemas and Class Generation
    • Troubleshooting File Reads in MatNWB
  • Creating NWB Files
    • Understanding the NwbFile Object
    • Storage Backends
    • Performance Optimization
  • Neurodata Extensions
    • Generating Extension API
    • Installing Published Extensions

MatNWB Reference

  • MatNWB Functions
    • nwbRead
    • NwbFile
    • nwbExport
    • inspectNwbFile
    • generateCore
    • generateExtension
    • nwbClearGenerated
    • nwbInstallExtension
    • +io
    • +matnwb
  • Core Neurodata Types
    • AbstractFeatureSeries
    • AnnotationSeries
    • BehavioralEpochs
    • BehavioralEvents
    • BehavioralTimeSeries
    • ClusterWaveforms
    • Clustering
    • CompassDirection
    • CorrectedImageStack
    • CurrentClampSeries
    • CurrentClampStimulusSeries
    • DecompositionSeries
    • Device
    • DfOverF
    • ElectricalSeries
    • ElectrodeGroup
    • EventDetection
    • EventWaveform
    • ExperimentalConditionsTable
    • EyeTracking
    • FeatureExtraction
    • FilteredEphys
    • Fluorescence
    • GrayscaleImage
    • IZeroClampSeries
    • Image
    • ImageMaskSeries
    • ImageReferences
    • ImageSegmentation
    • ImageSeries
    • Images
    • ImagingPlane
    • ImagingRetinotopy
    • IndexSeries
    • IntervalSeries
    • IntracellularElectrode
    • IntracellularElectrodesTable
    • IntracellularRecordingsTable
    • IntracellularResponsesTable
    • IntracellularStimuliTable
    • LFP
    • LabMetaData
    • MotionCorrection
    • NWBContainer
    • NWBData
    • NWBDataInterface
    • NWBFile
    • OnePhotonSeries
    • OpticalChannel
    • OpticalSeries
    • OptogeneticSeries
    • OptogeneticStimulusSite
    • PatchClampSeries
    • PlaneSegmentation
    • Position
    • ProcessingModule
    • PupilTracking
    • RGBAImage
    • RGBImage
    • RepetitionsTable
    • RoiResponseSeries
    • ScratchData
    • SequentialRecordingsTable
    • SimultaneousRecordingsTable
    • SpatialSeries
    • SpikeEventSeries
    • Subject
    • SweepTable
    • TimeIntervals
    • TimeSeries
    • TimeSeriesReferenceVectorData
    • TwoPhotonSeries
    • Units
    • VoltageClampSeries
    • VoltageClampStimulusSeries
  • HDMF-Common Data Types
    • AlignedDynamicTable
    • CSRMatrix
    • Container
    • Data
    • DynamicTable
    • DynamicTableRegion
    • ElementIdentifiers
    • SimpleMultiContainer
    • VectorData
    • VectorIndex
  • HDMF-Experimental Data Types
    • EnumData
    • HERD

For Developers

  • Contribution Guidelines
  • Documentation
    • Writing a Properly Documented MATLAB Docstring
  • How to Create a New Release
MatNWB
  • Use Extensions
  • MatNWB on GitHub

Use Extensions

  • Generating Extension API
  • Installing Published Extensions

Optimize Storage

  • Use compression profiles
Previous Next

© Copyright 2025, Neurodata Without Borders.

Built with Sphinx using a theme provided by Read the Docs.