BluePyOpt
Latest Release |
|
Documentation |
|
License |
|
Build Status |
|
Coverage |
|
Gitter |
|
Zenodo |
Introduction
The Blue Brain Python Optimisation Library (BluePyOpt) is an extensible framework for data-driven model parameter optimisation that wraps and standardises several existing open-source tools.
It simplifies the task of creating and sharing these optimisations, and the associated techniques and knowledge. This is achieved by abstracting the optimisation and evaluation tasks into various reusable and flexible discrete elements according to established best-practices.
Further, BluePyOpt provides methods for setting up both small- and large-scale optimisations on a variety of platforms, ranging from laptops to Linux clusters and cloud-based compute infrastructures.
Citation
When you use the BluePyOpt software or method for your research, we ask you to cite the following publication (this includes poster presentations):
@ARTICLE{bluepyopt,
AUTHOR={Van Geit, Werner and Gevaert, Michael and Chindemi, Giuseppe and Rössert, Christian and Courcol, Jean-Denis and Muller, Eilif Benjamin and Schürmann, Felix and Segev, Idan and Markram, Henry},
TITLE={BluePyOpt: Leveraging open source software and cloud infrastructure to optimise model parameters in neuroscience},
JOURNAL={Frontiers in Neuroinformatics},
VOLUME={10},
YEAR={2016},
NUMBER={17},
URL={http://www.frontiersin.org/neuroinformatics/10.3389/fninf.2016.00017/abstract},
DOI={10.3389/fninf.2016.00017},
ISSN={1662-5196}
}Publications that use or mention BluePyOpt
The list of publications that use or mention BluePyOpt can be found on the github wiki page.
Support
We are providing support using a chat channel on Gitter, or the Github discussion page.
News
2023/01: BluePyOpt now supports the Arbor simulator.
2022/12: Support for LFPy models merged into master. Examples and preprint: https://github.com/alejoe91/multimodalfitting, https://www.biorxiv.org/content/10.1101/2022.08.03.502468v1.full
2022/12: BluePyOpt now has the ability to write out NeuroML files: https://github.com/openbraininstitute/BluePyOpt/tree/master/bluepyopt/neuroml
2021/08/30: BluePyOpt dropped Python 2.7 support.
2017/01/04: BluePyOpt is now considered compatible with Python 3.6+.
2016/11/10: BluePyOpt now supports NEURON point processes. This means we can fit parameters of Adex/GIF/Izhikevich models, and also synapse models.
2016/06/14: Started a wiki: https://github.com/openbraininstitute/BluePyOpt/wiki
2016/06/07: The BluePyOpt paper was published in Frontiers in Neuroinformatics (for link, see above)
2016/05/03: The API documentation was moved to ReadTheDocs
2016/04/20: BluePyOpt now contains the code of the IBEA selector, no need to install a BBP-specific version of DEAP anymore
2016/03/24: Released version 1.0
Requirements
Pip (installed by default in newer versions of Python)
Neuron 7.4+ (compiled with Python support)
eFEL eFeature Extraction Library (automatically installed by pip)
Numpy (automatically installed by pip)
Pandas (automatically installed by pip)
The instruction below are written assuming you have access to a command shell on Linux / UNIX / MacOSX / Cygwin
Installation
If you want to use the ephys module of BluePyOpt, you first need to install NEURON with Python support on your machine.
And then bluepyopt itself:
pip install bluepyoptSupport for simulators other than NEURON is optional and not installed by default. If you want to use [Arbor](https://arbor-sim.org/) to run your models, use the following line instead to install bluepyopt.
pip install bluepyopt[arbor]Cloud infrastructure
We provide instructions on how to set up an optimisation environment on cloud infrastructure or cluster computers here
Quick Start
Single compartmental model
An iPython notebook with an introductory optimisation of a one compartmental model with 2 HH channels can be found at
https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/simplecell/simplecell.ipynb (NEURON) https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/simplecell/simplecell_arbor.ipynb (Arbor)
Figure: The solution space of a single compartmental model with two parameters: the maximal conductance of Na and K ion channels. The color represents how well the model fits two objectives: when injected with two different currents, the model has to fire 1 and 4 action potential respectively during the stimuli. Dark blue is the best fitness. The blue circles represent solutions with a perfect score.
Neocortical Layer 5 Pyramidal Cell
Scripts for a more complex neocortical L5PC are in this directory
With a notebook:
https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/l5pc/L5PC.ipynb (NEURON) https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/l5pc/L5PC_arbor.ipynb (Arbor)
Thalamocortical Cells
Scripts for 2 thalamocortical cell types are in this directory
With a notebook:
Tsodyks-Markram Model of Short-Term Plasticity
Scripts for 2 version of fitting the Tsodyks-Markram model to synaptic traces are in this directory
With 2 notebooks:
https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/tsodyksmarkramstp/tsodyksmarkramstp.ipynb https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/tsodyksmarkramstp/tsodyksmarkramstp_multiplefreqs.ipynb
Exporting cell in neuroml format
An iPython notebook showing how to export a BluePyOpt cell in the neuroml format, how to create a LEMS simulation, and how to run the LEMS simulation with the neuroml cell can be found at:
https://github.com/openbraininstitute/BluePyOpt/blob/master/examples/neuroml/neuroml.ipynb
API documentation
The API documentation can be found on ReadTheDocs.
Funding
This work has been partially funded by the European Union Seventh Framework Program (FP7/20072013) under grant agreement no. 604102 (HBP), the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 720270, 785907 (Human Brain Project SGA1/SGA2) and by the EBRAINS research infrastructure, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3). This project/research was 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.
Copyright (c) 2016-2024 Blue Brain Project/EPFL
Copyright (c) 2025 Open Brain Institute
4 maintainers
Release files for bluepyopt 1.14.25
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bluepyopt-1.14.25.tar.gz | 29.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bluepyopt-1.14.25-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 51.3 MB
Release files / bluepyopt-1.14.25.tar.gz
| Download URL | bluepyopt-1.14.25.tar.gz |
|---|---|
| Size | 29.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f0b507d054e0885802e7097d7269b90d1ad333b8336bfbb04cd5d5d9c308f3f1
|
|
BLAKE2b-256 checksum How to use checksums |
d22ce1cf7581b4302223ec3fa329daca546ab4b4bc797a906247b000ca9b0eec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency logRelease files / bluepyopt-1.14.25-py3-none-any.whl
| Download URL | bluepyopt-1.14.25-py3-none-any.whl |
|---|---|
| Size | 21.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f967e7845e712054f6367727a380d5377ab87138693053381434f79c1fa79b90
|
|
BLAKE2b-256 checksum How to use checksums |
e652c77ff1dfeeb5ce1eb27fceb704ff5576e9a95a11a54e85ceb82e1b0c9223
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency log
