Skip to content

Commit

Permalink
Add release notes for Brian 2.5.2
Browse files Browse the repository at this point in the history
  • Loading branch information
mstimberg committed Jun 22, 2023
1 parent 98a30dd commit 5dc465a
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs_sphinx/developer/guidelines/style.rst
Expand Up @@ -11,6 +11,8 @@ explicit rather than abbreviated and consistent across Brian. See Romain's paper
<http://briansimulator.org/WordPress/wp-content/uploads/2012/05/On-the-design-of-script-languages-for-neural-simulation.pdf>`__
for a discussion.

.. _code_style:

Code style
~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions docs_sphinx/developer/standalone.rst
Expand Up @@ -8,6 +8,7 @@ Standalone implementation
This – currently very incomplete – document describes some of the implementation details of :ref:`cpp_standalone`.

.. _array_cache:

Array cache
-----------
As described in :ref:`standalone variables <standalone_variables>`, in standalone mode Python code does not
Expand Down
74 changes: 74 additions & 0 deletions docs_sphinx/introduction/release_notes.rst
@@ -1,6 +1,80 @@
Release notes
=============

Brian 2.5.2
-----------
This new minor release fixes incompatibility issues with the latest numpy release, and a number of other issues.
To make it easier to contribute to Brian, we have now adopted a consistent code style and updated our infrastructure so
that the style gets enforced for all new code contributions (see :ref:`code_style` for details).

New features
~~~~~~~~~~~~
- We now provide Python wheels for the ``linux-aarch64`` architecture (:issue:`1463`), making it easier to install Brian
on ARM-based systems running Linux (including recent Apple hardware).

Selected improvements and bug fixes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Fix compability with numpy 1.25 and avoid deprecation warnings (:issue:`1473`)
- Add missing ``volume`` attribute to `~.SpatialNeuron` (:issue:`1430`). Thanks to Sebastian Schmitt for contributing this
fix.
- Fix an issue with pickling `~.Quantity` objects (:issue:`1438`). Thanks to Shailesh Appukuttan for making us aware of
this issue.
- No longer use the deprecated ``distutils`` package (:issue:`1442`).
- Fix an issue with log files on Windows (:issue:`1454`). Thanks to discourse user
``@NiKnight`` for making us aware of the issue.
- Fix an issue that prevents building the documentation on recent Python versions (:issue:`1450`). Thanks to Étienne
Mollier for contributing this fix.
- Fix an issue with the upcoming Cython version for GSL integration (:issue:`1471`).
- Fix a broken error message (:issue:`1467`). Thanks to ``@pjsph`` for contributing the fix.
- Fix an issue with user-provided header files (:issue:`1436`). Thanks to ``@wxie2013`` for reporting the issue.
- Fix an issue when using `SpatialNeuron` with `TimedArray` on Cython (:issue:`1428`). Thanks to Sebastian Schmitt for
reporting the issue.

Infrastructure and documentation improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- We now enforce a consistent code style for all new code contributions, and check/enforce the code style with tools
such as ``black``, ``isort``, ``flake8``, and ``pyupgrade`` (:issue:`1435`, :issue:`1444`, :issue:`1446`).
See :ref:`code_style` for details. Thanks to Oleksii Leonov for contributing this feature.
- A number of new examples have been added: :doc:`../examples/frompapers.Tetzlaff_2015`, :doc:`../examples/frompapers.Nicola_Clopath_2017`
(contributed by Sebastian Schmitt) and :doc:`../examples/coupled_oscillators`.
- The development container has been updated, and the repository now contains a file with all the places where
dependency versions are listed (:issue:`1451`, :issue:`1468`).

Backwards incompatible changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Using `SpatialNeuron` with the ``numpy`` code generation target now requires the ``scipy`` package to be installed
(:issue:`1460`).

Contributions
~~~~~~~~~~~~~

Github code, documentation, and issue contributions (ordered by the number of
contributions):

* Marcel Stimberg (`@mstimberg <https://github.com/mstimberg>`_)
* Dan Goodman (`@thesamovar <https://github.com/thesamovar>`_)
* Ben Evans (`@bdevans <https://github.com/bdevans>`_)
* Oleksii Leonov (`@oleksii-leonov <https://github.com/oleksii-leonov>`_)
* Sebastian Schmitt (`@schmitts <https://github.com/schmitts>`_)
* Denis Alevi (`@denisalevi <https://github.com/denisalevi>`_)
* Shailesh Appukuttan (`@appukuttan-shailesh <https://github.com/appukuttan-shailesh>`_)
* `@TheSquake <https://github.com/TheSquake>`_
* `@tim-ufer <https://github.com/tim-ufer>`_
* Akalanka (`@boneyag <https://github.com/boneyag>`_)
* `@pjsph <https://github.com/pjsph>`_
* `@Bitloader22 <https://github.com/Bitloader22>`_
* `@MunozatABI <https://github.com/MunozatABI>`_
* Étienne Mollier (`@emollier <https://github.com/emollier>`_)
* `@KarimHabashy <https://github.com/KarimHabashy>`_
* `@hunjunlee <https://github.com/hunjunlee>`_
* Arash Golmohammadi (`@arashgmn <https://github.com/arashgmn>`_)
* Steathy Spikes (`@steathy-spikes <https://github.com/steathy-spikes>`_)
* Adam Willats (`@awillats <https://github.com/awillats>`_)

Other contributions outside of github (ordered alphabetically, apologies to
anyone we forgot...):
* `@NiKnight <https://brian.discourse.group/u/niknight/summary>`_

Brian 2.5.1
-----------
This new minor release contains a large number of bug fixes and improvements, in particular for the C++ standalone mode,
Expand Down

0 comments on commit 5dc465a

Please sign in to comment.