Model Management Python Library (bluepymm)
Project description
BluePyMM
Latest Release |
|
Documentation |
|
License |
|
Build Status |
|
Coverage |
|
Citation |
|
Gitter |
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.
Citation
When you use this BluePyMM software for your research, we ask you to cite the following publications (this includes poster presentations):
@article{bluepymm,
title={BluePyMM},
DOI={10.5281/zenodo.8146238},
url={https://doi.org/10.5281/zenodo.8146238}
abstractNote={BluePyMM is a software built to do 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.},
publisher={Zenodo},
author={Van Geit, Werner and
Vanherpe, Liesbeth and
Rössert, Christian and
Gevaert, Michael and
Courcol, Jean-Denis and
King, James Gonzalo and
Jaquier, Aurélien},
year={2023},
month={Jul}
}Support
We are providing support using a chat channel on Gitter.
Requirements
All of the requirements except for Neuron are automatically installed with bluepymm. The decision on how to install Neuron is left to the user.
One simple way of installing Neuron is through pip
pip install NEURONNeuron can also be installed from the source and used by bluepymm provided that it is compiled with Python support.
Installation
pip install bluepymmNOTES:
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 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bluepymm-0.9.11.tar.gz.
File metadata
- Download URL: bluepymm-0.9.11.tar.gz
- Upload date:
- Size: 289.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8514b5ce413c553e0ba6d16138c98a17c534bc7fb0f0c3cdce701a62e44b1d54 |
|
| MD5 | 1e8b3aedfd9acd31bcaa0f8828646fe4 |
|
| BLAKE2b-256 | c2a2079e0ebefdee707cbec34644f54ef03558744a5db6ea874e769c93fe49de |
File details
Details for the file bluepymm-0.9.11-py3-none-any.whl.
File metadata
- Download URL: bluepymm-0.9.11-py3-none-any.whl
- Upload date:
- Size: 298.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dc82bda1beac161aaa97aa1599c672772694dd7b6c1fb6cbc2d97dabae1dc5ea |
|
| MD5 | da2f3a4b2aef5b21fa4d7566bbc307c8 |
|
| BLAKE2b-256 | bf6f93dbe07f87fac837da50748b1908fe837f4b3930479cdd0bf7258a704482 |
