From 3eb1cd7ac2ed2477b807bec7969734032de03e7d Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Thu, 7 Aug 2025 08:33:53 -0700 Subject: [PATCH] Fix #102 add missing resources sections to tools pages --- content/tools/analysis/deeplabcut.md | 5 +++++ content/tools/analysis/ecogvis.md | 4 ++++ content/tools/analysis/movement.md | 5 +++++ content/tools/analysis/neurosift.md | 4 ++++ content/tools/analysis/nwbexplorer.md | 4 ++++ content/tools/analysis/nwbview.md | 5 +++++ content/tools/analysis/nwbwidgets.md | 5 +++++ content/tools/analysis/sleap.md | 5 +++++ content/tools/core/hdmf-common-schema.md | 5 +++++ content/tools/core/hdmf-docutils.md | 4 ++++ content/tools/core/hdmf-specification-language.md | 5 +++++ content/tools/core/hdmf-zarr.md | 5 +++++ content/tools/core/hdmf.md | 5 +++++ content/tools/core/matnwb.md | 5 +++++ content/tools/core/ndx-catalog.md | 5 +++++ content/tools/core/ndx-template.md | 4 ++++ content/tools/core/neuroconv.md | 5 +++++ content/tools/core/nwb-guide.md | 5 +++++ content/tools/core/nwb-schema.md | 5 +++++ content/tools/core/nwbinspector.md | 5 +++++ content/tools/core/pynwb.md | 5 +++++ content/tools/core/staged-extensions.md | 4 ++++ 22 files changed, 104 insertions(+) diff --git a/content/tools/analysis/deeplabcut.md b/content/tools/analysis/deeplabcut.md index db3bc83..46ebeed 100644 --- a/content/tools/analysis/deeplabcut.md +++ b/content/tools/analysis/deeplabcut.md @@ -28,3 +28,8 @@ While ndx-pose was developed initially to store the output of DeepLabCut in NWB, - Versatile tracking of body parts across species - NWB export support through DLC2NWB - Integration with ndx-pose extension for standardized data storage + +## Resources + +* [Source](https://github.com/DeepLabCut/DeepLabCut) +* [Docs](http://www.mackenziemathislab.org/deeplabcut) diff --git a/content/tools/analysis/ecogvis.md b/content/tools/analysis/ecogvis.md index 24a77d1..31cf9c5 100644 --- a/content/tools/analysis/ecogvis.md +++ b/content/tools/analysis/ecogvis.md @@ -20,3 +20,7 @@ EcogVIS is a Python-based, time series visualizer for Electrocorticography (ECoG - Create annotations - Mark intervals of interest - Built-in support for NWB files + +## Resources + +* [Source](https://github.com/catalystneuro/ecogVIS) diff --git a/content/tools/analysis/movement.md b/content/tools/analysis/movement.md index 8e69002..1d2aaf9 100644 --- a/content/tools/analysis/movement.md +++ b/content/tools/analysis/movement.md @@ -18,3 +18,8 @@ weight: 200 ## NWB Integration `movement` pose datasets can be loaded from and saved to NWB files. The pose tracks are formatted according to the [ndx-pose](https://github.com/rly/ndx-pose) extension. See the NWB tab in the [movement I/O docs](https://movement.neuroinformatics.dev/user_guide/input_output.html). + +## Resources + +* [Source](https://github.com/neuroinformatics-unit/movement) +* [Docs](https://movement.neuroinformatics.dev/) diff --git a/content/tools/analysis/neurosift.md b/content/tools/analysis/neurosift.md index ffeca40..7aea18e 100644 --- a/content/tools/analysis/neurosift.md +++ b/content/tools/analysis/neurosift.md @@ -30,3 +30,7 @@ https://flatironinstitute.github.io/neurosift/#/nwb?url=https://dandiarchive.s3. ``` Replace the url query parameter with the appropriate URL for your NWB file on DANDI or anywhere else on the web. + +## Resources + +* [Source](https://github.com/flatironinstitute/neurosift) diff --git a/content/tools/analysis/nwbexplorer.md b/content/tools/analysis/nwbexplorer.md index 50f81aa..e293e87 100644 --- a/content/tools/analysis/nwbexplorer.md +++ b/content/tools/analysis/nwbexplorer.md @@ -16,3 +16,7 @@ NWB Explorer is a web application developed by MetaCell for reading, visualizing ![NWB Explorer Demo](/images/tools/nwbexplorer/nwbexplorer.gif) You can try NWB Explorer online at [https://nwbexplorer.v2.opensourcebrain.org](https://nwbexplorer.v2.opensourcebrain.org). + +## Resources + +* [Docs](https://nwbexplorer.v2.opensourcebrain.org) diff --git a/content/tools/analysis/nwbview.md b/content/tools/analysis/nwbview.md index e871adf..8155bc5 100644 --- a/content/tools/analysis/nwbview.md +++ b/content/tools/analysis/nwbview.md @@ -59,3 +59,8 @@ cargo run --release ``` The release flag builds the artifacts with optimizations. Do not specify it when you need to debug. + +## Resources + +* [Source](https://github.com/brainhack-ch/nwbview) +* [Docs](https://crates.io/crates/nwbview) diff --git a/content/tools/analysis/nwbwidgets.md b/content/tools/analysis/nwbwidgets.md index 18915f5..606434f 100644 --- a/content/tools/analysis/nwbwidgets.md +++ b/content/tools/analysis/nwbwidgets.md @@ -47,3 +47,8 @@ Instead of supplying a function for the value of the neurodata_vis_spec dict, yo ## Extending To extend NWBWidgets, all you need to a function that takes as input an instance of a specific neurodata_type class, and outputs a matplotlib figure or a jupyter widget. + +## Resources + +* [Source](https://github.com/NeurodataWithoutBorders/nwbwidgets) +* [Docs](https://nwb-widgets.readthedocs.io) diff --git a/content/tools/analysis/sleap.md b/content/tools/analysis/sleap.md index 6788ea9..653e0b3 100644 --- a/content/tools/analysis/sleap.md +++ b/content/tools/analysis/sleap.md @@ -31,3 +31,8 @@ This adaptor uses the NWB extension [ndx-pose](https://github.com/rly/ndx-pose), - Active learning capabilities - Proofreading tools - NWB import/export support + +## Resources + +* [Source](https://github.com/talmolab/sleap) +* [Docs](https://sleap.ai) diff --git a/content/tools/core/hdmf-common-schema.md b/content/tools/core/hdmf-common-schema.md index fb38f22..d5ceca6 100644 --- a/content/tools/core/hdmf-common-schema.md +++ b/content/tools/core/hdmf-common-schema.md @@ -43,3 +43,8 @@ groups: The HDMF Common Schema is particularly important because it defines general-purpose data structures that enable efficient and flexible representation of complex data. For example, the `DynamicTable` type provides a way to represent tabular data with columns of different data types and potentially varying numbers of rows, making it suitable for storing experimental metadata, subject information, and other tabular data. Understanding this schema is helpful for developers creating extensions, especially when they need to represent structured data like tables, which are common in scientific datasets. + +## Resources + +* [Source](https://github.com/hdmf-dev/hdmf-common-schema) +* [Documentation](https://hdmf-common-schema.readthedocs.io/en/stable/) \ No newline at end of file diff --git a/content/tools/core/hdmf-docutils.md b/content/tools/core/hdmf-docutils.md index 4b11b80..a420a05 100644 --- a/content/tools/core/hdmf-docutils.md +++ b/content/tools/core/hdmf-docutils.md @@ -39,3 +39,7 @@ html_content = rst_to_html('my_documentation.rst') HDMF Documentation Utilities help ensure that extension documentation follows consistent formatting and includes all necessary information. This consistency improves the usability of extensions and helps users understand how to properly use them in their workflows. The tools can generate documentation from YAML schema files, create diagrams of data structures, and produce HTML and PDF documentation outputs. + +## Resources + +* [Source](https://github.com/hdmf-dev/hdmf-docutils) diff --git a/content/tools/core/hdmf-specification-language.md b/content/tools/core/hdmf-specification-language.md index 6ab58fd..a916b82 100644 --- a/content/tools/core/hdmf-specification-language.md +++ b/content/tools/core/hdmf-specification-language.md @@ -46,3 +46,8 @@ groups: ## Additional Information Understanding the HDMF Specification Language is essential for developers who want to create extensions to the NWB format. It provides the foundation for defining structured, self-describing data models that can be used across different programming languages and storage backends. + +## Resources + +* [Sources](https://github.com/hdmf-dev/hdmf-schema-language) +* [Docs](https://hdmf-schema-language.readthedocs.io/en/latest/) diff --git a/content/tools/core/hdmf-zarr.md b/content/tools/core/hdmf-zarr.md index 5514926..e4715fc 100644 --- a/content/tools/core/hdmf-zarr.md +++ b/content/tools/core/hdmf-zarr.md @@ -54,3 +54,8 @@ with NWBZarrIO('example.zarr', mode='r') as io: HDMF-Zarr is particularly useful for working with very large datasets, especially in cloud environments or when parallel data access is needed. It provides an alternative storage format to the traditional HDF5 backend, offering different performance characteristics that may be beneficial for certain use cases. The library is designed to be a drop-in replacement for the HDF5 backend, making it easy to integrate into existing workflows that use PyNWB. + +## Resources + +* [Source](https://github.com/hdmf-dev/hdmf-zarr) +* [Docs](https://hdmf-zarr.readthedocs.io/en/stable/) diff --git a/content/tools/core/hdmf.md b/content/tools/core/hdmf.md index 7945ce8..ffbdc21 100644 --- a/content/tools/core/hdmf.md +++ b/content/tools/core/hdmf.md @@ -70,3 +70,8 @@ HDMF is primarily of interest to developers who need to: 5. Create validation tools Understanding HDMF is helpful for advanced NWB users who want to contribute to the core NWB ecosystem or develop sophisticated extensions and tools. + +## Resources + +* [Source](https://github.com/hdmf-dev/hdmf) +* [Docs](https://hdmf.readthedocs.io/en/stable/) diff --git a/content/tools/core/matnwb.md b/content/tools/core/matnwb.md index 088fcc5..54ddb68 100644 --- a/content/tools/core/matnwb.md +++ b/content/tools/core/matnwb.md @@ -43,3 +43,8 @@ nwb = nwbRead('test_file.nwb'); ## Additional Information MatNWB allows MATLAB users to work with NWB data in their preferred environment, using familiar MATLAB data structures and methods. + +## Resources + +* [Source](https://github.com/NeurodataWithoutBorders/matnwb/) +* [Docs](https://matnwb.readthedocs.io/) diff --git a/content/tools/core/ndx-catalog.md b/content/tools/core/ndx-catalog.md index b9df3c3..eab4cdd 100644 --- a/content/tools/core/ndx-catalog.md +++ b/content/tools/core/ndx-catalog.md @@ -37,3 +37,8 @@ To use a specific extension from the catalog, follow the installation instructio ## Additional Information The NDX Catalog is an important resource for the NWB community, facilitating the discovery and adoption of extensions that enhance the capabilities of the NWB standard for specific use cases and data types. + +## Resources + +* [Source](https://github.com/nwb-extensions/) +* [Docs](https://nwb-extensions.github.io/) diff --git a/content/tools/core/ndx-template.md b/content/tools/core/ndx-template.md index 7ff46b6..bca3a4e 100644 --- a/content/tools/core/ndx-template.md +++ b/content/tools/core/ndx-template.md @@ -58,3 +58,7 @@ After creating your extension using the template, follow the instructions in the 5. Publish your extension to the NDX Catalog The NDX Template is essential for maintaining consistency across the NWB extension ecosystem and making it easier for researchers to develop and share extensions. + +## Resources + +* [Source](https://github.com/nwb-extensions/ndx-template) diff --git a/content/tools/core/neuroconv.md b/content/tools/core/neuroconv.md index 7961861..67a73a0 100644 --- a/content/tools/core/neuroconv.md +++ b/content/tools/core/neuroconv.md @@ -55,3 +55,8 @@ converter.run_conversion( ## Additional Information NeuroConv is developed by CatalystNeuro and the NWB community to streamline the process of standardizing neurophysiology data to NWB format. It is designed to be modular and extensible, allowing for easy integration of new data formats. + +## Resources + +* [Source](https://github.com/catalystneuro/neuroconv) +* [Resources](https://neuroconv.readthedocs.io/en/main/index.html") diff --git a/content/tools/core/nwb-guide.md b/content/tools/core/nwb-guide.md index bfb115c..fdba941 100644 --- a/content/tools/core/nwb-guide.md +++ b/content/tools/core/nwb-guide.md @@ -42,3 +42,8 @@ The NWB GUIDE provides a step-by-step workflow for converting data to NWB: ## Additional Information The NWB GUIDE leverages NeuroConv behind the scenes, making it easier for researchers to adopt the NWB standard without writing code. It provides a user-friendly alternative for data conversion while maintaining the robustness and flexibility of the underlying conversion tools. + +## Resources + +* [Source](https://github.com/NeurodataWithoutBorders/nwb-guide) +* [Docs](https://nwb-guide.readthedocs.io/en/stable/) diff --git a/content/tools/core/nwb-schema.md b/content/tools/core/nwb-schema.md index e913b14..e842861 100644 --- a/content/tools/core/nwb-schema.md +++ b/content/tools/core/nwb-schema.md @@ -52,3 +52,8 @@ groups: The NWB Schema is a living document that evolves through community contributions and feedback. Extensions build on this foundation, allowing researchers to add specialized data types while maintaining compatibility with the core NWB standard. Understanding the NWB Schema is essential for anyone developing tools for NWB data, creating extensions, or seeking to understand the detailed structure of NWB files. + +## Resources + +* [Source](https://github.com/NeurodataWithoutBorders/nwb-schema) +* [Docs](https://nwb-schema.readthedocs.io/en/latest/) diff --git a/content/tools/core/nwbinspector.md b/content/tools/core/nwbinspector.md index e6b52be..d96f499 100644 --- a/content/tools/core/nwbinspector.md +++ b/content/tools/core/nwbinspector.md @@ -52,3 +52,8 @@ for issue in inspect_nwbfile(nwbfile): NWB Inspector is particularly useful for ensuring that your NWB files not only comply with the schema but also follow best practices that make them more useful and reusable. It helps improve data quality and increases the utility of shared data. In practice, most users should use the NWB Inspector to validate NWB files, as it helps to check for compliance with both the schema and best practices and provides greater flexibility. Direct use of PyNWB's validator is primarily useful for use cases where schema compliance and performance are of primary concern. + +## Resources + +* [Source](https://github.com/NeurodataWithoutBorders/nwbinspector) +* [Docs](https://nwbinspector.readthedocs.io/) diff --git a/content/tools/core/pynwb.md b/content/tools/core/pynwb.md index 286e384..eb23b29 100644 --- a/content/tools/core/pynwb.md +++ b/content/tools/core/pynwb.md @@ -46,3 +46,8 @@ with NWBHDF5IO('example.nwb', 'r') as io: ## Additional Information PyNWB also includes classes and command line tools for validating compliance of files with the core NWB schema and the schema of NWB Neurodata Extensions (NDX). + +## Resources + +* [Source](https://github.com/NeurodataWithoutBorders/pynwb/) +* [Docs](https://pynwb.readthedocs.io/en/stable/) diff --git a/content/tools/core/staged-extensions.md b/content/tools/core/staged-extensions.md index a79293e..52c340d 100644 --- a/content/tools/core/staged-extensions.md +++ b/content/tools/core/staged-extensions.md @@ -43,3 +43,7 @@ description: Brief description of your extension ## Additional Information The staged-extensions repository is a key part of the NWB extension ecosystem, ensuring that all extensions in the NDX Catalog meet community standards for quality, documentation, and usability. This review process helps maintain the integrity and usefulness of the extension ecosystem. + +## Resources + +* [Source](https://github.com/nwb-extensions/staged-extensions)