From 7929a88c925a1aa429dd43679f051ce8c4be2e16 Mon Sep 17 00:00:00 2001
From: belthlemar <martin.belthle@rte-france.com>
Date: Tue, 12 Nov 2024 14:47:09 +0100
Subject: [PATCH] v0.1.7

---
 CHANGELOG.md             | 14 ++++++++++++++
 README.md                | 13 ++++++++-----
 pyproject.toml           |  2 +-
 sonar-project.properties |  2 +-
 4 files changed, 24 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index ebb2e63..71f6909 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,20 @@
 Changelog
 =========
 
+v0.1.7 (2023-11-12)
+-------------------
+
+### Bug fixes
+* don't crash when fo_rate or po_rate are equal to 1
+
+### Features
+* add links ts generation
+
+### Breaking change
+- ThermalDataGenerator -> TimeseriesGenerator
+- ThermalDataGenerator.generate_time_series(...) -> TimeseriesGenerator.generate_time_series_for_clusters(...)
+- new class `OutageGenerationParameters` introduced changes the way to instantiate a ThermalCluster (see the README)
+
 v0.1.6 (2023-10-22)
 -------------------
 
diff --git a/README.md b/README.md
index d1bfa79..7bb560e 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,8 @@ The generation requires to define a few input data in a `ThermalCluster` object:
 import numpy as np
 
 days = 365
-cluster = ThermalCluster(
+generation_params = OutageGenerationParameters(
     unit_count=10,
-    nominal_power=100,
-    modulation=np.ones(dtype=float, shape=24),
     fo_law=ProbabilityLaw.UNIFORM,
     fo_volatility=0,
     po_law=ProbabilityLaw.UNIFORM,
@@ -31,7 +29,12 @@ cluster = ThermalCluster(
     po_duration=10 * np.ones(dtype=int, shape=days),
     po_rate=np.zeros(dtype=float, shape=days),
     npo_min=np.zeros(dtype=int, shape=days),
-    npo_max=10 * np.ones(dtype=int, shape=days),
+    npo_max=10 * np.ones(dtype=int, shape=days)
+)
+cluster = ThermalCluster(
+    outage_gen_params=generation_params,
+    nominal_power=100,
+    modulation=np.ones(dtype=float, shape=24),
 )
 ```
 
@@ -44,7 +47,7 @@ rng = MersenneTwisterRNG()
 Then perform the timeseries generation:
 
 ```python
-generator = ThermalDataGenerator(rng=rng, days=days)
+generator = TimeSeriesGenerator(rng=rng, days=days)
 results = generator.generate_time_series_for_clusters(cluster, 1)
 ```
 
diff --git a/pyproject.toml b/pyproject.toml
index 6386d51..d16205f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "antares-timeseries-generation"
-version = "0.1.6"
+version = "0.1.7"
 license = {text="MPL-2.0"}
 description = 'Timeseries generation library aiming at creating input data for Antares simulator studies.'
 readme = "README.md"
diff --git a/sonar-project.properties b/sonar-project.properties
index 0211045..760b7cc 100644
--- a/sonar-project.properties
+++ b/sonar-project.properties
@@ -1,4 +1,4 @@
-sonar.projectVersion=0.1.6
+sonar.projectVersion=0.1.7
 sonar.organization=antaressimulatorteam
 sonar.projectKey=AntaresSimulatorTeam_antares-timeseries-generation
 sonar.sources=src