tsam 2.3.2__py3-none-any.whl → 2.3.4__py3-none-any.whl

tsam/__init__.py

@@ -1,11 +0,0 @@
-import sys
-
-if not sys.warnoptions:
-    import warnings
-
-    warnings.filterwarnings(
-        action="ignore",
-        category=FutureWarning,
-        append=True,
-        message=r".*The previous implementation of stack is deprecated and will be removed in a future version of pandas.*",
-    )

tsam/timeseriesaggregation.py

@@ -8,7 +8,6 @@ import pandas as pd
 import numpy as np
 
 from sklearn.metrics import mean_squared_error, mean_absolute_error
-from sklearn.metrics.pairwise import euclidean_distances
 from sklearn import preprocessing
 
 from tsam.periodAggregation import aggregatePeriods
@@ -27,6 +26,9 @@ TOLERANCE = 1e-6
 MIN_WEIGHT = 1e-6
 
 
+
+
+
 def unstackToPeriods(timeSeries, timeStepsPerPeriod):
     """
     Extend the timeseries to an integer multiple of the period length and
@@ -134,6 +136,7 @@ class TimeSeriesAggregation(object):
         predefClusterOrder=None,
         predefClusterCenterIndices=None,
         solver="highs",
+        numericalTolerance=1e-13,
         roundOutput=None,
         addPeakMin=None,
         addPeakMax=None,
@@ -252,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
 
@@ -319,6 +326,8 @@ class TimeSeriesAggregation(object):
 
         self.solver = solver
 
+        self.numericalTolerance = numericalTolerance
+
         self.segmentation = segmentation
 
         self.roundOutput = roundOutput
@@ -388,21 +397,21 @@ class TimeSeriesAggregation(object):
             try:
                 timedelta = self.timeSeries.index[1] - self.timeSeries.index[0]
                 self.resolution = float(timedelta.total_seconds()) / 3600
-            except AttributeError:
+            except AttributeError as exc:
                 raise ValueError(
                     "'resolution' argument has to be nonnegative float or int"
                     + " or the given timeseries needs a datetime index"
-                )
+                ) from exc
             except TypeError:
                 try:
                     self.timeSeries.index = pd.to_datetime(self.timeSeries.index)
                     timedelta = self.timeSeries.index[1] - self.timeSeries.index[0]
                     self.resolution = float(timedelta.total_seconds()) / 3600
-                except:
+                except Exception as exc:
                     raise ValueError(
                         "'resolution' argument has to be nonnegative float or int"
                         + " or the given timeseries needs a datetime index"
-                    )
+                    ) from exc
 
         if not (isinstance(self.resolution, int) or isinstance(self.resolution, float)):
             raise ValueError("resolution has to be nonnegative float or int")
@@ -870,9 +879,9 @@ class TimeSeriesAggregation(object):
                 )
 
                 # reset values higher than the upper sacle or less than zero
-                typicalPeriods[column].clip(lower=0, upper=scale_ub, inplace=True)
+                typicalPeriods[column] = typicalPeriods[column].clip(lower=0, upper=scale_ub)
 
-                typicalPeriods[column].fillna(0.0, inplace=True)
+                typicalPeriods[column] = typicalPeriods[column].fillna(0.0)
 
                 # calc new sum and new diff to orig data
                 sum_clu_wo_peak = np.sum(
@@ -967,7 +976,7 @@ class TimeSeriesAggregation(object):
         # check for additional cluster parameters
         if self.evalSumPeriods:
             evaluationValues = (
-                self.normalizedPeriodlyProfiles.stack(level=0)
+                self.normalizedPeriodlyProfiles.stack(future_stack=True,level=0)
                 .sum(axis=1)
                 .unstack(level=1)
             )
@@ -1095,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):
@@ -1237,7 +1252,7 @@ class TimeSeriesAggregation(object):
             columns=self.normalizedPeriodlyProfiles.columns,
             index=self.normalizedPeriodlyProfiles.index,
         )
-        clustered_data_df = clustered_data_df.stack(level="TimeStep")
+        clustered_data_df = clustered_data_df.stack(future_stack=True,level="TimeStep")
 
         # back in form
         self.normalizedPredictedData = pd.DataFrame(

tsam/utils/durationRepresentation.py

@@ -57,7 +57,7 @@ def durationRepresentation(
                 # get all the values of a certain attribute and cluster
                 candidateValues = candidates.loc[indice[0], a]
                 # sort all values
-                sortedAttr = candidateValues.stack().sort_values()
+                sortedAttr = candidateValues.stack(future_stack=True,).sort_values()
                 # reindex and arrange such that every sorted segment gets represented by its mean
                 sortedAttr.index = pd.MultiIndex.from_tuples(clean_index)
                 representationValues = sortedAttr.unstack(level=0).mean(axis=1)
@@ -97,8 +97,8 @@ def durationRepresentation(
             # concat centroid values and cluster weights for all clusters
             meansAndWeights = pd.concat(
                 [
-                    pd.DataFrame(np.array(meanVals)).stack(),
-                    pd.DataFrame(np.array(clusterLengths)).stack(),
+                    pd.DataFrame(np.array(meanVals)).stack(future_stack=True,),
+                    pd.DataFrame(np.array(clusterLengths)).stack(future_stack=True,),
                 ],
                 axis=1,
             )
@@ -107,7 +107,7 @@ def durationRepresentation(
             # save order of the sorted centroid values across all clusters
             order = meansAndWeightsSorted.index
             # sort all values of the original time series
-            sortedAttr = candidates.loc[:, a].stack().sort_values().values
+            sortedAttr = candidates.loc[:, a].stack(future_stack=True,).sort_values().values
             # take mean of sections of the original duration curve according to the cluster and its weight the
             # respective section is assigned to
             representationValues = []

tsam/utils/k_medoids_contiguity.py

@@ -1,7 +1,14 @@
 # -*- coding: utf-8 -*-
 
 import numpy as np
+
+
 import time
+
+# switch to numpy 2.0
+np.float_ = np.float64
+np.complex_=np.complex128
+
 import pyomo.environ as pyomo
 import pyomo.opt as opt
 import networkx as nx

tsam/utils/k_medoids_exact.py

@@ -5,6 +5,11 @@ import numpy as np
 from sklearn.base import BaseEstimator, ClusterMixin, TransformerMixin
 from sklearn.metrics.pairwise import PAIRWISE_DISTANCE_FUNCTIONS
 from sklearn.utils import check_array
+
+# switch to numpy 2.0
+np.float_ = np.float64
+np.complex_=np.complex128
+
 import pyomo.environ as pyomo
 import pyomo.opt as opt
 from pyomo.contrib import appsi

{tsam-2.3.2.dist-info → tsam-2.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tsam
-Version: 2.3.2
+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
@@ -14,24 +14,21 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: scikit-learn >=0.0
-Requires-Dist: pandas <3.0,>=0.18.1
-Requires-Dist: numpy <2.0,>=1.11.0
+Requires-Dist: pandas >=2.0.3
+Requires-Dist: numpy >=1.20.0
 Requires-Dist: pyomo >=6.4.3
 Requires-Dist: networkx
 Requires-Dist: tqdm
 Requires-Dist: highspy
 
-[![pytest master status](https://github.com/FZJ-IEK3-VSA/tsam/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/FZJ-IEK3-VSA/tsam/actions) [![Version](https://img.shields.io/pypi/v/tsam.svg)](https://pypi.python.org/pypi/tsam) [![Documentation Status](https://readthedocs.org/projects/tsam/badge/?version=latest)](https://tsam.readthedocs.io/en/latest/) [![PyPI - License](https://img.shields.io/pypi/l/tsam)]((https://github.com/FZJ-IEK3-VSA/tsam/blob/master/LICENSE.txt)) [![codecov](https://codecov.io/gh/FZJ-IEK3-VSA/tsam/branch/master/graph/badge.svg)](https://codecov.io/gh/FZJ-IEK3-VSA/tsam)
+[![daily pytest](https://github.com/FZJ-IEK3-VSA/tsam/actions/workflows/daily_tests.yml/badge.svg?branch=master)](https://github.com/FZJ-IEK3-VSA/tsam/actions) [![Version](https://img.shields.io/pypi/v/tsam.svg)](https://pypi.python.org/pypi/tsam) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/tsam.svg)](https://anaconda.org/conda-forge/tsam) [![Documentation Status](https://readthedocs.org/projects/tsam/badge/?version=latest)](https://tsam.readthedocs.io/en/latest/) [![PyPI - License](https://img.shields.io/pypi/l/tsam)]((https://github.com/FZJ-IEK3-VSA/tsam/blob/master/LICENSE.txt)) [![codecov](https://codecov.io/gh/FZJ-IEK3-VSA/tsam/branch/master/graph/badge.svg)](https://codecov.io/gh/FZJ-IEK3-VSA/tsam)
 [![badge](https://img.shields.io/badge/launch-binder-579aca.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC)](https://mybinder.org/v2/gh/FZJ-IEK3-VSA/voila-tsam/HEAD?urlpath=voila/render/Time-Series-Aggregation-Module.ipynb)
 
 <a href="https://www.fz-juelich.de/en/iek/iek-3"><img src="https://www.fz-juelich.de/static/media/Logo.2ceb35fc.svg" alt="Forschungszentrum Juelich Logo" width="230px"></a> 
@@ -52,10 +49,14 @@ The documentation of the tsam code can be found [**here**](https://tsam.readthed
 
 
 ## Installation
-Directly install via pip as follows:
+Directly install via pip from pypi as follows:
 
 	pip install tsam
 
+of install from conda forge with the following command:
+
+	conda install tsam -c conda-forge
+
 Alternatively, clone a local copy of the repository to your computer
 
 	git clone https://github.com/FZJ-IEK3-VSA/tsam.git
@@ -70,6 +71,12 @@ Or install directly via python as
 	python setup.py install
 	
 In order to use the k-medoids clustering, make sure that you have installed a MILP solver. As default [HiGHS](https://github.com/ERGO-Code/HiGHS) is used. Nevertheless, in case you have access to a license we recommend commercial solvers (e.g. Gurobi or CPLEX) since they have a better performance.
+
+### Developer installation
+
+In order to setup a virtual environment in Linux, correct the python name in the Makefile and call
+
+	make setup_venv
 	
 	
 ## Examples

tsam-2.3.4.dist-info/RECORD

@@ -0,0 +1,16 @@
+tsam/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tsam/hyperparametertuning.py,sha256=eM7m7eY80uSlwnLRxmctnis2Jv66D15Z1QD9CCMzSXE,10349
+tsam/periodAggregation.py,sha256=h9CC06jBLNyyaFTMRynGUMN87fOH3NdSEug6EcTsKGA,5471
+tsam/representations.py,sha256=2NL1wanBhGreCeJ8jh0aNdIx05YXEyyMJmMAVFS5-T4,7133
+tsam/timeseriesaggregation.py,sha256=xLkdSmjbJnSxC0GBzF9Vc-6VMK7Y1OPOmQhdHJgymug,56963
+tsam/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tsam/utils/durationRepresentation.py,sha256=A-RjELO-58jBXbEHxxJ6TPZc2zPC560_SW7kNzw2ZPA,9463
+tsam/utils/k_maxoids.py,sha256=0PyaHQMA8vtV_SuQOZ0qdcGFK46aUvOiMSQofjGkjBQ,4415
+tsam/utils/k_medoids_contiguity.py,sha256=xSN9xT61oc2CPxYERhugR9hDkVCb2o8POvAiLLgrey8,5925
+tsam/utils/k_medoids_exact.py,sha256=CW6BLQV2eTYtMxDmo97-6hY1HljxcvkPVrL4DQPN5IQ,7178
+tsam/utils/segmentation.py,sha256=y8TPv1KEqf6ByOz7TRywm3WC9ZPhGiWvhwAcQbFibt4,6132
+tsam-2.3.4.dist-info/LICENSE.txt,sha256=XEzEzumoCmdJzcp5gKT6UOtKrkH-SiGpxVbIfihkNK4,1224
+tsam-2.3.4.dist-info/METADATA,sha256=d3aPs_IF8L1S92kkCuFpTmQ4I5PTUl_Q7Z8T6uJmO4A,12581
+tsam-2.3.4.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+tsam-2.3.4.dist-info/top_level.txt,sha256=MFI15PnPuMv8F1hTAOXbjGu41z-l6dJbnK69WlIQNcM,5
+tsam-2.3.4.dist-info/RECORD,,

{tsam-2.3.2.dist-info → tsam-2.3.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tsam-2.3.2.dist-info/RECORD

@@ -1,16 +0,0 @@
-tsam/__init__.py,sha256=E6QTHxEAgUQUWz5m6udpRN8FdG7bivjaG0sau60TgBA,304
-tsam/hyperparametertuning.py,sha256=eM7m7eY80uSlwnLRxmctnis2Jv66D15Z1QD9CCMzSXE,10349
-tsam/periodAggregation.py,sha256=h9CC06jBLNyyaFTMRynGUMN87fOH3NdSEug6EcTsKGA,5471
-tsam/representations.py,sha256=2NL1wanBhGreCeJ8jh0aNdIx05YXEyyMJmMAVFS5-T4,7133
-tsam/timeseriesaggregation.py,sha256=NpHsu507m6TUGIiccU3dkDKjp2SKJkJp_8IQiTkjXSs,56066
-tsam/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tsam/utils/durationRepresentation.py,sha256=k5pu5m8cRLkU2T9pepZ3wUOgf6I9mn6YmoIHBnVR1yo,9391
-tsam/utils/k_maxoids.py,sha256=0PyaHQMA8vtV_SuQOZ0qdcGFK46aUvOiMSQofjGkjBQ,4415
-tsam/utils/k_medoids_contiguity.py,sha256=IeTucR7OI0iBfbTJs1nVXas5bZ44rVPS2bkb-EewXxc,5843
-tsam/utils/k_medoids_exact.py,sha256=5F2vHZA3GxXkR-mt7XOtecsJSE8WjGAIhJLsjV9nWRI,7100
-tsam/utils/segmentation.py,sha256=y8TPv1KEqf6ByOz7TRywm3WC9ZPhGiWvhwAcQbFibt4,6132
-tsam-2.3.2.dist-info/LICENSE.txt,sha256=XEzEzumoCmdJzcp5gKT6UOtKrkH-SiGpxVbIfihkNK4,1224
-tsam-2.3.2.dist-info/METADATA,sha256=jyD9NgubM4lzgeECguLdiGDF0_fKUgygjlYbVDBMCdQ,12404
-tsam-2.3.2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-tsam-2.3.2.dist-info/top_level.txt,sha256=MFI15PnPuMv8F1hTAOXbjGu41z-l6dJbnK69WlIQNcM,5
-tsam-2.3.2.dist-info/RECORD,,