From 1edacc75f1e01e1370636b7df5a4af8775f108d8 Mon Sep 17 00:00:00 2001
From: Nick Harder <56074305+nick-harder@users.noreply.github.com>
Date: Wed, 6 Nov 2024 09:06:38 +0100
Subject: [PATCH] Prepares for the release of the new version (#471)

-updated version
-added release notes
---
 docs/source/release_notes.rst | 42 ++++++++++++++++++++++++++---------
 pyproject.toml                |  2 +-
 2 files changed, 33 insertions(+), 11 deletions(-)

diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
index 065f206b..86f7aafd 100644
--- a/docs/source/release_notes.rst
+++ b/docs/source/release_notes.rst
@@ -13,21 +13,43 @@ Upcoming Release
   The features in this section are not released yet, but will be part of the next release! To use the features already you have to install the main branch,
   e.g. ``pip install git+https://github.com/assume-framework/assume``
 
+
+v0.4.2 - Latest Release (5th November 2024)
+===========================================
+
 **New Features:**
 
-- Converted DST components from functions to classes for improved modularity and reusability.
-- Added new residential DST components like PV, EV, Heat Pump, and Boiler, with refined docstrings for better usability.
-- Created a `GenericStorage` class for storage components, with classes like EV and Hydrogen Storage inheriting from it.
-- Update to mango 2.x which allows for sync creation of world
-- Added a new DRL-based learning strategy for the storage unit. Use the `storage_learning` strategy in the `bidding_EOM` column of the `storage_units.csv`
-  file to use this strategy. refer to the API of `StorageRLStrategy` documentation for more details.
+- **Residential Components**: Added new residential DST components including PV, EV, Heat Pump, and Boiler, now with enhanced docstrings for better usability.
+- **Modular DST Components**: DST components have been converted from functions to classes, improving modularity and reusability.
+- **Generic Storage Class**: Introduced a `GenericStorage` class for storage components. Specific classes, such as EV and Hydrogen Storage, now inherit from it.
+- **Storage Learning Strategy**: Added a new DRL-based learning strategy for storage units. To use it, set `storage_learning` in the `bidding_EOM` column of `storage_units.csv`. Refer to the `StorageRLStrategy` documentation for more details.
+- **Mango 2.x Update**: Upgraded to mango 2.x, enabling synchronous world creation. To upgrade an existing environment, run:
+  ```
+  pip uninstall -y mango-agents mango-agents-assume && pip install assume-framework --upgrade
+  ```
+- **Distributed Simulation Enhancements**: Improved distributed simulation for TCP and MQTT, allowing containers to wait for each other during simulations.
+- **Integrated Optimization with Pyomo and HIGHS Solver**: The Pyomo library and HIGHS solver are now installed by default, removing the need to install `assume-framework[optimization]` separately. The HIGHS solver is used as the default, replacing the older GLPK solver for improved optimization performance and efficiency.
+
+**Improvements:**
+
+- **Documentation**: Refined tutorial notebooks and added bug fixes.
+- **Saving Frequency Logic**: Refactored the saving frequency in the `WriteOutput` class for improved efficiency.
+
+**Bug Fixes:**
+
+- **Solver Compatibility**: Addressed undefined `solver_options` when using solvers other than Gurobi or HIGHS.
+- **Cashflow Calculation**: Corrected cashflow calculations for single-digit orders.
+- **Simulation Execution**: Enabled simulations to synchronize and wait for each other.
+- **Edge Case Handling**: Fixed edge cases in `pay_as_clear` and `pay_as_bid`.
+
+**New Contributor:**
 
-  * to upgrade a prior environment run `pip uninstall -y mango-agents mango-agents-assume && pip install mango-agents`
+- @HafnerMichael made their first contribution with improvements to cashflow calculations and development of residential DST components.
 
-- improve distributed simulation for TCP and MQTT, so that containers wait for each other in simulations
+**Full Changelog**: [v0.4.1...v0.4.2](https://github.com/assume-framework/assume/compare/v0.4.1...v0.4.2)
 
 
-v0.4.1 - latest release (8th October 2024)
+v0.4.1 (8th October 2024)
 ===========================================
 
 **New Features:**
@@ -48,7 +70,7 @@ v0.4.1 - latest release (8th October 2024)
 - make complex clearing compatible to RL (#430)
 - pin PyPSA to remove DeprecationWarnings for now (#431)
 
-v0.4.0 - latest release (8th August 2024)
+v0.4.0 (8th August 2024)
 =========================================
 
 **New Features:**
diff --git a/pyproject.toml b/pyproject.toml
index 682acdd6..12db4bf5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "assume-framework"
-version = "0.4.1"
+version = "0.4.2"
 description = "ASSUME - Agent-Based Electricity Markets Simulation Toolbox"
 authors = [{ name = "ASSUME Developers", email = "contact@assume-project.de"}]
 license = {text = "AGPL-3.0-or-later"}