The Pythonic Blue Brain simulator access
Project description
BlueCelluLab
Latest Release |
|
Documentation |
|
License |
|
Build Status |
|
Coverage |
|
Gitter |
|
Citation |
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 you use this BlueCelluLab software for your research, we ask you to cite the following reference(this includes poster presentations):
@software{bluecellulab_zenodo,
author = {Van Geit, Werner and Tuncel, Anil and Gevaert, Mike and Torben-Nielsen, Benjamin and Muller, Eilif},
title = {BlueCelluLab},
month = jul,
year = 2023,
publisher = {Zenodo},
doi = {10.5281/zenodo.8113483},
url = {https://doi.org/10.5281/zenodo.8113483}
}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 checksFunding & 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 Blue Brain Project/EPFL
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bluecellulab-2.5.3.tar.gz.
File metadata
- Download URL: bluecellulab-2.5.3.tar.gz
- Upload date:
- Size: 16.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3a3ffbd54d0670baab221d1d4012932e207872acc72b7afa6a7e3e9067c6265c |
|
| MD5 | 1df26c58e1555c1a6e41c459316841b4 |
|
| BLAKE2b-256 | 8dfd595530bb794b6564c94a2def83ac64847c8601190a2ffebb7b72756bbcfe |
File details
Details for the file bluecellulab-2.5.3-py3-none-any.whl.
File metadata
- Download URL: bluecellulab-2.5.3-py3-none-any.whl
- Upload date:
- Size: 117.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b885b08424ae2de0f181534021fe998569941805923444a04bb6183aee9b52f1 |
|
| MD5 | 025c1298ba12c6ea6c2f642be11e572b |
|
| BLAKE2b-256 | 39b14aa9fca2d79643a1c89b6565a8fdfcedcb79da4ce37c049d957d3eb629bf |
