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.

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

Add basic page on NWB extensions catalog and proposals #151

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
2 changes: 2 additions & 0 deletions docs/source/conf_extlinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@
'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'),
'nep-review': ('https://github.com/nwb-extensions/nep-review/%s', '%s'),
'nwb-tab': ('https://docs.google.com/document/d/e/2PACX-1vSynhRf8Zykfqnov81Ddi1tSo12RV4zYv3RRCEfLR2OqhpER_7PTmaoTNrRh5Coh8xg2LvwuriiHlsJ/pub%s', '%s'),
}

# Use this for mapping for links to commonly used documentation
Expand Down
61 changes: 61 additions & 0 deletions docs/source/extensions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
.. _extensions-catalog:

********************************
Extensions Catalog and Proposals
********************************
Comment on lines +3 to +5
Copy link
Contributor

@oruebel oruebel Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content of the page looks good, but I propose a few changes to the overall structure of the page (i.e., mainly just moving around some the content and changing section headings). Since these changes affect the whole page, it was tricky to propose these changes on the PR directly, so I created a separate PR that targets this PR to propose the changes #171 @rly please take a look at #171 and see what you think.


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
rly marked this conversation as resolved.
Show resolved Hide resolved

- `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 (NEPs)
================================

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 (NEPs).

NEPs are often collaborative and led by members of the community to address a significant need by the
community. Here is a list of NEPs that have been started:

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

* - NEP
- Title
- Lead
- URLs
* - NEP001
- Events and TTL Data
- Ryan Ly
- `Google Doc <https://docs.google.com/document/d/1qcsjyFVX9oI_746RdMoDdmQPu940s0YtDjb1en1Xtdw/edit?usp=sharing>`_
* - NEP002
- Probe devices and channel mapping in extracellular ephys
- Alessio Buccino
- `Google Doc <https://docs.google.com/document/d/1q-haFEEHEgZpRoCzzQsuSWCKN4QfMsTzLnlptLaf-yw/edit?usp=sharing>`_

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend maintaining this list of NEP's in one place, preferably the place where NEPs are being managed, i.e., either on the repo or the NDX Catalog. It'll be hard enough to maintain this list in one place. I would just point to the list here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I suggest this is the only place we maintain this list.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have single folder in GoogleDrive where each NEP would get a subfolder such that we could simply embed the folder listing?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is right place for this in the long run. I think something on nwb.org (once we have a new home) or on the NDX Catalog would be more appropriate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting idea. Do you mean use an iframe here that points to a public Google Drive folder? Do you envision copying the google docs from the proposer's space to our folder or linking out to their google docs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think either way is fine. In general it seems simpler to just have the documents (with one subfolder ber NEP) in the Drive directly, but linking to the documents seems perfectly fine, as long as there is public read access on the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think something on nwb.org (once we have a new home) or on the NDX Catalog would be more appropriate.

I think new nwb.org would be a good home. I think linking to the docs is easy and fine.

To add a new NEP 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 NEPs for acceptance to the NWB core data standard is led by the
rly marked this conversation as resolved.
Show resolved Hide resolved
:nwb-tab:`NWB Technical Advisory Board (TAB) <>`
and involves several phases. To submit a NEP for review and explore previous NEP reviews, see the
:nep-review:`NEP Review GitHub repo <>`. For more information on the NEP 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>`_
- `Working Groups for Evaluating NEPs Policy: process for evaluation and review of NWB Extension Proposals (NEPs) by a review working group (RWG) to provide guidance and a formal framework for RWG members. <https://docs.google.com/document/d/e/2PACX-1vTpDnWFpD2YDuYKXzd-6svH6ceXNBz4wOauoZivvZpQgLPYBz6yv7-eihJceBtgGTDV_TcMX9xboNsm/pub>`_
rly marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
oruebel marked this conversation as resolved.
Show resolved Hide resolved
faq

.. toctree::
Expand Down
Loading