Skip to content

Commit

Permalink
update paper
Browse files Browse the repository at this point in the history
  • Loading branch information
magland committed Feb 29, 2024
1 parent d618dbf commit 341c2d9
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions paper/joss/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Neurosift, a browser-based visualization tool,
is designed for the interactive exploration of Neurodata Without Borders (NWB) files,
whether stored locally, on remote servers,
or within the Distributed Archives for Neurophysiology Data Integration (DANDI).
Neurodata Without Borders (NWB) [@teeters2015neurodata; @rubel2022neurodata] is an open data standard for neurophysiology that enables the sharing, archiving, and analysis of various types of neurophysiology data,
Neurodata Without Borders (NWB) [@teeters2015neurodata; @rubel2022neurodata] is an open data standard for neurophysiology that enables the sharing, archiving, and analysis of various types of neurophysiology data.
DANDI [@rubel2022neurodata] is a cloud-based platform that supports the storage, sharing, and analysis of neurophysiology data including NWB files.
With Neurosift integration, users browsing DANDI can easily open any NWB file in the browser,
and explore its contents, including timeseries data, images, and more.
Expand All @@ -44,15 +44,24 @@ making it a valuable tool for neuroscientists.

In the evolving field of neuroscience research, the ability to manage and share complex data sets is crucial. NWB has emerged as a standard for neurophysiology data, aimed at facilitating data sharing, storage, and analysis. However, the specialized nature of the NWB format necessitates tools that can provide intuitive interfaces for researchers to explore their data effectively. Neurosift is designed to address this need.

Files found on DANDI can often be large and unwieldy. Various Python tools have emerged to address this by streaming portions of the NWB file without the need to download the entire file. One such tool is NWB Widgets [@nwbwidgets], which provides a suite of interactive widgets for visualizing NWB data within Jupyter notebooks or JupyterLab, enabling users to navigate the hierarchical structure of NWB files and directly visualize specific data elements. This package was a large part of the inspiration for Neurosift. The main difference is that NWB Widgets is a Python package that runs within interactive Python environments, while Neurosift is a browser-based tool that can be used without any installation. These two tools cater to different use cases, with Neurosift being more accessible to a wider audience, and is better suited for integration with DANDI.
Because files found on DANDI can often be large and unwieldy, various Python tools have emerged to address this by streaming portions of the NWB file without the need to download the entire file. One such tool is NWB Widgets [@nwbwidgets], which provides a suite of interactive widgets for visualizing NWB data within Jupyter notebooks, enabling users to navigate the hierarchical structure of NWB files and directly visualize specific data elements. This package was a large part of the inspiration for Neurosift. The main difference is that NWB Widgets is a Python package that runs within interactive Python environments, while Neurosift is a browser-based tool that can be used without any installation. These two tools cater to different use cases, with Neurosift being more accessible to a wider audience, and being better suited for integration with DANDI.

## Features

The main technical challenge in developing Neurosift lies in its requirement to lazy-load data objects from remote NWB files, which are based on the complex HDF5 format. While HDF5's efficient data organization is ideal for the large, multidimensional datasets typical in neurophysiology, its primary implementations are in C. This necessitates a creative solution for web-based access and manipulation of these files. To bridge this gap, Neurosift leverages WebAssembly to run compiled C code in the browser, specifically utilizing a modified version of the h5wasm [@h5wasm] library. Unlike the original h5wasm library, which built to handle fully downloaded files, Neurosift's fork introduces an innovative approach to efficiently read data chunks from remote files. This allows for synchronous data reads without the need for the entire file's prior download. This solution not only makes Neurosift a powerful tool for neuroscience research but also showcases the potential of WebAssembly in overcoming challenges associated with web-based data analysis tools.
Neurodata Without Borders files are structured hierarchically, encapsulating various *neurodata types* that reflect different aspects of neurophysiological experiments. These types range from *BehavioralEvents*, which record discrete actions or occurrences within experiments, to data structures like *Fluorescence*, *ImageSegmentation*, and *RoiResponseSeries*. Other neurodata types include *ElectricalSeries* for electrophysiological signals and *Units* for spike times of neurons. Neurosift provides plugin visualizations for many of these types and facilitates the creation of composite views by allowing users to select and synchronize multiple data types within the same interface. This synchronization extends to navigation actions such as zooming and panning, where different sub-windows, each displaying a different aspect of the data, maintain a shared time axis.

In conclusion, Neurosift makes neurophysiology data more accessible and manageable for scientists. By facilitating the exploration of complex datasets directly within a browser, without requiring specialized programming knowledge, it lowers the barrier to entry for data analysis and fosters collaborative research efforts. Looking forward, there is potential for Neurosift to expand its capabilities, with enhanced visualizations and support for additional data types.
## Architecture

Neurosift is a React/TypeScript/Vite web application. It is a static site meaning that it is delivered to the user's browser exactly as stored, without the need for dynamic server-side processing of requests. This approach simplifies deployment and maintenance; It is currently being hosted on GitHub Pages, but it could easily be deployed to any other static hosting service.

The main technical challenge in developing Neurosift was the requirement to lazy-load data objects from remote NWB files, which are built on the complex HDF5 format. While HDF5's efficient data organization is ideal for the large, multidimensional datasets typical in neurophysiology, its primary implementations are in the C language. This necessitates a creative solution for web-based access and manipulation of these files. To bridge this gap, Neurosift leverages WebAssembly to run compiled C code in the browser, specifically utilizing a modified version of the h5wasm [@h5wasm] library. Unlike the original h5wasm, which built to handle fully downloaded files, Neurosift's fork introduces an innovative approach to efficiently reading data chunks from remote files. This allows for synchronous data reads without the need for a prior download of the entire file. This solution not only makes Neurosift a powerful tool for neuroscience research but also showcases the potential of WebAssembly in overcoming challenges associated with web-based data analysis tools.

## Conclusion

Neurosift makes neurophysiology data more accessible for scientists. By facilitating the exploration of complex datasets directly within a browser, without requiring specialized programming knowledge, it lowers the barrier to entry for data analysis and fosters collaborative research efforts. Looking forward, there is potential for Neurosift to expand its capabilities, with enhanced visualizations and support for additional data types.

## Acknowledgements

Some of the visualizations in Neurosift were ported from other projects where Jeff Soules was a core developer.
Thank you to Jeff Soules who helped develop visualizations that were ported over to Neurosift.

# References

0 comments on commit 341c2d9

Please sign in to comment.