Skip to content

Code related to bringing WaveScalES and Elephant together in an HBP SP3-SP5 collaboration

License

Notifications You must be signed in to change notification settings

lrosati42/wavescalephant

 
 

Repository files navigation

WaveScalEphant

This repository aims at developing reusable and modular pipelines for a multi-scale, multi-methodology analysis of slow wave activity, brain states and their complexity.

The repository hosts the collaboration originally started by HBP-SGA2-(WP3.2 and WP5.7) and extended to other HBP members and partners as SP3 UseCase002.

Link to introductive video | Link to Ebrains Collaboratory | Link to pipeline README

Concept

For researchers to be able to effectively reproduce results and build on each other's progress, it is important to not only make results openly accessible and to facilitate data sharing but also to build the analysis workflows, to get the former from the latter, in a shareable and reusable manner.

Making analysis scripts available alongside results and datasets is good. What is even better is to design the analysis workflows in a manner that they are general and flexible enough so that they can actually be reused in further research. Within the rich diversity of analyses there is no one-size-fit-all solution for this. However, there is a lot of existing work that can help with the challenges of developing a general, adaptable, reusable analysis pipeline.

Here, we work to bring together existing analysis methods, tools, and data standards and interfacing them in the shape of a pipeline for the analysis and characterization of wave-like activity and UP/DOWN state detection. This work should serve both as a template for building reusable analysis pipelines in general, as well as a space to gather the various data types exhibiting slow-wave activity and their various analysis approaches into the same pipeline. Besides generating easily reproducible and curated results, such a pipeline promises to facilitate a rigorous comparison between datasets, model validation, and method benchmarking.

The current prototype includes

  • a hierarchical and modular pipeline framework based on Snakemake
  • reusable blocks and stages for standalone application or integration into workflows
  • analysis methods of electrophysiological and optical data on the characterization of cortical slow wave activity and local slow oscillations
  • visualization of the analysis steps and the intermediate results
  • intermediate results curated with annotated metadata and reports
  • guides for execution locally and on the collab
  • showcase Jupyter Notebooks for testbench applications and the visualization of the output

For further developments see the Issues.

Context

WaveScalES

Sleep is present in all animal species notwithstanding the risk associated with the disconnection from the environment (e.g. predation) and the reduction of time available for food search and reproduction. Indeed, it is known that the human brains need healthy sleep, as chronic sleep deprivation reduces cognitive performances. The goal of WaveScalES (description at the date 2019-03-31, SGA2-M12) is to unveil the underlying mechanisms of deep sleep, anesthesia and coma, the emergence toward wakefulness, and the link between sleep and learning, taking advantage of cortical slow wave activity (SWA) and investigating it with experimental data, analysis tools, modulation techniques, theoretical models and simulations of such states and of the transition to wakefulness. The resources of Wavescales are aimed to be made accessible via the EBRAINS resources including analysis tools (e.g., Elephant), simulation engines (e.g., NEST), and storage capacities (e.g., Knowledge Graph).

Elephant & Neo

Neuroscience research is very diverse in its approaches, measurement modalities, and analysis methods. However, the scale and complexity of modern challenges in the field require a large degree of collaboration and thus the ability for easy data and tool sharing.

The goal of Neo is to improve interoperability between Python tools for analyzing, visualizing, and generating electrophysiology data, by providing a common, shared object model. The Neo data format provides a hierarchical data and metadata description for a variety of data types including intracellular and extracellular electrophysiology electrical data with support for multi-electrodes as well as optical recordings. Furthermore, it supports a wide range of neurophysiology file formats and can thus read data from most common recording devices.

The Electrophysiology Analysis Toolkit, Elephant, is an open-source Python library for analysis methods. It focuses on providing fast and reliable implementations for generic analysis functions for spike train data and time series recordings from electrodes. As community centered project Elephant aims to serve as a common platform for analysis codes from different laboratories, and a consistent and homogeneous analysis framework.

HBP Deliverables

Releases planned by 2020-03-31 (HBP-SGA2-M24)

  • Component C2051 (SOAP r1 - Slow Oscillation Analysis Pipeline). Snakemake integration of the Slow Wave Analysis Pipeline Component capable of extracting the local features of oscillations, a necessary prerequisite for the analysis of slow waves performed at multi-area level by the SWAP analysis. See RelatedRepositories.rst
  • Component C2053 (SWAP r1 - Slow Wave Analysis Pipeline). Snakemake workflow for a modular slow wave analysis pipeline that can be applied to both optical calcium imaging recordings (GECI technique) and multi-electrode recordings (ECoG) in mouse.

Showcase notebooks

... coming soon

References

Papers

Datasets

Repositories

Involved members

  • Istituto Nazionale di Fisica Nucleare (INFN), Roma, Italy: Giulia De Bonis, Pier Stanislao Paolucci, Elena Pastorelli, Francesco Simula, Cristiano Capone, Chiara De Luca.
  • Forschungszentrum Jülich, Germany: Michael Denker, Robin Gutzen, Alper Yegenoglu.
  • Istituto Superiore di Sanità (ISS), Roma, Italy: Maurizio Mattia, Antonio Pazienti.
  • Institut d’Investigacions Biomediques August Pi i Sunyer (IDIBAPS), Barcelona, Spain: Miguel Dasilva, Maria V. Sanchez-Vives.
  • European Laboratory for Non-Linear Spectroscopy (LENS), Firenze, Italy: Anna Letizia Allegra Mascaro, Francesco Resta, Francesco Pavone.
  • University of Milano (UniMi), Italy: Andrea Pigorini, Thierry Nieus, Marcello Massimini
  • Unité de Neurosciences, Neuroinformatics Group, CNRS, France: Andrew Davison

Citation

Please cite this repository if you use it in your work.

License

The wavescalephant project is open source software and is licensed under the GNU General Public License v3 or later.

About

Code related to bringing WaveScalES and Elephant together in an HBP SP3-SP5 collaboration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 95.8%
  • Python 4.2%