Skip to main content

The Pythonic Blue Brain simulator access

Project description

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

BlueCelluLab is designed to do simulation and experiment on a single cell or a group of cells. Use cases for which bluecellulab is well suited include: scripting and statistics across single or pairs of cells, light-weight detailed reporting on a few state variables post-simulation, development of synaptic plasticity rules, dynamics validations of e.g. synaptic properties, automation of 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 publication (this includes poster presentations):

@article {TBD Zenodo}

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()
stimulus = cell.add_step(start_time=15.0, stop_time=20.0, level=1.5)
sim = Simulation()
sim.add_cell(cell)

sim.run(200, 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.0.3.dev1.tar.gz (13.6 MB view details)

Uploaded Source

Built Distribution

bluecellulab-1.0.3.dev1-py3-none-any.whl (106.2 kB view details)

Uploaded Python 3

File details

Details for the file bluecellulab-1.0.3.dev1.tar.gz.

File metadata

  • Download URL: bluecellulab-1.0.3.dev1.tar.gz
  • Upload date:
  • Size: 13.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0rc1

File hashes

Hashes for bluecellulab-1.0.3.dev1.tar.gz
Algorithm Hash digest
SHA256 3422e9f7d9e341a0cf6c2fda6406eea6ceb36c29ee083fff4279e7546593016f
MD5 386daa8fda377df1e113f61c26ff36d7
BLAKE2b-256 78a2e7808fd7831039f805b08ecb7a95957d9d4324e52a81a365d202158a9171

See more details on using hashes here.

File details

Details for the file bluecellulab-1.0.3.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for bluecellulab-1.0.3.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab68277239e7006af537f2f5e71da03c7dfa411675317396998370cc4e6597a7
MD5 298a21e41d754b657179a54f10f505d7
BLAKE2b-256 e415e32095c3fde7a60a38e22702ea4d88b4709f6ccc92ac6350a985f6350037

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