Blue Brain Python Optimisation Library (bluepyopt)

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for bbp.opensource from gravatar.com bbp.opensource Avatar for wvangeit from gravatar.com wvangeit

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (BluePyOpt - Bluebrain Python Optimisation Library BluePyOpt is licensed under the LGPL, unless note...)
  • Author: Blue Brain Project, EPFL
  • Tags optimisation, neuroscience, BlueBrainProject
  • Requires: Python >=3.9
  • Provides-Extra: all, arbor, lfpy, neuroml, scoop, tests
Classifiers

Project description

banner

BluePyOpt

Latest Release

latest release

Documentation

latest documentation

License

license

Build Status

actions build status

Coverage

coverage

Gitter

Join the chat at https://gitter.im/BlueBrain/BluePyOpt

Zenodo

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):

Van Geit W, Gevaert M, Chindemi G, Rössert C, Courcol J, Muller EB, Schürmann F, Segev I and Markram H (2016). BluePyOpt: Leveraging open source software and cloud infrastructure to optimise model parameters in neuroscience. Front. Neuroinform. 10:17. doi: 10.3389/fninf.2016.00017.

@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

Requirements

  • Python 3.9+

  • 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 bluepyopt

Support 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/BlueBrain/BluePyOpt/blob/master/examples/simplecell/simplecell.ipynb (NEURON) https://github.com/BlueBrain/BluePyOpt/blob/master/examples/simplecell/simplecell_arbor.ipynb (Arbor)

landscape_example

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/BlueBrain/BluePyOpt/blob/master/examples/l5pc/L5PC.ipynb (NEURON) https://github.com/BlueBrain/BluePyOpt/blob/master/examples/l5pc/L5PC_arbor.ipynb (Arbor)

Thalamocortical Cells

Scripts for 2 thalamocortical cell types are in this directory

With a notebook:

https://github.com/BlueBrain/BluePyOpt/blob/master/examples/thalamocortical-cell/thalamocortical-cell_opt.ipynb

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/BlueBrain/BluePyOpt/blob/master/examples/tsodyksmarkramstp/tsodyksmarkramstp.ipynb https://github.com/BlueBrain/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/BlueBrain/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/2007­2013) 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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for bbp.opensource from gravatar.com bbp.opensource Avatar for wvangeit from gravatar.com wvangeit

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (BluePyOpt - Bluebrain Python Optimisation Library BluePyOpt is licensed under the LGPL, unless note...)
  • Author: Blue Brain Project, EPFL
  • Tags optimisation, neuroscience, BlueBrainProject
  • Requires: Python >=3.9
  • Provides-Extra: all, arbor, lfpy, neuroml, scoop, tests
Classifiers

Release history Release notifications | RSS feed

This version

1.14.17

1.14.16

1.14.15

1.14.14

1.14.13

1.14.12

1.14.11

1.14.10

1.14.9

1.14.8

1.14.7

1.14.6

1.14.5

1.14.4

1.14.3

1.14.2

1.14.1

1.14.0

1.13.222

1.13.220

1.13.215

1.13.211

1.13.208

1.13.205

1.13.203

1.13.201

1.13.199

1.13.196

1.13.189

1.13.184

1.13.182

1.13.178

1.13.175

1.13.171

1.13.168

1.13.163

1.13.161

1.13.107

1.13.102

1.13.95

1.13.92

1.13.90

1.13.88

1.13.86

1.13.83

1.13.79

1.13.76

1.13.12

1.13.10

1.13.8

1.13.3

1.12.63

1.12.61

1.12.59

1.12.57

1.12.53

1.12.51

1.12.49

1.12.47

1.12.44

1.12.28

1.12.26

1.12.24

1.12.22

1.12.19

1.12.12

1.12.7

1.12.3

1.12.1

1.11.47

1.11.15

1.11.7

1.11.5

1.11.3

1.10.38

1.10.36

1.10.33

1.10.30

1.10.27

1.10.24

1.10.21

1.10.14

1.10.12

1.10.9

1.9.153

1.9.151

1.9.149

1.9.147

1.9.146

1.9.145

1.9.141

1.9.137

1.9.133

1.9.128

1.9.126

1.9.124

1.9.117

1.9.115

1.9.112

1.9.110

1.9.98

1.9.96

1.9.93

1.9.91

1.9.90

1.9.88

1.9.86

1.9.83

1.9.80

1.9.79

1.9.69

1.9.66

1.9.55

1.9.50

1.9.48

1.9.46

1.9.43

1.9.39

1.9.37

1.9.30

1.9.27

1.9.13

1.9.12

1.9.11

1.9.9

1.9.3

1.8.68

1.8.66

1.8.64

1.8.61

1.8.59

1.8.54

1.8.52

1.8.50

1.8.48

1.8.46

1.8.43

1.8.40

1.8.38

1.8.36

1.8.34

1.8.27

1.8.25

1.8.23

1.8.21

1.8.20

1.8.19

1.8.18

1.8.16

1.8.7

1.8.5

1.8.4

1.8.2

1.7.6

1.7.4

1.7

1.6.75

1.6.62

1.6.56

1.6.51

1.6.45

1.6.42

1.6.27

1.6.25

1.6.22

1.6.20

1.6.11

1.6.8

1.6.6

1.6.4

1.6.2

1.5.37

1.5.35

1.5.33

1.5.31

1.5.29

1.5.26

1.5.22

1.5.20

1.5.17

1.5.14

1.5.12

1.5.10

1.5.8

1.5.7

1.5.5

1.5.3

1.5.1

1.2.159

1.2.157

1.2.154

1.2.152

1.2.151

1.2.149

1.2.147

1.2.145

1.2.142

1.2.139

1.2.137

1.2.132

1.2.128

1.2.118

1.2.116

1.2.113

1.2.111

1.2.109

1.2.107

1.2.105

1.2.104

1.2.103

1.2.89

1.2.87

1.2.85

1.2.83

1.2.80

1.2.79

1.2.78

1.2.77

1.2.76

1.2.75

1.2.74

1.2.73

1.2.72

1.2.71

1.2.70

1.2.69

1.2.68

1.2.67

1.2.66

1.2.65

1.2.64

1.2.63

1.2.62

1.2.61

1.2.60

1.2.59

1.2.58

1.2.57

1.2.55

1.2.53

1.2.51

1.2.48

1.2.42

1.2.41

1.2.40

1.2.39

1.2.38

1.2.37

1.2.36

1.2.35

1.2.34

1.2.33

1.2.32

1.2.31

1.2.30

1.2.29

1.2.28

1.2.26

1.2.25

1.2.24

1.2.23

1.2.20

1.2.18

1.2.16

1.2.14

1.2.12

1.2.8

1.2.6

1.2.1

1.1.180

1.1.178

1.1.177

1.1.173

1.1.172

1.1.171

1.1.169

1.1.167

1.1.163

1.1.151

1.1.150

1.1.149

1.1.148

1.1.146

1.1.144

1.1.142

1.1.140

1.1.138

1.1.136

1.1.134

1.1.132

1.1.130

1.1.128

1.1.127

1.1.126

1.1.125

1.1.123

1.1.122

1.1.119

1.1.117

1.1.114

1.1.111

1.1.107

1.1.105

1.1.100

1.1.76

1.1.74

1.1.72

1.1.71

1.1.70

1.1.68

1.1.63

1.1.55

1.1.52

1.1.47

1.1.45

1.1.43

1.1.42

1.1.41

1.1.39

1.1.35

1.1.33

1.1.27

1.1.24

1.1.22

1.1.20

1.1.4

1.1.2

1.0.12

1.0.5

1.0.3

1.0.2

1.0.1

1.0

0.1.230

0.1.98

0.1.97

0.1.96

0.1.91

0.1.84

0.1.82

0.1.80

0.1.78

0.1.76

0.1.75

0.1.73

0.1.72

0.1.69

0.1.64

0.1.62

0.1.60

0.1.58

0.1.56

0.1.54

0.1.48

0.1.45

0.1.43

0.1.40

0.1.38

0.1.36

0.1.35

0.1.34

0.1.33

0.1.32

0.1.31

0.1.30

0.1.29

0.1.28

0.1.27

0.1.26

0.1.25

0.1.23

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

bluepyopt-1.14.17.tar.gz (29.6 MB view details)

Uploaded Source

Built Distribution

bluepyopt-1.14.17-py3-none-any.whl (21.7 MB view details)

Uploaded Python 3

File details

Details for the file bluepyopt-1.14.17.tar.gz.

File metadata

  • Download URL: bluepyopt-1.14.17.tar.gz
  • Upload date:
  • Size: 29.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for bluepyopt-1.14.17.tar.gz
Algorithm Hash digest
SHA256 4b1b2fcaa4705dcdc40a52f381024baca49ce66f7d0fd2add51b948b6cd98f1f
MD5 eaa8fecc3e10ae8f4b6a97ad504920c4
BLAKE2b-256 db1e8026e4bc5906814d2b2a0457e8ea267524be9b526bb5b04a27f0d8a791a7

See more details on using hashes here.

File details

Details for the file bluepyopt-1.14.17-py3-none-any.whl.

File metadata

  • Download URL: bluepyopt-1.14.17-py3-none-any.whl
  • Upload date:
  • Size: 21.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for bluepyopt-1.14.17-py3-none-any.whl
Algorithm Hash digest
SHA256 a94fe300ffaeda6ad2cd50e973e7bafdfc3930f92a95055444243c8cb30dc2a9
MD5 d04c7653f1a354f7c58a544a8bb075ed
BLAKE2b-256 0b38c36b032e0f197f15134d71f1c57d8f5a33f5bf3c24cba961a415b4c79936

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