https://github.com/bluebrain/singlecell-emodel-suite
https://github.com/bluebrain/singlecell-emodel-suite
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bluebrain/singlecell-emodel-suite
- Owner: BlueBrain
- Created: 2021-12-14T14:57:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T10:48:32.000Z (over 1 year ago)
- Last Synced: 2026-01-27T06:02:53.782Z (5 months ago)
- Size: 36.1 KB
- Stars: 10
- Watchers: 15
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Single-Cell E-Model Suite
A suite to handle single-cell electrophysiological data and to build and validate detailed electrical models.
- [eFEL](#efel) — Electrophys Feature (E-Feature) Extraction Library
- [BluePyEfe](#bluepyefe) — Blue Brain Python E-Feature Extraction from batches of recordings
- [BluePyOpt](#bluepyopt) — Blue Brain Python Optimisation Library
- [BluePyMM](#bluepymm) — Blue Brain Python Cell Model Management
- [BlueCelluLab](#bluecellulab) - Blue Brain Cellular Laboratory
- [BluePyEModel](#bluepyemodel) - Blue Brain Python Electrical Modeling Pipeline
- [EModelRunner](#emodelrunner) — Runs cells from stand-alone packages
- [BlueNaaS-SingleCell](#bluenaas-singlecell) - Interacts with single cell models through a web application
- [Currentscape](#currentscape) - Plot currents in electrical models
- [SSCxEModelExamples](#SSCxEModelExamples) - Reproduce Reva, Maria, et al. "A universal workflow for creation, validation and generalization of detailed neuronal models" (2023).
- [e-model-packager](#e-model-packager) - Creates e-model packages from circuits
- [emodel-generalisation](#emodel-generalisation) - Generalisation and MCMC sampling of electrical models of neurons
Useful links:
[GitHub repo](https://github.com/BlueBrain/eFEL),
[Documentation](https://efel.readthedocs.io/en/latest/).
**Electrophys Feature Extraction Library**
The Electrophys Feature Extraction Library (eFEL) allows neuroscientists to automatically extract features from
time series data recorded from neurons (both in vitro and in silico). Examples are the action potential width and amplitude
in voltage traces recorded during whole-cell patch clamp experiments.
The user of the library provides a set of traces and selects the features to be calculated.
The library will then extract the requested features and return the values to the user.
Useful links:
[GitHub repo](https://github.com/BlueBrain/BluePyEfe),
[Documentation](https://github.com/BlueBrain/BluePyEfe#readme).
**Blue Brain Python E-feature extraction**
BluePyEfe aims at easing the process of reading experimental recordings and extracting batches of electrical features from these recordings.
To do so, it combines trace reading functions and features extraction functions from the eFel library.
Useful links:
[GitHub repo](https://github.com/BlueBrain/BluePyOpt),
[Documentation](https://github.com/BlueBrain/BluePyOpt#readme).
**Blue Brain Python Optimisation Library**
The Blue Brain Python Optimisation Library (BluePyOpt) is an extensible framework for data-driven model parameter optimisation that wraps
and standardises several existing open-source tools.
Useful links:
[GitHub repo](https://github.com/BlueBrain/BluePyMM),
[Documentation](https://github.com/BlueBrain/BluePyMM#readme).
**Blue Brain Python Cell Model Management**
When building a network simulation, biophysically detailed electrical models (e-models) need to be tested for every morphology
that is possibly used in the circuit.
Useful links:
[GitHub repo](https://github.com/BlueBrain/BlueCelluLab),
[Documentation](https://github.com/BlueBrain/BlueCelluLab#readme).
**Blue Brain Cellular Laboratory**
BlueCelluLab is designed for simulations and experiments on individual cells or groups of cells. Suitable use cases for BlueCelluLab include:
* Scripting and statistical analysis for single cells or cell pairs.
* Lightweight, detailed reporting on specific state variables after simulation.
* Developing synaptic plasticity rules.
* Validating dynamics of synaptic properties.
* Automating in-silico whole-cell patching experiments.
* Debugging, both scientifically and computationally.
Useful links:
[GitHub repo](https://github.com/BlueBrain/BluePyEModel),
[Documentation](https://github.com/BlueBrain/BluePyEModel#readme).
**Blue Brain Python Electrical Modeling Pipeline**
The Blue Brain Python Electrical Modeling Pipeline (BluePyEModel) is a Python package facilitating the configuration and execution of electrical neuron model (e-model) building tasks. It covers tasks such as extraction of electrical features from electrophysiology data, e-model parameters optimisation and model validation. As such, it builds on top of eFEL, BluePyEfe and BluePyOpt.
## EModelRunner
Useful links:
[GitHub repo](https://github.com/BlueBrain/EModelRunner),
[Documentation](https://github.com/BlueBrain/EModelRunner#readme).
**Runs cells from stand-alone packages**
EModelRunner is a python library designed to run the cell models provided by the Blue Brain portals in a simple and straightforward way.
The cell models that EModelRunner can run are created by [e-model-packager](https://github.com/BlueBrain/e-model-packager).
## BlueNaaS-SingleCell
Useful links:
[GitHub repo](https://github.com/BlueBrain/BlueNaaS-SingleCell),
[Documentation](https://ebrains-cls-interactive.github.io/docs/online_usecases/single_cell_in_silico/single_cell_clamp/single_cell_clamp.html)
**Interacts with single cell models through a web application**
Blue-Neuroscience-as-a-Service-SingleCell is an open source web application. It enables users to quickly visualize single cell model morphologies in 3D or as a dendrogram. Using a simple web user interface, single cell simulations can be easily configured and launched, producing voltage traces from selected compartments.
## Currentscape
Currentscape is a Python tool enabling scientists to easily plot the currents in electrical neuron models. The code is based on the paper Alonso and Marder, 2019.
Useful links:
[GitHub repo](https://github.com/BlueBrain/Currentscape),
[Documentation](https://currentscape.readthedocs.io).
## SSCxEModelExamples
Software repository to reproduce the results of the publication below.
> Reva, M., Rössert, C., Arnaudon, A., Damart, T., Mandge, D., Tuncel, A., Ramaswamy,
> S., Markram, H., & Van Geit, W. (2023). A universal workflow for creation, validation, and
> generalization of detailed neuronal models. Patterns, 100855. https://doi.org/10.1016/j.patter.2023.100855
In the paper, we present a generalized automated workflow for the creation of robust electrical models and illustrate its performance by building cell models for the rat somatosensory cortex. Each model is based on a 3D morphological reconstruction and a set of ionic mechanisms. We use an evolutionary algorithm to optimize neuronal parameters to match the electrophysiological features extracted from experimental data. Then we validate the optimized models against additional stimuli and assess their generalizability on a population of similar morphologies. Compared to the state-of-the-art canonical models, our models show 5-fold improved generalizability. This versatile approach can be used to build robust models of any neuronal type.
[GitHub repo](https://github.com/BlueBrain/SSCxEModelExamples)
## e-model-packager
Creates e-model packages from circuits.
The implementation uses the Luigi Workflow Management System.
Can generate packages for various e-models, including: SSCX, Glusynapse (Synaptic Plasticity) and Thalamus.
This software is dependent on private data and private software. It has been released on GitHub "as is" for anyone wanting to see the code that has created Blue brain e-model packages such as the [synaptic plasticity ones](https://zenodo.org/records/6352774).
The models created by e-model-packager can be run easily using [EModelRunner](https://github.com/BlueBrain/EModelRunner).
Useful links:
[GitHub repo](https://github.com/BlueBrain/e-model-packager),
[Documentation](https://e-model-packager.readthedocs.io/en/latest/).
## emodel-generalisation
Generalisation and MCMC sampling of neuronal electrical models.
[Arnaudon, A., Reva, M., Zbili, M., Markram, H., Van Geit, W., & Kanari, L. (2023). Controlling morpho-electrophysiological variability of neurons with detailed biophysical models. iScience, 2023.](https://www.cell.com/iscience/fulltext/S2589-0042%2823%2902299-X)
Useful links:
[GitHub repo](https://github.com/BlueBrain/emodel-generalisation),
[Documentation](https://emodel-generalisation.readthedocs.io/en/latest/).