1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
%global _empty_manifest_terminate_build 0
Name: python-bsb
Version: 3.10.5
Release: 1
Summary: A package for modelling morphologically detailed neuronal microcircuits.
License: GPLv3
URL: https://github.com/dbbs-lab/bsb
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/92/24/d3e18dd8cb90e7d3666df368268ba25d0e548e51f2fdb536358ed2a322fb/bsb-3.10.5.tar.gz
BuildArch: noarch
Requires: python3-h5py
Requires: python3-numpy
Requires: python3-scipy
Requires: python3-scikit-learn
Requires: python3-plotly
Requires: python3-colour
Requires: python3-errr
Requires: python3-rtree
Requires: python3-psutil
Requires: python3-sphinx
Requires: python3-furo
Requires: python3-pre-commit
Requires: python3-black
Requires: python3-nrn-subprocess
Requires: python3-mpi4py
Requires: python3-dbbs-models
Requires: python3-nrn-patch
%description
[](https://github.com/psf/black)
[](https://bsb.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.com/dbbs-lab/bsb)
[](https://codecov.io/gh/dbbs-lab/bsb)
**Note:** The scaffold framework is still under heavy development. Please check the
**_Known Issues_** section at the bottom for important issues that fell victim to our
deadlines and will be solved at a later date.
# BSB: A scaffold modelling framework
This package is intended to facilitate spatially, topologically and morphologically
detailed simulations of brain regions developed by the Department of Brain and
Behavioral Sciences at the University of Pavia.
## Installation
### pip
This software can be installed as a Python package from PyPI through pip:
```
pip install bsb
```
### 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
cd bsb
pip install -e .[dev]
pre-commit install
```
## Usage
The scaffold framework can be used through the command line interface or as a python package.
### Command line interface (CLI)
Run the framework in the command line with subcommand `compile` to compile a network
architecture.
```
bsb --config=mouse_cerebellum_cortex_noTouch.json compile -x=200 -z=200 -p
```
To run with different configurations, change the config argument to the relative path of a
.json config file. The `-p` flag indicates that the compiled network should be plotted
afterwards and can be omitted.
### Python package
The central object is the `bsb.core.Scaffold` class. This object requires a
`bsb.config.ScaffoldConfig` instance for its construction. To emulate the CLI
functionality you can use the `JSONConfig` class and provide the relative path to the
configuration file.
```python
from bsb import Scaffold
from bsb.config import JSONConfig
config = new JSONConfig(file='mouse_cerebellum_cortex_noTouch.json')
scaffoldInstance = new Scaffold(config)
```
This scaffold instance can then be used to perform the subcommands available in the CLI by
calling their corresponding functions:
```python
scaffoldInstance.compile_network()
```
#### Plotting network architecture
After calling `compile_network` the scaffold instance can be plotted:
```python
scaffoldInstance.plot_network_cache()
```
# Contributing
All contributions are very much welcome.
Take a look at the [contribution guide](CONTRIBUTING.md)
# Known issues
## No configuration serialization
When modifying the config object through scripts and then saving it to file, you'll store
the original configuration file text, and you won't actually serialize the modified object
We will fix this by version 4.0
## If MPI is installed but mpi4py is not undefined behavior may occur
The amount of NEST virtual processes is determined by using mpi4py to get the amount of
MPI processes. But if the package is not installed it is assumed no MPI simulations will
be ran and the amount of virtual processes might be lower than expected when used in
combination with OpenMP. Be sure to `pip install` using the `[MPI]` requirement tag.
%package -n python3-bsb
Summary: A package for modelling morphologically detailed neuronal microcircuits.
Provides: python-bsb
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-bsb
[](https://github.com/psf/black)
[](https://bsb.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.com/dbbs-lab/bsb)
[](https://codecov.io/gh/dbbs-lab/bsb)
**Note:** The scaffold framework is still under heavy development. Please check the
**_Known Issues_** section at the bottom for important issues that fell victim to our
deadlines and will be solved at a later date.
# BSB: A scaffold modelling framework
This package is intended to facilitate spatially, topologically and morphologically
detailed simulations of brain regions developed by the Department of Brain and
Behavioral Sciences at the University of Pavia.
## Installation
### pip
This software can be installed as a Python package from PyPI through pip:
```
pip install bsb
```
### 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
cd bsb
pip install -e .[dev]
pre-commit install
```
## Usage
The scaffold framework can be used through the command line interface or as a python package.
### Command line interface (CLI)
Run the framework in the command line with subcommand `compile` to compile a network
architecture.
```
bsb --config=mouse_cerebellum_cortex_noTouch.json compile -x=200 -z=200 -p
```
To run with different configurations, change the config argument to the relative path of a
.json config file. The `-p` flag indicates that the compiled network should be plotted
afterwards and can be omitted.
### Python package
The central object is the `bsb.core.Scaffold` class. This object requires a
`bsb.config.ScaffoldConfig` instance for its construction. To emulate the CLI
functionality you can use the `JSONConfig` class and provide the relative path to the
configuration file.
```python
from bsb import Scaffold
from bsb.config import JSONConfig
config = new JSONConfig(file='mouse_cerebellum_cortex_noTouch.json')
scaffoldInstance = new Scaffold(config)
```
This scaffold instance can then be used to perform the subcommands available in the CLI by
calling their corresponding functions:
```python
scaffoldInstance.compile_network()
```
#### Plotting network architecture
After calling `compile_network` the scaffold instance can be plotted:
```python
scaffoldInstance.plot_network_cache()
```
# Contributing
All contributions are very much welcome.
Take a look at the [contribution guide](CONTRIBUTING.md)
# Known issues
## No configuration serialization
When modifying the config object through scripts and then saving it to file, you'll store
the original configuration file text, and you won't actually serialize the modified object
We will fix this by version 4.0
## If MPI is installed but mpi4py is not undefined behavior may occur
The amount of NEST virtual processes is determined by using mpi4py to get the amount of
MPI processes. But if the package is not installed it is assumed no MPI simulations will
be ran and the amount of virtual processes might be lower than expected when used in
combination with OpenMP. Be sure to `pip install` using the `[MPI]` requirement tag.
%package help
Summary: Development documents and examples for bsb
Provides: python3-bsb-doc
%description help
[](https://github.com/psf/black)
[](https://bsb.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.com/dbbs-lab/bsb)
[](https://codecov.io/gh/dbbs-lab/bsb)
**Note:** The scaffold framework is still under heavy development. Please check the
**_Known Issues_** section at the bottom for important issues that fell victim to our
deadlines and will be solved at a later date.
# BSB: A scaffold modelling framework
This package is intended to facilitate spatially, topologically and morphologically
detailed simulations of brain regions developed by the Department of Brain and
Behavioral Sciences at the University of Pavia.
## Installation
### pip
This software can be installed as a Python package from PyPI through pip:
```
pip install bsb
```
### 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
cd bsb
pip install -e .[dev]
pre-commit install
```
## Usage
The scaffold framework can be used through the command line interface or as a python package.
### Command line interface (CLI)
Run the framework in the command line with subcommand `compile` to compile a network
architecture.
```
bsb --config=mouse_cerebellum_cortex_noTouch.json compile -x=200 -z=200 -p
```
To run with different configurations, change the config argument to the relative path of a
.json config file. The `-p` flag indicates that the compiled network should be plotted
afterwards and can be omitted.
### Python package
The central object is the `bsb.core.Scaffold` class. This object requires a
`bsb.config.ScaffoldConfig` instance for its construction. To emulate the CLI
functionality you can use the `JSONConfig` class and provide the relative path to the
configuration file.
```python
from bsb import Scaffold
from bsb.config import JSONConfig
config = new JSONConfig(file='mouse_cerebellum_cortex_noTouch.json')
scaffoldInstance = new Scaffold(config)
```
This scaffold instance can then be used to perform the subcommands available in the CLI by
calling their corresponding functions:
```python
scaffoldInstance.compile_network()
```
#### Plotting network architecture
After calling `compile_network` the scaffold instance can be plotted:
```python
scaffoldInstance.plot_network_cache()
```
# Contributing
All contributions are very much welcome.
Take a look at the [contribution guide](CONTRIBUTING.md)
# Known issues
## No configuration serialization
When modifying the config object through scripts and then saving it to file, you'll store
the original configuration file text, and you won't actually serialize the modified object
We will fix this by version 4.0
## If MPI is installed but mpi4py is not undefined behavior may occur
The amount of NEST virtual processes is determined by using mpi4py to get the amount of
MPI processes. But if the package is not installed it is assumed no MPI simulations will
be ran and the amount of virtual processes might be lower than expected when used in
combination with OpenMP. Be sure to `pip install` using the `[MPI]` requirement tag.
%prep
%autosetup -n bsb-3.10.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-bsb -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 3.10.5-1
- Package Spec generated
|
