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

Add 'what's new' docs for 3.5 #2838

Merged
merged 2 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all 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: 2 additions & 0 deletions doc/htmldoc/whats_new/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ versions of NEST. On the linked pages, you will find both information about new
features, as well as quick guides on how to transition your simulation code to
the new versions.

* :ref:`NEST 3.5 <release_3.5>`
* :ref:`NEST 3.4 <release_3.4>`
* :ref:`NEST 3.3 <release_3.3>`
* :ref:`NEST 3.2 <release_3.2>`
Expand All @@ -19,6 +20,7 @@ the new versions.
:hidden:
:glob:

v3.5/*
v3.4/*
v3.3/*
v3.2/*
Expand Down
67 changes: 67 additions & 0 deletions doc/htmldoc/whats_new/v3.5/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
.. _release_3.5:

What's new in NEST 3.5
======================

This page contains a summary of important breaking and non-breaking
changes from NEST 3.4 to NEST 3.5. In addition to the `release notes
on GitHub <https://github.com/nest/nest-simulator/releases/>`_, this
page also contains transition information that helps you to update
your simulation scripts when you come from an older version of NEST.

If you transition from an earlier version, please see our extensive
:ref:`transition guide from NEST 2.x to 3.0 <refguide_2_3>` and the
:ref:`list of updates for previous releases in the 3.x series
<whats_new>`.


NEST supports the SONATA format
-------------------------------

The SONATA (Scalable Open Network Architecture TemplAte) format provides a framework
for storage and exchange of network models and simulation configurations.

NEST now supports building and simulating networks of point neurons described by
this SONATA format.

See our docs to learn more:

* The :ref:`nest_sonata` for all the details
* An :doc:`example SONATA script <../../../../auto_examples/sonata_example/sonata_network>`
* PyNEST API documentation for the :py:class:`.SonataNetwork` class


Run PyNEST examples as notebooks - installation free
----------------------------------------------------

Using the EBRAINS JupyterHub service, you can now
run the PyNEST examples as Jupyter Notebooks with a click of a button.

No need to install NEST or other packages, the EBRAINS environment has
everything you already need.

Explore the :ref:`pynest_examples` and try it out!

New docs for high performance computing (HPC)
---------------------------------------------

We have new documentation all about optmizing performance of NEST on HPC systems.

Learn about creating a job script, MPI processes and threading. We also have new info on
benchmarking NEST.

Check it out:

* :ref:`optimize_performance`
* :ref:`benchmark`

New model: spike_train_injector
-------------------------------

The :doc:`spike_train_injector <../../../../models/spike_train_injector>` emits spikes at prescribed spike times which are given as an array.

We recommend its use in multi-threaded simulations where spike-emitting neurons, in a somewhat large external population, are modeled on an individual basis.

It was created to prevent an unwanted increase in memory consumption with replication at each virtual process, which
happened when external neurons were modeled as a ``spike_generator``.