Skip to content

Commit

Permalink
v3.6.3 - Getting Started update
Browse files Browse the repository at this point in the history
  • Loading branch information
Helveg committed Jan 10, 2021
1 parent ec2216a commit edc309c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# 3.6

## 3.6.3

* Updated "Getting Started" guide.
* Changed default config to `network_configuration.json`

## 3.6.2

* New ionic recorder device for NEURON adapter.
Expand Down
2 changes: 1 addition & 1 deletion bsb/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__version__ = "3.6.2"
__version__ = "3.6.3"

from .reporting import set_verbosity, report, warn
14 changes: 7 additions & 7 deletions docs/source/usage/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ configuration with Python scripting.
First script
============

Although the scaffold package features a CLI that can perform most tasks, the package's
primary use case is to be included in scripts that can further customize
the scaffold with things impossible to achieve using the configuration files.
The package is a library that can be imported into Python scripts. You can load
configurations and adapt the loaded object before constructing a network with it to
programmatically alter the network structure.

Let's go over an example first script that creates 5 networks with different
densities of ``base_type``.
Expand All @@ -81,15 +81,15 @@ keyword argument with a path to the configuration file::
scaffold = Scaffold(config)

.. note::
The verbosity is 1 by default, which only displays errors. You could also add
a `verbosity` attribute to the root node of the `my_config.json` file to set
the verbosity.
The verbosity is 1 by default, which only displays errors. You could also add a
``verbosity`` attribute to the root node of the ``network_configuration.json`` file to
set the verbosity.

Let's find the ``base_type`` cell configuration::

base_type = scaffold.get_cell_type("base_type")

The next step is to adapt the Purkinje cell density each iteration. The location
The next step is to adapt the ``base_type`` cell density each iteration. The location
of the attributes on the Python objects mostly corresponds to their location in
the configuration file. This means that::

Expand Down

0 comments on commit edc309c

Please sign in to comment.