Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose changes to the #151 #171

Open
wants to merge 1 commit into
base: extensions_proposals
Choose a base branch
from
Open

Propose changes to the #151 #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 44 additions & 37 deletions docs/source/extensions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,73 @@
.. _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 <https://docs.google.com/document/d/e/2PACX-1vRxbT-EEAyYbQL3P0TREpySJkMhV7ea2-aRO75_s4PhqzxnJa9p-s0SzVWrlkzEBaTw82bgzZBtxEuj/pub>`_
- `Sharing Strategies: standard practices and strategies for sharing format extensions for NWB <https://docs.google.com/document/d/e/2PACX-1vSpLLPQV2XlfT-Qnpi_aqLPJzRjCko6Ur0U5COCEAQg5uLIN0h5vej5EPtsf6UNx1qiAIKXPiIveSWo/pub>`_
- `Versioning Guidelines: requirements and strategy for versioning namespaces for the NWB core schema and extensions <https://docs.google.com/document/d/e/2PACX-1vSH72zNSUBToVcZDRI4gF7h15ImWRffvj-ju1oEbxggPrEFJd5L6GQc-fRiVmIi42U742tgjcRk65jv/pub>`_

**********************************
NWB Enhancement Proposals (NWBEPs)
================================
**********************************

The NWB data standard is not static but evolves to adapt to changing needs from the neuroscience community,
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).
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.

.. note::

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:
The :ndx-catalog:`NDX Catalog website <>` contains published
extensions created by the community. 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. Also see :ref:`extension-publishing-ndxcatalog` for details
on how to publish your own extension in the NDX Catalog.

.. list-table:: NWBEPs
Current NWBEPs
==============

.. list-table:: **NWBEPs**
:widths: 15 45 25 15
:header-rows: 1

* - NBWEP
* - NWBEP
- Title
- Lead
- URLs
* - NWBEP001
- Events and TTL Data
- Ryan Ly
- `Google Doc <https://docs.google.com/document/d/1qcsjyFVX9oI_746RdMoDdmQPu940s0YtDjb1en1Xtdw/edit?usp=sharing>`_
- `Google Doc <https://docs.google.com/document/d/1qcsjyFVX9oI_746RdMoDdmQPu940s0YtDjb1en1Xtdw/edit?usp=sharing>`__
* - NWBEP002
- Probe devices and channel mapping in extracellular ephys
- Alessio Buccino
- `Google Doc <https://docs.google.com/document/d/1q-haFEEHEgZpRoCzzQsuSWCKN4QfMsTzLnlptLaf-yw/edit?usp=sharing>`_
- `Google Doc <https://docs.google.com/document/d/1q-haFEEHEgZpRoCzzQsuSWCKN4QfMsTzLnlptLaf-yw/edit?usp=sharing>`__
* - NWBEP003
- Multichannel volumetric imaging
- Daniel Sprague
- `Google Doc <https://docs.google.com/document/d/1IhhKwpPoXzPZTNXH7zCU_At4Py17aNJ6lYP_XaGX0wo/edit?usp=sharing>`_
- `Google Doc <https://docs.google.com/document/d/1IhhKwpPoXzPZTNXH7zCU_At4Py17aNJ6lYP_XaGX0wo/edit?usp=sharing>`__


.. note::

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.

Related Policies
=================

The following list shows NWB policies related to community-driven development and integration
of new neuroscience technologies with NWB

- `Sharing Guidelines: requirements and strategy for sharing format extensions for NWB <https://docs.google.com/document/d/e/2PACX-1vRxbT-EEAyYbQL3P0TREpySJkMhV7ea2-aRO75_s4PhqzxnJa9p-s0SzVWrlkzEBaTw82bgzZBtxEuj/pub>`_
- `Sharing Strategies: standard practices and strategies for sharing format extensions for NWB <https://docs.google.com/document/d/e/2PACX-1vSpLLPQV2XlfT-Qnpi_aqLPJzRjCko6Ur0U5COCEAQg5uLIN0h5vej5EPtsf6UNx1qiAIKXPiIveSWo/pub>`_
- `Versioning Guidelines: requirements and strategy for versioning namespaces for the NWB core schema and extensions <https://docs.google.com/document/d/e/2PACX-1vSH72zNSUBToVcZDRI4gF7h15ImWRffvj-ju1oEbxggPrEFJd5L6GQc-fRiVmIi42U742tgjcRk65jv/pub>`_

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.
NWBEP Submission and Review Process
===================================

Review of NWBEPs for acceptance to the NWB core data standard is led by the
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
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 <https://docs.google.com/document/d/e/2PACX-1vR7v4ixgnaCsJSbKji5eGWxb5muzV1M82zA-D2IswZD_KOt7HiUjcXKpTko0lqcBAD-MTd44rqFCf-V/pub>`_
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ for each of those tasks and point you to the best tools to use for your preferre
conversion_tutorial/user_guide
file_read/file_read
extensions_tutorial/extensions_tutorial_home
extensions
core_tools/core_tools_home

.. toctree::
Expand All @@ -34,7 +35,6 @@ 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::
Expand Down