Skip to main content

The Pythonic Blue Brain simulator access

Project description

banner

BlueCelluLab

Latest Release

latest release

Documentation

latest documentation

License

license

Build Status

CI

Coverage

coverage

Gitter

Join the chat at https://gitter.im/BlueBrain/BlueCelluLab

Citation

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 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 bluecellulab

Quick 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 ...
Voltage plot

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.

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.

Project details


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

bluecellulab-1.4.1.tar.gz (15.6 MB view details)

Uploaded Source

Built Distribution

bluecellulab-1.4.1-py3-none-any.whl (108.2 kB view details)

Uploaded Python 3

File details

Details for the file bluecellulab-1.4.1.tar.gz.

File metadata

  • Download URL: bluecellulab-1.4.1.tar.gz
  • Upload date:
  • Size: 15.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for bluecellulab-1.4.1.tar.gz
Algorithm Hash digest
SHA256 cd0616f7bd1d62e01425269dc903192c9192526a952e68f033f8c45cf1e9f95a
MD5 2217ba19732bca1843d218ce76ce6097
BLAKE2b-256 3be9b92a2382b8ab9b1bdb9ca4fdfe8169b419cebfddc4fcef6a617c569e36f5

See more details on using hashes here.

File details

Details for the file bluecellulab-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: bluecellulab-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 108.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for bluecellulab-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7cf29826fc8119a06c3f3e176cedbe86cd42687fe749ae6ba36d219f509ad72f
MD5 2627997f0a69da7dc8a02549e5f75ef6
BLAKE2b-256 d478f04610a216319edbe165f126d1baea45328b3afba9ceaa3891e671d6fa96

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page