Skip to content

Commit

Permalink
Small updates to codegen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thesamovar committed Oct 11, 2013
1 parent e56108a commit eda4bf0
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs_sphinx/developer/codegen.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Code generation
~~~~~~~~~~~~~~~

.. warning:: The information in these pages is slightly out of date now. This documentation will be updated for the
beta release of Brian 2.

The following is an outline of how the Brian 2 code generation system works,
with indicators as to which packages to look at and which bits of code to read
for a clearer understanding.
Expand Down Expand Up @@ -39,7 +42,7 @@ which represents the integration code for a single time step.
An example of this would be converting the following equations::

eqs = '''
dv/dt = (v0-v)/tau : volt (unless-refractory)
dv/dt = (v0-v)/tau : volt (unless refractory)
v0 : volt
'''
group = NeuronGroup(N, eqs, threshold='v>10*mV',
Expand Down Expand Up @@ -105,7 +108,7 @@ An example of a snippet in C++ for the equations above::
_ptr_array_neurongroup_v[_neuron_idx] = v;

The code path that includes snippet generation will be discussed in more detail
below, since it involves the concepts of namespaces and specifiers which we
below, since it involves the concepts of namespaces and variables which we
haven't covered yet.

Snippet to code block
Expand Down Expand Up @@ -207,8 +210,8 @@ involved in the code generation process.
``core``
``core.namespace``
The `CompoundNamespace` and namespace resolution are defined here.
``core.specifiers``
The `Specifier` types are defined here.
``core.variables``
The `Variable` types are defined here.
``equations``
Everything related to `Equations`.
``groups``
Expand Down

0 comments on commit eda4bf0

Please sign in to comment.