Skip to main content

Biologically detailed neural network simulations and analysis.

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.

Running the tests

Testing is set up using tox:

pip install tox

tox -e py3  # runs the tests
tox -e lint  # runs the format checks

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-2.6.20.tar.gz (503.5 kB view details)

Uploaded Source

Built Distribution

bluecellulab-2.6.20-py3-none-any.whl (119.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bluecellulab-2.6.20.tar.gz
  • Upload date:
  • Size: 503.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for bluecellulab-2.6.20.tar.gz
Algorithm Hash digest
SHA256 e1d5094b77c44259dfb5ba73a6a2f5c05fb9ac41fca90febedc4f2500ad9e28d
MD5 ff7772ade3e4ad458548a99f659f1730
BLAKE2b-256 1068467aad4c12dee24e407e95bf09c23d66107adfd9f6a5f5533b1b220d08ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bluecellulab-2.6.20-py3-none-any.whl
Algorithm Hash digest
SHA256 50b811703ec9395e1ff15e85db11aa49c23de099946af61711e8e63f9d430a65
MD5 ef7d580900a320ae0d9e18649f3349b6
BLAKE2b-256 479bc5e3684d1d3b6650cf6282477126bafddf8467fb498946a75edae5389755

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