bsb 4.2.0__py3-none-any.whl → 4.3.1__py3-none-any.whl

{bsb-4.2.0.dist-info → bsb-4.3.1.dist-info}/METADATA

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: bsb
-Version: 4.2.0
+Version: 4.3.1
 Summary: Black-box component framework for multiscale neural modeling
-Author-email: Robin De Schepper <robingilbert.deschepper@unipv.it>
+Author: Robin De Schepper
+Maintainer-email: Dimitri Rodarie <dimitri.rodarie@unipv.it>
 License: GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
         
@@ -678,23 +679,146 @@ License: GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
         
+Project-URL: Home, https://github.com/dbbs-lab/bsb
+Project-URL: Documentation, https://bsb.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/dbbs-lab/bsb/issues/
+Project-URL: Source Code, https://github.com/dbbs-lab/bsb/
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: bsb-core ==4.2
-Requires-Dist: bsb-json ==4.1.0
-Requires-Dist: bsb-yaml ==4.1.0
-Requires-Dist: bsb-hdf5 ==4.0.0
+Requires-Dist: bsb-core ~=4.5.3
+Requires-Dist: bsb-json ~=4.2.1
+Requires-Dist: bsb-yaml ~=4.2.1
+Requires-Dist: bsb-hdf5 ~=4.1.1
 Provides-Extra: arbor
-Requires-Dist: bsb-arbor ==4.0.0 ; extra == 'arbor'
+Requires-Dist: bsb-arbor ==4.1.0 ; extra == 'arbor'
 Provides-Extra: nest
-Requires-Dist: bsb-nest ==4.1.0 ; extra == 'nest'
+Requires-Dist: bsb-nest ==4.3.1 ; extra == 'nest'
 Provides-Extra: neuron
-Requires-Dist: bsb-neuron ==4.0.2 ; extra == 'neuron'
+Requires-Dist: bsb-neuron ==4.0.3 ; extra == 'neuron'
 Provides-Extra: parallel
 Requires-Dist: bsb-core[parallel] ; extra == 'parallel'
-Provides-Extra: plot
-Requires-Dist: bsb-plotting ==0.0.0b0 ; extra == 'plot'
 
-# bsb
-Metadata repository for the `bsb` package, which installs the `bsb-core` framework and a default set of plugins.
+[![Build Status](https://github.com/dbbs-lab/bsb/actions/workflows/main.yml/badge.svg)](https://github.com/dbbs-lab/bsb/actions/workflows/main.yml)
+# Brain Scaffold Builder suite
+Developed by the Department of Brain and Behavioral Sciences at the University of Pavia, 
+the Brain Scaffold Builder (BSB) is a component framework for neural modelling, which focuses on component 
+declarations to piece together a brain 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.
+
+BSB is decomposed into several repositories:
+- [bsb-core](#bsb-core) — Install the bsb framework. Core component of the `bsb` suite.
+- [bsb-hdf5](#bsb-hdf5) — Leverage the hdf5 file format to save the models.
+- [bsb-json](#bsb-json) — Read and write configuration files in json format. 
+- [bsb-yaml](#bsb-yaml) — Read and write configuration files in yaml format
+- [bsb-nest](#bsb-nest) — Simulate brain models as point-neuron networks with the NEST simulator.
+- [bsb-neuron](#bsb-neuron) — Simulate brain models as detailed neuron networks with the NEURON simulator.
+- [bsb-arbor](#bsb-arbor) — Simulate brain models as detailed neuron networks with the ARBOR simulator.
+
+## Installation
+This repository contains the metadata for the `bsb` package.
+It is highly recommended that you create a python environment before installing the `bsb` package.
+BSB currently supports python 3.9, 3.10 and 3.11.
+With the `bsb` package will be installed the
+[bsb-core](#bsb-core) framework and the following default set of plugins:
+- [bsb-hdf5](#bsb-hdf5)
+- [bsb-json](#bsb-json)
+- [bsb-yaml](#bsb-yaml)
+
+You can install these python libraries with the following command:
+```shell
+pip install bsb
+```
+Check also the following sections to install the other bsb plugin.
+
+## BSB repositories
+### bsb-core
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-core),
+
+This project contains the main `bsb` framework and is needed by all the other repositories.
+It also contains tools to support parallel execution with MPI. To install this support, run the following command:
+```shell
+pip install bsb[parallel]
+```
+
+### bsb-hdf5
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-hdf5).
+
+This project allows the user to save their model into the hdf5 file format. 
+This plugin is installed by default with the `bsb` package.
+
+### bsb-json
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-json).
+
+This project allows the user to write their model configuration in the json file format. 
+This plugin is installed by default with the `bsb` package.
+
+### bsb-yaml
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-yaml).
+
+This project allows the user to write their model configuration in the yaml file format. 
+This plugin is installed by default with the `bsb` package.
+
+### bsb-nest
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-nest).
+
+This project allows the user to simulate their brain model as point-neuron networks with the 
+[NEST simulator](https://www.nest-simulator.org/).
+This plugin is not installed by default with the `bsb` package. To install it, you can run the following command:
+
+```shell
+pip install bsb[nest]
+```
+> [!WARNING]
+> The NEST simulator is not installed with the bsb-nest package and should be installed separately.
+
+### bsb-neuron
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-neuron).
+
+This project allows the user to simulate their brain model as detailed neural circuits with the 
+[NEURON simulator](https://www.neuron.yale.edu/neuron/).
+This plugin is not installed by default with the `bsb` package. To install it, you can run the following command:
+```shell
+pip install bsb[neuron]
+```
+
+### bsb-arbor
+
+Useful links:
+[GitHub repo](https://github.com/dbbs-lab/bsb-arbor).
+
+This project allows the user to simulate their brain model as detailed neural circuits with the 
+[ARBOR simulator](https://arbor-sim.org/).
+This plugin is not installed by default with the `bsb` package. To install it, you can run the following command:
+```shell
+pip install bsb[arbor]
+```
+
+## Running bsb reconstructions and simulations
+Check BSB [Documentation](https://bsb.readthedocs.io/en/latest).
+
+## 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

bsb-4.3.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+bsb-4.3.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+bsb-4.3.1.dist-info/METADATA,sha256=_C1vm7GLkQrSsK02FE74BbIoNshY9wQfAR1RD2i5vag,46508
+bsb-4.3.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+bsb-4.3.1.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+bsb-4.3.1.dist-info/RECORD,,

{bsb-4.2.0.dist-info → bsb-4.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (75.5.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

bsb-4.2.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-bsb-4.2.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-bsb-4.2.0.dist-info/METADATA,sha256=XEYeQI-wwezaCBkgMM9S1b8buzbqnwIZmXcAKpvfIC8,41490
-bsb-4.2.0.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-bsb-4.2.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-bsb-4.2.0.dist-info/RECORD,,