tsam 2.3.3__tar.gz → 2.3.4__tar.gz

{tsam-2.3.3 → tsam-2.3.4}/.github/workflows/daily_tests.yml

@@ -1,6 +1,11 @@
 # This tests are run daily to check incompatibilties introduced by new versions of dependencies
 name: Daily tsam tests
-on: 
+on:
+  # Enables manual start
+  workflow_dispatch:
+    inputs:
+      tags:
+        description: 'Manual run' 
   schedule:
     # * is a special character in YAML so you have to quote this string
     # Some Examples for cron syntax https://crontab.guru/examples.html
@@ -10,8 +15,8 @@ on:
     # - cron: 0 0 * * 0
 
 jobs:
-  PythonAndOsTest:
-    name: Test for Python ${{matrix.python-version}} on ${{matrix.os}}  
+  DailyPythonAndOsTest:
+    name: Daily tests for Python ${{matrix.python-version}} on ${{matrix.os}}  
     runs-on: ${{matrix.os}}
     strategy:
       fail-fast: false

{tsam-2.3.3 → tsam-2.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tsam
-Version: 2.3.3
+Version: 2.3.4
 Summary: Time series aggregation module (tsam) to create typical periods
 Home-page: https://github.com/FZJ-IEK3-VSA/tsam
 Author: Leander Kotzur, Maximilian Hoffmann

{tsam-2.3.3 → tsam-2.3.4}/setup.py

@@ -8,7 +8,7 @@ with open(os.path.join(dir_path, "README.md"), "r") as fh:
 
 setuptools.setup(
     name="tsam",
-    version="2.3.3",
+    version="2.3.4",
     author="Leander Kotzur, Maximilian Hoffmann",
     author_email="leander.kotzur@googlemail.com, maximilian.hoffmann@julumni.fz-juelich.de",
     description="Time series aggregation module (tsam) to create typical periods",

{tsam-2.3.3 → tsam-2.3.4}/test/test_durationRepresentation.py

@@ -88,15 +88,15 @@ def test_distributionMinMaxRepresentation():
 
     aggregation = tsam.TimeSeriesAggregation(
         raw,
-        noTypicalPeriods=24,
+        noTypicalPeriods=8,
         segmentation=True,
-        noSegments=8,
+        noSegments=4,
         hoursPerPeriod=24,
         sortValues=False,
         clusterMethod="hierarchical",
         representationMethod="distributionAndMinMaxRepresentation",
         distributionPeriodWise=False,
-        rescaleClusterPeriods=False,
+        rescaleClusterPeriods=True,
     )
 
     predictedPeriods = aggregation.predictOriginalData()
@@ -112,10 +112,15 @@ def test_distributionMinMaxRepresentation():
         predictedPeriods.min(),
     )
 
+    np.testing.assert_array_equal(
+        raw.mean(),
+        predictedPeriods.mean()
+    )
+
     assert np.isclose(
         raw.mean(),
         predictedPeriods.mean(),
-        atol=1e-4
+        atol=1e-10
     ).all()
 
 

{tsam-2.3.3 → tsam-2.3.4}/test/test_samemean.py

@@ -1,5 +1,6 @@
 import os
 import time
+import json 
 
 import pandas as pd
 import numpy as np
@@ -44,6 +45,35 @@ def test_samemean():
 
 
 
+def test_durationRepresentation():
+
+    raw = json.load(
+        open(os.path.join(os.path.dirname(__file__), "..", "examples", "testdata_2.json"))
+    )
+
+    starttime = time.time()
+
+
+    aggregation = tsam.TimeSeriesAggregation(
+        raw,
+        noTypicalPeriods=3,
+        noSegments=8,
+        hoursPerPeriod=24,
+        sortValues=False,
+        clusterMethod="hierarchical",
+        segmentation=True,
+        representationMethod="durationRepresentation",
+        distributionPeriodWise=False,
+        rescaleClusterPeriods=False,
+        resolution=1,
+    )
+
+    periods = aggregation.createTypicalPeriods()
+
+    print("Clustering took " + str(time.time() - starttime))
+
+    # make sure that the sum of the attribute specific RMSEs is smaller for the k-means clustering with centroid
+    assert True
 
 
 

{tsam-2.3.3 → tsam-2.3.4}/tsam/timeseriesaggregation.py

@@ -136,6 +136,7 @@ class TimeSeriesAggregation(object):
         predefClusterOrder=None,
         predefClusterCenterIndices=None,
         solver="highs",
+        numericalTolerance=1e-13,
         roundOutput=None,
         addPeakMin=None,
         addPeakMax=None,
@@ -254,6 +255,10 @@ class TimeSeriesAggregation(object):
         :param solver: Solver that is used for k_medoids clustering. optional (default: 'cbc' )
         :type solver: string
 
+        :param numericalTolerance: Tolerance for numerical issues. Silences the warning for exceeding upper or lower bounds
+            of the time series. optional (default: 1e-13 )
+        :type numericalTolerance: float
+
         :param roundOutput: Decimals to what the output time series get round. optional (default: None )
         :type roundOutput: integer
 
@@ -321,6 +326,8 @@ class TimeSeriesAggregation(object):
 
         self.solver = solver
 
+        self.numericalTolerance = numericalTolerance
+
         self.segmentation = segmentation
 
         self.roundOutput = roundOutput
@@ -1097,23 +1104,29 @@ class TimeSeriesAggregation(object):
         if np.array(
             self.typicalPeriods.max(axis=0) > self.timeSeries.max(axis=0)
         ).any():
-            warning_list = self.typicalPeriods.max(axis=0) < self.timeSeries.max(axis=0)
-            warnings.warn(
-                "Something went wrong... At least one maximal value of the " + 
-                "aggregated time series exceeds the maximal value " + 
-                "the input time series for: " + 
-                "{}".format(list(warning_list[warning_list>0].index))
-            )
+            warning_list = self.typicalPeriods.max(axis=0) > self.timeSeries.max(axis=0)
+            diff = self.typicalPeriods.max(axis=0) - self.timeSeries.max(axis=0)
+            if abs(diff).max() > self.numericalTolerance:
+                warnings.warn(
+                    "At least one maximal value of the " + 
+                    "aggregated time series exceeds the maximal value " + 
+                    "the input time series for: " + 
+                    "{}".format(diff[warning_list[warning_list>0].index].to_dict()) +
+                    ". To silence the warning set the 'numericalTolerance' to a higher value."
+                )
         if np.array(
             self.typicalPeriods.min(axis=0) < self.timeSeries.min(axis=0)
         ).any():
             warning_list = self.typicalPeriods.min(axis=0) < self.timeSeries.min(axis=0)
-            warnings.warn(
-                "Something went wrong... At least one minimal value of the " + 
-                "aggregated time series exceeds the minimal value " + 
-                "the input time series for: " + 
-                "{}".format(list(warning_list[warning_list>0].index))
-            )
+            diff = self.typicalPeriods.min(axis=0) - self.timeSeries.min(axis=0)
+            if abs(diff).max() > self.numericalTolerance:
+                warnings.warn(
+                    "Something went wrong... At least one minimal value of the " + 
+                    "aggregated time series exceeds the minimal value " + 
+                    "the input time series for: " + 
+                        "{}".format(diff[warning_list[warning_list>0].index].to_dict()) +
+                        ". To silence the warning set the 'numericalTolerance' to a higher value."
+                )
         return self.typicalPeriods
 
     def prepareEnersysInput(self):

{tsam-2.3.3 → tsam-2.3.4}/tsam.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tsam
-Version: 2.3.3
+Version: 2.3.4
 Summary: Time series aggregation module (tsam) to create typical periods
 Home-page: https://github.com/FZJ-IEK3-VSA/tsam
 Author: Leander Kotzur, Maximilian Hoffmann