Skip to main content

`bsb-core` is the backbone package contain the essential code of the BSB: A component

Project description

Code style: black Documentation Status Build Status codecov

:closed_book: Read the documentation on https://bsb.readthedocs.io/en/latest

BSB: A component framework for neural modelling

Developed by the Department of Brain and Behavioral Sciences at the University of Pavia, the BSB is a component framework for neural modelling, which focusses on component declarations to piece together a model. The component declarations can be made in any supported configuration language, or using the library functions in Python. It offers parallel reconstruction and simulation of any network topology, placement and/or connectivity strategy.

Installation

The BSB requires Python 3.9+.

pip

This software can be installed as a Python package from PyPI through pip:

pip install "bsb>=4.0.0b0"

Developers

Developers best use pip's editable install. This creates a live link between the installed package and the local git repository:

 git clone git@github.com:dbbs-lab/bsb-core
 cd bsb
 pip install -e .[dev]
 pre-commit install

Usage

The scaffold framework is best used in a project context. Create a working directory for each of your modelling projects and use the command line to configure, reconstruct or simulate your models.

Creating a project

You can create a quickstart project using:

bsb new my_model --quickstart
cd my_model

Reconstructing a network

You can use your project to create reconstructions of your model, generating cell positions and connections:

bsb compile -p

This creates a network file and plots the network.

Simulating a network

The default project currently contains no simulation config.

Contributing

All contributions are very much welcome. Take a look at the contribution guide

Acknowledgements

This research has received funding from the European Union’s Horizon 2020 Framework Program for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3) and Specific Grant Agreement No. 785907 (Human Brain Project SGA2) and from Centro Fermi project “Local Neuronal Microcircuits” to ED. We acknowledge the use of EBRAINS platform and Fenix Infrastructure resources, which are partially funded from the European Union’s Horizon 2020 research and innovation programme through the ICEI project under the grant agreement No. 800858

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bsb_core-4.0.0b7.tar.gz (167.6 kB view hashes)

Uploaded Source

Built Distribution

bsb_core-4.0.0b7-py3-none-any.whl (196.0 kB view hashes)

Uploaded Python 3

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