generated from readthedocs/tutorial-template
-
Notifications
You must be signed in to change notification settings - Fork 8
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
rly
wants to merge
12
commits into
main
Choose a base branch
from
extensions_proposals
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
4b00537
First draft
rly f7cef1c
Update docs/source/extensions.rst
rly 3f66ccc
Update conf_extlinks.py
rly 5d285eb
Fix table?
rly 07c1ff1
Add subsubheader
rly 14c4e32
Merge branch 'main' into extensions_proposals
oruebel 3bc4fad
Merge branch 'main' into extensions_proposals
oruebel e50ca9c
Update conf_extlinks.py
rly 68aeafe
Rename NEP to NWBEP
rly a3cbe4a
Add NWBEP003
rly d506376
Add evaluation form
rly cf0040c
Update docs/source/extensions.rst
rly File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
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 (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 <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>`_ | ||
* - NWBEP003 | ||
- Multichannel volumetric imaging | ||
- Daniel Sprague | ||
- `Google Doc <https://docs.google.com/document/d/1IhhKwpPoXzPZTNXH7zCU_At4Py17aNJ6lYP_XaGX0wo/edit?usp=sharing>`_ | ||
|
||
|
||
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 <https://docs.google.com/document/d/e/2PACX-1vR7v4ixgnaCsJSbKji5eGWxb5muzV1M82zA-D2IswZD_KOt7HiUjcXKpTko0lqcBAD-MTd44rqFCf-V/pub>`_ | ||
- `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. <https://docs.google.com/document/d/e/2PACX-1vTpDnWFpD2YDuYKXzd-6svH6ceXNBz4wOauoZivvZpQgLPYBz6yv7-eihJceBtgGTDV_TcMX9xboNsm/pub>`_ | ||
- `NWBEP Evaluation Form <https://docs.google.com/document/d/1g8NWD-5q8SBLvoedOm4jWBXvY6aOG7VSAZ0owjjTUkY/edit>`_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.