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

Contributing

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.

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

Uploaded Source

Built Distribution

bluecellulab-2.6.23-py3-none-any.whl (120.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bluecellulab-2.6.23.tar.gz
  • Upload date:
  • Size: 504.4 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.23.tar.gz
Algorithm Hash digest
SHA256 03a52cab9f501da1714e599d92c48bb57fa12d93fe14fdd1cc9970325039b47e
MD5 07c8d3462f846f0d4d4094dafd4babef
BLAKE2b-256 779d4a0492e58d7e2a47933d5dab38f753e5b89cb02e797de5879da19533d1cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bluecellulab-2.6.23-py3-none-any.whl
Algorithm Hash digest
SHA256 03e0e22e5abcf43cefd9fe3ea483f54ce05161a32422aa94377c74687106900d
MD5 ccd35667dddab0e6f3d78655202237ae
BLAKE2b-256 f38339f8f02afc67b8c2ad8a820eb78a0da89b2e7c4eb755544693b6f3d7ebbc

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