The NWB Specification Language

The NWB specification language defines formal structures for describing the organization of complex data using basic concepts, e.g., Groups, Datasets, Attributes, and Links.

See the full language description, release notes, and credits below.

Table of Contents

• 1. NWB Specification Language
  • 1.1. Introduction
  • 1.2. Extensions
  • 1.3. Namespaces
    • 1.3.1. Namespace declaration keys
      • 1.3.1.1. doc
      • 1.3.1.2. name
      • 1.3.1.3. full_name
      • 1.3.1.4. version
      • 1.3.1.5. date
      • 1.3.1.6. author
      • 1.3.1.7. contact
      • 1.3.1.8. schema
  • 1.4. Schema specification
  • 1.5. Groups
    • 1.5.1. Group specification keys
      • 1.5.1.1. neurodata_type_def and neurodata_type_inc
      • 1.5.1.2. name
      • 1.5.1.3. default_name
      • 1.5.1.4. doc
      • 1.5.1.5. quantity
      • 1.5.1.6. linkable
      • 1.5.1.7. attributes
      • 1.5.1.8. datasets
      • 1.5.1.9. groups
      • 1.5.1.10. links
      • 1.5.1.11. \_required
  • 1.6. Attributes
    • 1.6.1. Attribute specification keys
      • 1.6.1.1. name
      • 1.6.1.2. dtype
        • 1.6.1.2.1. Reference dtype
        • 1.6.1.2.2. Compound dtype
      • 1.6.1.3. dims
      • 1.6.1.4. shape
      • 1.6.1.5. value
      • 1.6.1.6. default_value
      • 1.6.1.7. doc
      • 1.6.1.8. required
  • 1.7. Links
    • 1.7.1. Link specification keys
      • 1.7.1.1. name
      • 1.7.1.2. target_type
      • 1.7.1.3. doc
      • 1.7.1.4. quantity
  • 1.8. Datasets
    • 1.8.1. Dataset specification keys
      • 1.8.1.1. neurodata_type_inc and neurodata_type_def
      • 1.8.1.2. name
      • 1.8.1.3. default_name
      • 1.8.1.4. dtype
      • 1.8.1.5. shape
      • 1.8.1.6. dims
      • 1.8.1.7. value and default_value
      • 1.8.1.8. doc
      • 1.8.1.9. quantity
      • 1.8.1.10. linkable
      • 1.8.1.11. attributes
  • 1.9. Relationships
• 2. Release Notes
  • 2.1. Version 2.1.0 (Upcoming)
  • 2.2. Version 2.0.2 (March, 2020)
  • 2.3. Version 2.0.1 (March, 2019)
  • 2.4. Version 2.0.0 (January, 2019)
    • 2.4.1. Summary
    • 2.4.2. Currently unsupported features:
    • 2.4.3. YAML support
    • 2.4.4. `quantity`
    • 2.4.5. `merge` and `include`
    • 2.4.6. `structured_dimensions`
    • 2.4.7. `autogen`
  • 2.5. Version 1.1c (Oct. 7, 2016)
• 3. Credits
  • 3.1. Acknowledgments
  • 3.2. Authors
    • 3.2.1. NWB:N: Version 2.0.0 and later
    • 3.2.2. NWB:N: Version 1.0.x and earlier
• 4. Legal
  • 4.1. Copyright
  • 4.2. License