Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pave the way for per-version transition guides #2115

Merged
merged 6 commits into from
Jul 30, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/userdoc/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Table of Contents
:maxdepth: 1
:caption: User Documentation

guides/nest2_to_nest3/index
Download <download>
Install <installation/index>
Configure <installation/configuration>
Expand All @@ -22,6 +21,7 @@ Table of Contents
ref_material/pynest_apis
troubleshooting
getting_help
release_notes/index

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 0 additions & 6 deletions doc/userdoc/download.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
Download NEST
=============

.. admonition:: Try NEST 3.0

NEST 3.0 is not yet officially released but if you want to check out the new features, you can clone the
source code from `the nest-3 branch on GitHub <https://github.com/nest/nest-simulator/tree/nest-3>`_.
Then follow the instructions to compile from source in :doc:`installation/linux_install` or :doc:`installation/mac_install`.

.. pull-quote::

For standard situations where you just want to use but not modify
Expand Down
9 changes: 1 addition & 8 deletions doc/userdoc/guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ Guides

Here you can find details on a variety of topics in NEST.

.. toctree::
:maxdepth: 1
:caption: Transition guides to NEST 3.0

nest2_to_nest3/index
spatial/index

.. toctree::
:maxdepth: 1
:caption: In-depth guides to NEST
Expand All @@ -21,7 +14,7 @@ Here you can find details on a variety of topics in NEST.
record_from_simulations
parallel_computing
random_numbers
spatial/guide_spatially_structured_networks
spatially_structured_networks
simulations_with_gap_junctions
simulations_with_precise_spike_times
using_nest_with_music
Expand Down
46 changes: 0 additions & 46 deletions doc/userdoc/guides/nest2_to_nest3/index.rst

This file was deleted.

93 changes: 0 additions & 93 deletions doc/userdoc/guides/nest2_to_nest3/whats_removed.rst

This file was deleted.

30 changes: 5 additions & 25 deletions doc/userdoc/guides/random_numbers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,42 +27,22 @@ use, and how to set the seed of RNGs in NEST. We use the term "random
number" here for ease of writing, even though we are always talking
about pseudorandom numbers generated by some algorithm.


.. admonition:: NEST 2.x vs NEST 3.0

This document describes random number generators in NEST 3.0, which differs
significantly from earlier versions. If you are working with NEST 2.x, please
consult the documentation for that version.

Due to the significant changes in random number architecture between NEST 2.x
and NEST 3.0, it is not possible to re-create NEST 2.x simulations with identical
random number sequences in NEST 3.0. Thus, spike patterns will differ in detail
between simulations of the same model with NEST 2.x and NEST 3.0, but shall agree
as long as suitable quantities, such as firing rates, correlations, or spectra
are compared across multiple simulations.


.. admonition:: Compiler dependency

NEST 3.0 uses random generators provided by the C++ Standard Library to
NEST uses random generators provided by the C++ Standard Library to
obtain random deviates, i.e., random numbers following different distributions
such as normal, binomial, or Poissonian. Different versions of the C++
Standard Library use different algorithms to generate these deviates.
Therefore, simulation results can differ in detail depending on the compiler
and the C++ Standard Library implementation used. Note in particular that
GCC and Clang come with different library implementations.

As for the difference between NEST 2.x and NEST 3.0, simulations based on
different compilers/standard libraries shall agree as long as suitable
quantities are compared using suitable statistical tests.


.. _working_with_rngs:

How to work with randomness in NEST
-----------------------------------

NEST 3.0 makes randomness easy: Setting a single seed gives you full
NEST makes randomness easy: Setting a single seed gives you full
control over randomness throughout a simulation, and you can choose seed values
at liberty. NEST's powerful mechanism to :ref:`parameterize nodes and synapses <param_ex>`
and NEST's :ref:`probabilistic connection rules <connection_mgnt>` allow you
Expand Down Expand Up @@ -110,7 +90,7 @@ better performance. More generators may be added in the future. Currently, only
generators is available because we require generators with a sufficiently long period as discussed in
:ref:`Random number internals <random_internals>`.

The default random number generator set in NEST 3.0 is ``mt19937_64``. To choose a different generator,
The default random number generator set in NEST is ``mt19937_64``. To choose a different generator,
set it in the following way:

::
Expand Down Expand Up @@ -466,7 +446,7 @@ cryptographic generators and thus no period.
Seed parallel random number streams
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In NEST 3.0, the user provides a single seed :math:`1 \leq S \leq 2^{31}-1` to initialize
In NEST, the user provides a single seed :math:`1 \leq S \leq 2^{31}-1` to initialize
all :math:`N_{\text{vp}}+2` random number generators in a parallel simulation.
NEST uses a seed sequence generator to derive seeds for the individual RNGs from
the user-provided seed :math:`S`.
Expand All @@ -479,5 +459,5 @@ we use `Melissa O'Neill's improved seed sequence generator <https://www.pcg-rand
Further background
~~~~~~~~~~~~~~~~~~

For more background on the NEST 3.0 random number generation architecture,
For more background on the NEST random number generation architecture,
see also `NEST Github issue #1440 <https://github.com/nest/nest-simulator/issues/1440>`__.
26 changes: 0 additions & 26 deletions doc/userdoc/guides/spatial/index.rst

This file was deleted.

Loading