Blue Brain Python Cell Model Management
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bluepymm
docs
notebook
.coveragerc
.gitignore
.jenkins.sh
.travis.yml
.travis_install_neuron.sh
AUTHORS.txt
LGPL.txt
LICENSE.txt
MANIFEST.in Make code python 3 compatible May 18, 2017
Makefile
README.md
codecov.yml
package.json Modify authors Aug 3, 2018
requirements.txt Add requirements file Sep 21, 2017
setup.cfg Add versioneer Apr 27, 2017
setup.py
tox.ini
versioneer.py

README.md

Build Status codecov Documentation Status

Introduction

When building a network simulation, biophysically detailed electrical models (e-models) need to be tested for every morphology that is possibly used in the circuit.

E-models can e.g. be obtained using BluePyOpt by data-driven model parameter optimisation. Developing e-models can take a lot of time and computing resources. Therefore, these models are not reoptimized for every morphology in the network. Instead we want to test if an existing e-model matches that particular morphology `well enough'.

This process is called Cell Model Management (MM). It takes as input a morphology release, a circuit recipe and a set of e-models with some extra information. Next, it finds all possible (morphology, e-model)-combinations (me-combos) based on e-type, m-type, and layer as described by the circuit recipe, and calculates the scores for every combination. Finally, it writes out the resulting accepted me-combos to a database, and produces a report with information on the number of matches.

Support

We are providing support using a chat channel on Gitter.

Requirements

Installation

pip install bluepymm

NOTES:

  • Make sure you are using the latest version of pip (at least >9.0). Otherwise the ipython dependency will fail to install correctly.
  • Make sure you are using a new version of git (at least >=1.8). Otherwise some exceptions might be raised by the versioneer module.

Quick Start

An IPython notebook with a simple test example can be found in:

https://github.com/BlueBrain/BluePyMM/blob/master/notebook/BluePyMM.ipynb

API documentation

The API documentation can be found on ReadTheDocs.

License

BluePyMM is licensed under the LGPL, unless noted otherwise, e.g., for external dependencies. See file LGPL.txt for the full license.

Funding

This work has been partially funded by the European Union Seventh Framework Programme (FP7/2007-2013) under grant agreement No. 604102 (HBP) and by the European Union’s Horizon 2020 Framework Programme for Research and Innovation under Grant Agreement No. 720270 (Human Brain Project SGA1).