{"id":20489252,"url":"https://github.com/NeurodataWithoutBorders/nwbwidgets","last_synced_at":"2025-05-09T04:31:56.217Z","repository":{"id":35087355,"uuid":"174396420","full_name":"NeurodataWithoutBorders/nwbwidgets","owner":"NeurodataWithoutBorders","description":"Explore the hierarchical structure of NWB 2.0 files and visualize data with Jupyter widgets.","archived":false,"fork":false,"pushed_at":"2024-04-29T18:01:28.000Z","size":15410,"stargazers_count":48,"open_issues_count":82,"forks_count":22,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-04-29T19:25:56.194Z","etag":null,"topics":["jupyter","jupyter-notebook","nwb","python","visualization"],"latest_commit_sha":null,"homepage":"https://nwb-widgets.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NeurodataWithoutBorders.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.rst","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-07T18:10:41.000Z","updated_at":"2024-04-29T19:25:58.453Z","dependencies_parsed_at":"2023-10-03T04:32:38.617Z","dependency_job_id":"ea3de318-65e7-4363-a0e7-3a1e0d85f8a5","html_url":"https://github.com/NeurodataWithoutBorders/nwbwidgets","commit_stats":{"total_commits":566,"total_committers":23,"mean_commits":"24.608695652173914","dds":"0.47526501766784457","last_synced_commit":"fdc030921297affe9784d00f01ea9f3aa7f98fb2"},"previous_names":["neurodatawithoutborders/nwb-jupyter-widgets"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeurodataWithoutBorders%2Fnwbwidgets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeurodataWithoutBorders%2Fnwbwidgets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeurodataWithoutBorders%2Fnwbwidgets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NeurodataWithoutBorders%2Fnwbwidgets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NeurodataWithoutBorders","download_url":"https://codeload.github.com/NeurodataWithoutBorders/nwbwidgets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224556927,"owners_count":17331088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jupyter","jupyter-notebook","nwb","python","visualization"],"created_at":"2024-11-15T17:11:59.400Z","updated_at":"2024-11-15T17:12:00.578Z","avatar_url":"https://github.com/NeurodataWithoutBorders.png","language":"Python","readme":"[![PyPI version](https://badge.fury.io/py/nwbwidgets.svg)](https://badge.fury.io/py/nwbwidgets)\n[![codecov](https://codecov.io/gh/NeurodataWithoutBorders/nwbwidgets/branch/master/graph/badge.svg)](https://codecov.io/gh/NeurodataWithoutBorders/nwbwidgets)\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NeurodataWithoutBorders/nwb-jupyter-widgets/master?filepath=examples%2FNWBWidgets-modality-demos.ipynb)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/NeurodataWithoutBorders/nwbwidgets/assets/844306/f20b8c26-79c7-4c1c-a3b5-b49ecf8cce5d\" width=\"350\" alt=\"NWB Widgets\"/\u003e\n  \u003ch3 align=\"center\"\u003eExplore NWB data in Jupyter\u003c/h3\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://nwb-widgets.readthedocs.io/\"\u003e\u003cstrong\u003eExplore our documentation »\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n## Table of Contents\n\n- [About](#about)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Demo](#demo)\n- [Documentation](#documentation)\n\n## About\nA library of widgets for visualization NWB data in a Jupyter notebook (or lab). The widgets allow you to navigate through the hierarchical structure of the NWB file and visualize specific data elements. It is designed to work out-of-the-box with NWB 2.0 files and to be easy to extend.\n\n\n## Installation\n\n`nwbwidgets` requires Python \u003e= 3.7.\n\nThe latest published version can be installed by running:\n\n```bash\npip install nwbwidgets\n```\n\nNote that there are some optional dependencies required for some widgets.\nIf an NWB data file contains a data type that requires additional dependencies,\nyou will see a list of extra modules needed for that specific widget.\nAll other widgets in the file will still work.\n\n## Usage\n\n### Using `Panel`\nThe easiest way to use NWB widgets is with the interactive `Panel`:\n\n```python\nfrom nwbwidgets.panel import Panel\n\nPanel()\n```\n\n### Using `nwb2widget`\nIf you’re working directly with a NWB file object in your Jupyter notebook, you can also explore it with NWB Widgets using\n\n```python\nfrom pynwb import NWBHDF5IO\nfrom nwbwidgets import nwb2widget\n\nio = NWBHDF5IO('path/to/file.nwb', mode='r')\nnwb = io.read()\n\nnwb2widget(nwb)\n```\n\n### Using Docker\nYou can also run the NWB Widgets Panel using Docker:\n\n```bash\n$ docker run -p 8866:8866 ghcr.io/NeurodataWithoutBorders/nwbwidgets-panel:latest\n```\n\n## Demo\n![](https://drive.google.com/uc?export=download\u0026id=1JtI2KtT8MielIMvvtgxRzFfBTdc41LiE)\n\n## Documentation\nSee our [ReadTheDocs page](https://nwb-widgets.readthedocs.io) for full documentation, including a gallery of all supported formats.\n\n## How it works\nAll visualizations are controlled by the dictionary `neurodata_vis_spec`. The keys of this dictionary are pynwb neurodata types, and the values are functions that take as input that neurodata_type and output a visualization. The visualizations may be of type `Widget` or `matplotlib.Figure`. When you enter a neurodata_type instance into `nwb2widget`, it searches the `neurodata_vis_spec` for that instance's neurodata_type, progressing backwards through the parent classes of the neurodata_type to find the most specific neurodata_type in `neurodata_vis_spec`. Some of these types are containers for other types, and create accordian UI elements for its contents, which are then passed into the `neurodata_vis_spec` and rendered accordingly.\n\nInstead of supplying a function for the value of the `neurodata_vis_spec` dict, you may provide a `dict` or `OrderedDict` with string keys and function values. In this case, a tab structure is rendered, with each of the key/value pairs as an individual tab. All accordian and tab structures are rendered lazily- they are only called with that tab is selected. As a result, you can provide may tabs for a single data type without a worry. They will only be run if they are selected.\n\n## Extending\nTo 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.\n\n## Used in\n* [giocomo-lab-to-nwb](https://github.com/ben-dichter-consulting/giocomo-lab-to-nwb)\n* [buffalo-lab-data-to-nwb](https://github.com/ben-dichter-consulting/buffalo-lab-data-to-nwb)\n* [axel-lab-to-nwb](https://github.com/ben-dichter-consulting/axel-lab-to-nwb)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNeurodataWithoutBorders%2Fnwbwidgets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNeurodataWithoutBorders%2Fnwbwidgets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNeurodataWithoutBorders%2Fnwbwidgets/lists"}