diff --git a/docs/source/conf_extlinks.py b/docs/source/conf_extlinks.py index f2059aa..a304517 100644 --- a/docs/source/conf_extlinks.py +++ b/docs/source/conf_extlinks.py @@ -50,11 +50,12 @@ 'datajoint': ('https://www.datajoint.com/%s', '%s'), 'datajoint-elements': ('https://datajoint.com/docs/elements/%s', '%s'), 'openscope-databook': ('https://alleninstitute.github.io/openscope_databook/%s', '%s'), - 'openscope-project': ('https://alleninstitute.org/what-we-do/brain-science/research/mindscope-program/openscope/%s', - '%s'), + 'openscope-project': ('https://alleninstitute.org/what-we-do/brain-science/research/mindscope-program/openscope/%s', '%s'), 'ibl-website': ('https://www.internationalbrainlab.com/%s', '%s'), 'mindscope-program': ('https://alleninstitute.org/what-we-do/brain-science/research/mindscope-program/%s', '%s'), 'jupyter-book': ('https://jupyterbook.org/en/stable/%s', '%s'), + 'nwbep-review': ('https://github.com/nwb-extensions/nwbep-review/%s', '%s'), + 'nwb-tab': ('https://docs.google.com/document/d/e/2PACX-1vSynhRf8Zykfqnov81Ddi1tSo12RV4zYv3RRCEfLR2OqhpER_7PTmaoTNrRh5Coh8xg2LvwuriiHlsJ/pub%s', '%s'), 'lindi-src': ('https://github.com/NeurodataWithoutBorders/lindi/%s', '%s'), } diff --git a/docs/source/extensions.rst b/docs/source/extensions.rst new file mode 100644 index 0000000..b377bfa --- /dev/null +++ b/docs/source/extensions.rst @@ -0,0 +1,68 @@ +.. _extensions-catalog: + +******************************** +Extensions Catalog and Proposals +******************************** + +NWB Extensions (NDX) Catalog +============================ + +The :ndx-catalog:`NDX Catalog website <>` contains published +extensions created by the community to add support for a wide variety of data types. +Before creating your own extension, we recommend that you explore the Catalog to +make sure that someone has not already created an extension that suits your needs +or that you could build off of. + +Policies on Community-driven Development and Integration of New Neuroscience Technologies with NWB +-------------------------------------------------------------------------------------------------- + +- `Sharing Guidelines: requirements and strategy for sharing format extensions for NWB `_ +- `Sharing Strategies: standard practices and strategies for sharing format extensions for NWB `_ +- `Versioning Guidelines: requirements and strategy for versioning namespaces for the NWB core schema and extensions `_ + +NWB Enhancement Proposals (NWBEPs) +================================ + +The NWB data standard is not static but evolves to adapt to changing needs from the neuroscience community, +clarify ambiguities, and fix bugs, among others. Users can propose smaller changes, such as improvements to +documentation or addition of a new optional field to an existing data type, on the +:nwb-schema-src:`NWB Schema GitHub repository <>`. Users can propose larger changes, such as addition of +several new data types to support a new data modality, or a major restructuring of existing data types, +through NWB Enhancement Proposals (NWBEPs). + +NWBEPs are often collaborative and led by members of the community to address a significant need by the +community. Here is a list of NWBEPs that have been started: + +.. list-table:: NWBEPs + :widths: 15 45 25 15 + :header-rows: 1 + + * - NBWEP + - Title + - Lead + - URLs + * - NWBEP001 + - Events and TTL Data + - Ryan Ly + - `Google Doc `_ + * - NWBEP002 + - Probe devices and channel mapping in extracellular ephys + - Alessio Buccino + - `Google Doc `_ + * - NWBEP003 + - Multichannel volumetric imaging + - Daniel Sprague + - `Google Doc `_ + + +To add a new NWBEP to this list, please file an issue on the :nwb-overview-src:`NWB Overview GitHub repo <>` +or create a pull request that modifies the table. + +Review of NWBEPs for acceptance to the NWB core data standard is led by the +:nwb-tab:`NWB Technical Advisory Board (TAB) <>` +and involves several phases. To submit a NWBEP for review and explore previous NWBEP reviews, see the +:nwbep-review:`NWBEP Review GitHub repo <>`. For more information on the NWBEP process, see the following links: + +- `Proposal Review Process: process by which extensions to the NWB core standard are proposed, evaluated, reviewed, and accepted `_ +- `Working Groups for Evaluating NWBEPs Policy: process for evaluation and review of NWB Extension Proposals (NWBEPs) by a review working group (RWG) to provide guidance and a formal framework for RWG members. `_ +- `NWBEP Evaluation Form `_ diff --git a/docs/source/index.rst b/docs/source/index.rst index cf1eaae..b8d2b73 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -34,6 +34,7 @@ for each of those tasks and point you to the best tools to use for your preferre :maxdepth: 1 community_gallery/community_gallery.rst + extensions faq .. toctree::