Skip to content

Commit 818de95

Browse files
authored
fix: CLI bsb simulate command (#909)
* fix: BSB simulate output flag. Update acknowledgements * docs: update bsb simulate command docs * fix: readthedocs config
1 parent ef8faeb commit 818de95

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed

.readthedocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
version: 2
22

3+
sphinx:
4+
# Path to your Sphinx configuration file.
5+
configuration: docs/conf.py
6+
37
build:
48
os: ubuntu-22.04
59
tools:

README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,16 @@ Take a look at the [contribution guide](CONTRIBUTING.md)
9898
This research has received funding from the European Union’s Horizon 2020 Framework
9999
Program for Research and Innovation under the Specific Grant Agreement No. 945539
100100
(Human Brain Project SGA3) and Specific Grant Agreement No. 785907 (Human Brain
101-
Project SGA2) and from Centro Fermi project “Local Neuronal Microcircuits” to ED. We
102-
acknowledge the use of EBRAINS platform and Fenix Infrastructure resources, which are
101+
Project SGA2) and from Centro Fermi project “Local Neuronal Microcircuits” to ED.
102+
The project is also receiving funding from the Virtual Brain Twin Project under the
103+
European Union's Research and Innovation Program Horizon Europe under grant agreement
104+
No 101137289.
105+
106+
We acknowledge the use of EBRAINS platform and Fenix Infrastructure resources, which are
103107
partially funded from the European Union’s Horizon 2020 research and innovation
104-
programme through the ICEI project under the grant agreement No. 800858
108+
programme under the Specific Grant Agreement No. 101147319 (EBRAINS 2.0 Project) and
109+
through the ICEI project under the grant agreement No. 800858 respectively.
110+
111+
## Supported by
112+
113+
[![JetBrains logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)

bsb/cli/commands/_commands.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def handler(self, context):
207207
for name, sim in extra_simulations.items():
208208
if name not in network.simulations and name == sim_name:
209209
network.simulations[sim_name] = sim
210-
root = pathlib.Path(getattr(context.arguments, "output-folder", "./"))
210+
root = pathlib.Path(getattr(context.arguments, "output_folder", "./"))
211211
if not root.is_dir() or not os.access(root, os.W_OK):
212212
return report(
213213
f"Output provided '{root.absolute()}' is not an existing directory with write access.",

docs/cli/commands.rst

+6
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,12 @@ Run a simulation from a compiled network architecture.
114114
* ``path/to/netw.hdf5``: Path to the network file.
115115
* ``sim-name``: Name of the simulation.
116116

117+
.. rubric:: Flags
118+
119+
* ``-o``, ``--output-folder``: Output the simulation results to an existing folder.
120+
If omitted, the current folder is used.
121+
122+
117123
.. _bsb_cache:
118124

119125
Check the global cache

0 commit comments

Comments
 (0)