Skip to main content

banner

BlueCelluLab

Latest Release

latest release

Documentation

latest documentation

License

license

Build Status

CI

Coverage

coverage

Gitter

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

Paper

JOSS

Zenodo

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

Metadata

Release files for bluecellulab 2.6.112

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bluecellulab 2.6.112
File Size Uploaded Provenance Actions
bluecellulab-2.6.112.tar.gz 621.1 kB Without provenance Details for bluecellulab-2.6.112.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bluecellulab 2.6.112
File Interpreter ABI Platform Actions
bluecellulab-2.6.112-py3-none-any.whl Python 3 none any Details for bluecellulab-2.6.112-py3-none-any.whl

Total release size: 866.0 kB

Release files / bluecellulab-2.6.112.tar.gz

Download URL bluecellulab-2.6.112.tar.gz
Size 621.1 kB
Tags Source
SHA-256 checksum
How to use checksums
58efe01dd4b1f81b52eced11586bae6d2ddef1d07953167e0facc0432ab81a58
BLAKE2b-256 checksum
How to use checksums
9312f77daf22a7632555fc88399567b5b073b03794f0d8d979e12d5757fd96eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / bluecellulab-2.6.112-py3-none-any.whl

Download URL bluecellulab-2.6.112-py3-none-any.whl
Size 244.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9442871db60c3eb8e659df927a2ff4b1b21e609a3ca003d7a515d7d004e851e3
BLAKE2b-256 checksum
How to use checksums
ddbe79afa29629a4786d28653d6b574316920b375680c6cdbaa086b510b260c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for bluecellulab 2.6.112

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.6.112 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page