File: reference-network.txt

package info (click to toggle)
brian 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, stretch
  • size: 23,436 kB
  • sloc: python: 68,707; cpp: 29,040; ansic: 5,182; sh: 111; makefile: 61
file content (30 lines) | stat: -rw-r--r-- 1,183 bytes parent folder | download | duplicates (3)
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
.. currentmodule:: brian

Network
-------

The :class:`Network` object stores simulation objects and runs simulations. Usage
is described in detail below. For simple scripts, you don't even need to
use the :class:`Network` object itself, just directly use the ''magic'' functions
:func:`run` and :func:`reinit` described below.

.. autoclass:: Network
.. autofunction:: network_operation
.. autoclass:: NetworkOperation

The ''magic'' functions :func:`run` and :func:`reinit` work by searching for
objects which could be added to a network, constructing a network with all
these objects, and working with that. They are suitable for simple scripts
only. If you have problems where objects are unexpectedly not being added
to the network, the  best thing to do would probably be to just use an
explicit :class:`Network` object as above rather than trying to tweak your
program to make the magic functions work. However, details are available
in the ``brian/magic.py`` source code.

.. autofunction:: run
.. autofunction:: reinit
.. autofunction:: stop
.. autofunction:: clear
.. autofunction:: forget
.. autofunction:: recall
.. autoclass:: MagicNetwork