• Stars
    star
    196
  • Rank 198,553 (Top 4 %)
  • Language
    Python
  • License
    Other
  • Created almost 9 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Blue Brain Python Optimisation Library

banner

BluePyOpt

Latest Release latest release
Documentation latest documentation
License license
Build Status Actions build status
Coverage coverage
Gitter

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.8+
  • 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-2022 Blue Brain Project/EPFL

More Repositories

1

HighFive

HighFive - Header-only C++ HDF5 interface
C++
675
star
2

Brayns

Visualizer for large-scale and interactive ray-tracing of neurons
C++
284
star
3

nexus

Blue Brain Nexus - A knowledge graph for data-driven science
Scala
269
star
4

CoreNeuron

Simulator optimized for large scale neural network simulations.
C++
135
star
5

NeuroMorphoVis

A lightweight, interactive, extensible and cross-platform framework for building, visualizing and analyzing digital reconstructions of neuronal morphology skeletons extracted from microscopy stacks.
Python
126
star
6

NeuroM

Neuronal Morphology Analysis Tool
Python
102
star
7

eFEL

Electrophys Feature Extraction Library
Python
63
star
8

BioExplorer

The Blue Brain BioExplorer (BBBE) is a tool for data visualization experts and scientists to extract and analyze scientific data from visualization and interactive exploration
C++
61
star
9

nmodl

Code Generation Framework For NEURON MODeling Language
C++
55
star
10

Tide

Tiled Interactive Display Environment
C++
47
star
11

MOOC-neurons-and-synapses-2017

Reference data for the "Simulation Neuroscience:Neurons and Synapses" Massive Online Open Course
Jupyter Notebook
43
star
12

Search

Blue Brain text mining toolbox for semantic search and structured information extraction
Python
40
star
13

Rockets

REST and websockets C++ library
C++
39
star
14

nexus-forge

Building and Using Knowledge Graphs made easy
Python
38
star
15

NeuroTS

Topological Neuron Synthesis
Python
36
star
16

VessMorphoVis

A lightweight, interactive, extensible and cross-platform framework for building, visualizing and analyzing vasculature (or blood vessels) morphologies.
Python
35
star
17

BlueGraph

Python framework for graph analytics and co-occurrence analysis
Python
31
star
18

Livre

Large-scale Interactive Volume Rendering Engine
C++
31
star
19

RTNeuron

Interactive visualization framework for geometrically detailed neuron simulations
C++
30
star
20

TMD

A python package for the topological analysis of neurons.
Python
28
star
21

MorphIO

A python and C++ library for reading and writing neuronal morphologies
C++
26
star
22

SimulationTutorials

Public tutorials around electrophysiological simulations
Jupyter Notebook
26
star
23

Ultraliser

Reconstruction of watertight meshes, annotated volumes and center line skeletons of neuroscience spatial structures from non-watertight inputs, segmented masks, skeletons of NGV morphologies and volumes.
C++
26
star
24

bluima

Natural Language Processing Toolkit for Neuroscience
Java
24
star
25

Brion

Blue Brain C++ File IO Library
C++
23
star
26

Deflect

C++ library for building applications to stream pixels to Tide
C++
21
star
27

bbp-nixpkgs

Blue Brain Project nixpkgs configuration - Build a brain with Nix
Nix
19
star
28

snap

The Blue Brain Pythonic Simulation and Network Analysis Productivity layer
Python
17
star
29

Atlas-Download-Tools

Search, download, and prepare brain atlas data.
Python
17
star
30

nexus-web

Nexus Web is the interface of Blue Brain Nexus
TypeScript
16
star
31

nexus-kg

Nexus KnowledgeGraph Service
Scala
16
star
32

neurocurator

Desktop application (GUI) to perform systematic and collaborative curation of neuroscientific literature.
Python
15
star
33

osgTransparency

OSG render bins for transparent geometry
C
14
star
34

BluePyEfe

BluePyEfe: Blue Brain Python E-feature extraction
Python
14
star
35

EModelRunner

Runs cells from stand-alone packages.
Python
14
star
36

BlueCelluLab

Biologically detailed neural network simulations and analysis API
Python
12
star
37

BluePyMM

Blue Brain Python Cell Model Management
Python
12
star
38

cyme

Framework to facilitate SIMD programming, without any tedious SIMD intrinsics.
C++
12
star
39

libsonata

A python and C++ interface to the SONATA format
C++
11
star
40

atlas-alignment

Blue Brain multi-modal registration and alignment toolbox
Python
11
star
41

dash

Data Access and Sharing
C++
10
star
42

Long-range-micro-connectome

BlueBrain's recipe writer to parameterize structure and logic of a mouse whole-neocortex connectome
Python
10
star
43

nexus-js

A set of JavaScript libraries built on top of Nexus
TypeScript
10
star
44

bluebrain.github.com

API documentation for BlueBrain projects:
HTML
10
star
45

nexus-bbp-domains

BBP domains specification (schemas, vocabularies)
Scala
9
star
46

NeuroR

A collection of tools to repair morphologies
Python
9
star
47

neurodamus

A BBP Simulation Control application for NEURON
Python
8
star
48

singlecell-emodel-suite

8
star
49

luigi-tools

Extra tools to work with the Luigi library
Python
8
star
50

learning_musculoskeletal_arm_control

This repository contains the source code of the paper titled "Optimum trajectory learning in musculoskeletal systems with model predictive control and deep reinforcement learning".
Python
8
star
51

AstroVascPy

Vasculature blood flow computation and impact of astrocytic endfeet on vessels
Python
8
star
52

MOOC-hippocampus-network-simulation-2019

Jupyter Notebook
8
star
53

morphoclass

Neuronal morphology preparation and classification using Machine Learning.
Python
7
star
54

nat

Python module to use the annotations created with NeuroCurator, for example in a Jupyter notebook.
Jupyter Notebook
7
star
55

morph-tool

Python
7
star
56

spack-packages

Repository of spack external packages
Python
7
star
57

hpc-coding-conventions

Python
7
star
58

Pydoxine

Python docstring generation for C++ projects using boost::python
Python
7
star
59

data-validation-framework

Simple framework to create data validation workflows.
Python
7
star
60

SSCxEModelExamples

Jupyter Notebook
7
star
61

nexus-prov

SHACL shapes for W3C PROV-O
Scala
7
star
62

Currentscape

Currentscape is a Python tool enabling scientists to easily plot the currents in electrical neuron models. The code is based on the paper Alonso and Marder, 2019.
Python
7
star
63

nexus-search-webapp

The Searchable Knowledge-Graph Application
JavaScript
6
star
64

nexus-python-sdk

A Python API to interface with Nexus REST API
Python
6
star
65

voxcell

Tools to work with voxel based brain atlases.
Python
5
star
66

bluepyentity

Manage entities within the knowledge graph
Jupyter Notebook
5
star
67

blueetl

Multiple simulations analysis tool
Python
5
star
68

nexus-iam

Nexus IAM Service
Scala
5
star
69

Deep-Atlas

Python
5
star
70

dir-content-diff

Simple tool to compare directory contents and get differences using smart comparators.
Python
5
star
71

ConnectomeUtilities

Connectome Utilities
Python
5
star
72

me-features-to-mo-ID-mapping

Python
4
star
73

Monsteer

Interactive Supercomputing Tools and Library
C++
4
star
74

BluePyEModel

Blue Brain Python Electrical Modeling Pipeline
Python
4
star
75

hippocampus-workshop

Jupyter Notebook
4
star
76

morphology-suite

4
star
77

BlueNaaS-Subcellular

A web environment for the simulation of brain molecular networks.
Vue
4
star
78

atlas-annotation

Align and improve brain annotation atlases
Python
4
star
79

morphology-workflows

Workflows used for morphology processing.
Python
4
star
80

basalt

C++11 Graph Storage library
C++
4
star
81

sphinx-bluebrain-theme

The Blue Brain Project's documentation theme.
HTML
4
star
82

codash

Collage-based distribution of DASH entities
C++
4
star
83

neuromapp

The neuromapp library reproduces the algorithms of the main software of the BBP as a collection of mini-apps
C++
4
star
84

EMSim

EMSim is a library that compute different electro-magnetic effects like LPF and VSD.
C++
3
star
85

atlas-direction-vectors

Tools to compute direction vectors in the context of brain atlases.
Python
3
star
86

nexus-service

Building blocks commonly used in Nexus services
Scala
3
star
87

emodel-generalisation

Generalisation of electrical models of neurons with MCMC
Python
3
star
88

morphology-documentation

Morphology Specifications used at BBP
Makefile
3
star
89

RenderingResourceManager

A Python based service managing rendering resources for visualization web services
Python
3
star
90

nexus-cli

A Command Line Interface (CLI) for Nexus
Python
3
star
91

sbt-nexus

An SBT Plugin for building Nexus Scala based projects
Scala
3
star
92

DMT

Python
3
star
93

atlas-densities

Tools to compute densities in the context of brain atlases.
Python
3
star
94

git-cmake-format

CMake
3
star
95

diameter-synthesis

Synthesize diameters of neuronal morphologies
Python
3
star
96

mod2c

Converter for mod files to C code
C
3
star
97

neurox

A parallel & distributed asynchronous simulator of extended Hodgkin-Huxley neuron models
C++
3
star
98

neuroagent

LLM agent made to communicate with different neuroscience related tools
Python
3
star
99

me-types-mapper

Python
2
star
100

bluima_resources

Resource files for bluima
2
star