Biologically detailed neural network simulations and analysis.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for anilbey from gravatar.com anilbey Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for ikilic from gravatar.com ikilic

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache2.0)
  • Author: Blue Brain Project, EPFL
  • Tags computational neuroscience, simulation, analysis, SONATA, neural networks, neuron, Blue Brain Project
  • Requires: Python >=3.8
Classifiers

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       = {Tuncel, Anil and Van Geit, Werner and Gevaert, Mike and Torben-Nielsen, Benjamin and Mandge, Darshan and Kilic, Ilkan and Jaquier, Aurélien and Muller, Eilif and Kanari, Lida and Markram, Henry},
  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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for anilbey from gravatar.com anilbey Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for ikilic from gravatar.com ikilic

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache2.0)
  • Author: Blue Brain Project, EPFL
  • Tags computational neuroscience, simulation, analysis, SONATA, neural networks, neuron, Blue Brain Project
  • Requires: Python >=3.8
Classifiers

Release history Release notifications | RSS feed

2.6.36

2.6.35

2.6.34

2.6.33

2.6.32

2.6.31

This version

2.6.30

2.6.29

2.6.28

2.6.26

2.6.23

2.6.22

2.6.21

2.6.20

2.6.19

2.6.18

2.6.17

2.6.16

2.6.15

2.6.14

2.6.13

2.6.12

2.6.11

2.6.10

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.11

2.5.10

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.0

2.4.1

2.4.0

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.0

2.0.3

2.0.2

2.0.1

2.0.0

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.3

1.5.2

1.5.1

1.5.0

1.4.1

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.3.dev1 pre-release

1.0.2

1.0.1

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

Uploaded Source

Built Distribution

bluecellulab-2.6.30-py3-none-any.whl (120.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bluecellulab-2.6.30.tar.gz
Algorithm Hash digest
SHA256 1848e1166eb349d3452444db55aeaae1fbb548da47580de3900f825d287ac60c
MD5 a2c488a773ebe089b08516a3f203e0db
BLAKE2b-256 6a09ebe49ac7adc9fc4847b0d89a95dc8f1b29a2b8b24610dfd566731b3cbd30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bluecellulab-2.6.30-py3-none-any.whl
Algorithm Hash digest
SHA256 38c4572f6f7f6fe418da847dabce3319056ff7e18f50ec6db49ab3372a0ba194
MD5 31b4d9856b44a28fd2522a5905ecec22
BLAKE2b-256 28de99221a3902f5cc81911606defd060134cf76a92838b348cdb61b5e3784d8

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