Release notes
=============

This is the list of changes to NetSSE between each release. For full details, see the `commit logs <https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/commits/>`_ on GitLab. For install and upgrade instructions, see :ref:`installation`.

.. _1.0: https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/releases/NetSSE_1.0

.. _2.0: https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/releases/NetSSE_2.0.0

.. _2.1: https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/releases/NetSSE_2.1.0

.. _2.2: https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/releases/NetSSE_2.2.0

.. _master: https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/tree/master

.. _wip: https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/tree/wip

+------------+--------------+-------------------------------------+
| Version    | Release date | New features                        | 
+============+==============+=====================================+
| `1.0`_     | 27-07-2023   | Initial modules:                    |
|            |              | ``analys.buoy``, ``analys.spec``,   |
|            |              | ``model.ship``,                     |
|            |              | ``simul.ship_resp``,                |
|            |              | ``tools.envir_cond``,               |
|            |              | ``tools.misc_func``.                |
+------------+--------------+-------------------------------------+
| `2.0`_     | 26-07-2024   | New modules:                        |
|            |              | ``base``,                           |
|            |              | ``analys.emep``,                    |
|            |              | ``analys.enc_spec``,                |
|            |              | ``analys.sawb``.                    |
+------------+--------------+-------------------------------------+
| `2.1`_     | 22-08-2025   | New modules:                        |
|            |              | ``analys.dsa``,                     |
|            |              | ``model.bathymetry``,               |
|            |              | ``model.era5``,                     |
|            |              | ``tools.viz``.                      |
|            |              |                                     |
|            |              | Moved modules:                      |
|            |              | ``envir_cond`` is now found under   |
|            |              | ``model``.                          |
+------------+--------------+-------------------------------------+
| `2.2`_     | 20-02-2026   | New module:                         |
| (stable)   |              | ``tools.kinematics``.               |
|            |              |                                     |
+------------+--------------+-------------------------------------+
| 2.3        | TBA          | TBD                                 |
| (work-in-  |              |                                     |
| progress)  |              |                                     |
+------------+--------------+-------------------------------------+

Latest Release
--------------

The latest **stable release** is always available for installation via PyPI.

You can browse the documentation for released versions using the version switcher located at the bottom right corner of this page. The documentation for the latest stable release is labeled with its version number (e.g., ``netsse_2.X.X``).

Development Branch
------------------

The `master`_ branch on GitLab represents the **development version**. It may include unreleased changes and is not guaranteed to be available on PyPI.

Documentation for the development version is labeled as ``latest`` in the version switcher at the bottom right corner of this page.

Work-in-Progress Branch
-----------------------

The most recent updates are available on the `wip`_ (**work-in-progress**) branch on GitLab. This branch may contain experimental features and bug fixes that have not yet been officially released. It is **not guaranteed to be stable**, so use it at your own discretion.

Documentation for the work-in-progress branch is labeled as ``wip`` in the version switcher at the bottom right corner of this page.