README.md
1# `lib` folder
2
3Definition of high-level API of PyNEST.
4
5This file defines the user-level functions of NEST's Python interface
6by mapping NEST/SLI commands to Python. Please try to follow these
7rules:
8
91. SLI commands have the same name in Python. This means that most
10 function names are written in camel case, although the Python
11 guidelines suggest to use lower case for function names. However,
12 this way, it is easier for users to migrate from SLI to Python.
13
142. Nodes are identified by their global IDs (node ID) by default.
15
163. node IDs are always represented by a NodeCollection, e.g.
17 NodeCollection(metadata=None, model=iaf_psc_alpha, size=10, first=1, last=10)
18
194. Commands that return a node ID must return it as NodeCollection.
20
215. When possible, loops over nodes should be propagated down to the
22 SLI level. This minimizes the number of Python<->SLI conversions
23 and increases performance. Loops in SLI are also faster than in
24 Python.
25
266. If you have a *very* good reason, you may deviate from these guidelines.
27