BlueCelluLab
Latest Release |
|
Documentation |
|
License |
|
Build Status |
|
Coverage |
|
Gitter |
|
Paper |
|
Zenodo |
The Blue Brain Cellular Laboratory 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.
Citation
When using the BlueCelluLab software for your research, please cite the following paper (including for poster presentations): BlueCelluLab: Biologically Detailed Neural Network Experimentation API
@article{Tuncel2024,
doi = {10.21105/joss.07026},
url = {https://doi.org/10.21105/joss.07026},
year = {2024},
publisher = {The Open Journal},
volume = {9},
number = {100},
pages = {7026},
author = {Anıl Tuncel and Werner Van Geit and Mike Gevaert and Benjamin Torben-Nielsen and Darshan Mandge and İlkan Kılıç and Aurélien Jaquier and Eilif Muller and Lida Kanari and Henry Markram},
title = {BlueCelluLab: Biologically Detailed Neural Network Experimentation API},
journal = {Journal of Open Source Software}
}If you need to cite a specific version, please use the DOI provided by Zenodo, which you can access via the “Cite this repository” button at the top of the repository page.
Support
We are providing support on Gitter. We suggest you create tickets on the Github issue tracker in case you encounter problems while using the software or if you have some suggestions.
Main dependencies
Installation
BlueCelluLab can be pip installed with the following command:
pip install bluecellulabQuick Start
The following example shows how to create a cell, add a stimulus and run a simulation:
from bluecellulab.cell import create_ball_stick
from bluecellulab import Simulation
cell = create_ball_stick()
sim = Simulation()
sim.add_cell(cell)
stimulus = cell.add_step(start_time=5.0, stop_time=20.0, level=0.5)
sim.run(25, cvode=False)
time, voltage = cell.get_time(), cell.get_soma_voltage()
# plotting time and voltage ...
Tutorial
A more detailed explanation on how to use BlueCelluLab, as well as other examples can be found on the examples page.
API Documentation
The API documentation can be found on ReadTheDocs.
Running the tests
Testing is set up using tox:
pip install tox
tox -e py3 # runs the tests
tox -e lint # runs the format checksContributing
We welcome contributions to BlueCelluLab! Please see the CONTRIBUTING.rst for guidelines on how to contribute.
Funding & Acknowledgements
The development and maintenance of this code is supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.
Copyright
Copyright (c) 2023-2024 Blue Brain Project/EPFL
Copyright (c) 2025 Open Brain Institute
This work is licensed under Apache 2.0
For MOD files for which the original source is available on ModelDB, any specific licenses on mentioned on ModelDB, or the generic License of ModelDB apply.
The licenses of the morphology files used in this repository are available on: https://zenodo.org/record/5909613
5 maintainers
Release files for bluecellulab 2.6.104
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bluecellulab-2.6.104.tar.gz | 572.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bluecellulab-2.6.104-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 765.0 kB
Release files / bluecellulab-2.6.104.tar.gz
| Download URL | bluecellulab-2.6.104.tar.gz |
|---|---|
| Size | 572.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f637bd6310a295c39dda9e4b72cdf5710e3f1072dad653800988061795c60810
|
|
BLAKE2b-256 checksum How to use checksums |
1fd73ec5b66a13761adaa9f34d6f88f59e03960cb13f7e589251061bc0f3e542
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / bluecellulab-2.6.104-py3-none-any.whl
| Download URL | bluecellulab-2.6.104-py3-none-any.whl |
|---|---|
| Size | 192.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f184c77b25c9bb43fd17244c9116ce3c5e575f3c437cb65a065e4a6677c70b5
|
|
BLAKE2b-256 checksum How to use checksums |
85a7eac6acd44c1d123e5d1c91290d544f44f004c44f2f4eea4484d6e023a1c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
