Enhancement Proposals

About NWB Enhancement Proposals (NWBEP)

What is an NWBEP?

NWB Enhancement Proposals (NWBEP) are the official, formal way to propose major additions or changes to the NWB standard. They are used when a new feature, data type, or change is broadly useful to the community and should become part of the official NWB specification.

Review Process

NWBEPs undergo a structured review and approval process facilitated by the NWB Technical Advisory Board (TAB) to ensure quality, consensus, and long-term maintainability.

Testing with Extensions

NWBEPs often leverage NWB extensions (NDX) as a testing ground, implementing and evaluating proposed changes first as an NDX. This allows the community to use, test, and refine the extension in real-world scenarios before being considered for inclusion in the core NWB standard.

When to Create an NWBEP

Broad Community Benefit

Create an NWBEP when a new feature or data type would benefit the entire NWB community and should be standardized.

Core Type Changes

Use an NWBEP when changes to existing core types are needed or when standardization across the community is important for the proposed functionality.

Lab-Specific Needs

For lab-specific or experimental data types that don’t need community-wide standardization, consider creating an NWB Extension (NDX) instead.

Resources

NWBEP Process

NWBEP Process and Policies

Official policies governing how NWB Enhancement Proposals are submitted, reviewed, and approved.

How to Create an NWBEP

Step-by-step guide for creating and submitting a new NWB Enhancement Proposal.

NWBEP Reviews Repository

Browse the list and reviews of current and pending NWBEPs (see both the main repo and issues pages).

Related Resources

NWB Extensions (NDX)

Community-driven extensions for lab-specific needs that don’t require changes to the core NWB standard.

NDX Catalog

Browse available extensions in the Neurodata Extensions Catalog.