tsam 2.3.5__tar.gz → 2.3.6__tar.gz

{tsam-2.3.5 → tsam-2.3.6}/PKG-INFO

@@ -1,10 +1,30 @@
 Metadata-Version: 2.1
 Name: tsam
-Version: 2.3.5
+Version: 2.3.6
 Summary: Time series aggregation module (tsam) to create typical periods
-Home-page: https://github.com/FZJ-IEK3-VSA/tsam
-Author: Leander Kotzur, Maximilian Hoffmann
-Author-email: leander.kotzur@googlemail.com, maximilian.hoffmann@julumni.fz-juelich.de
+Author-email: Leander Kotzur <leander.kotzur@googlemail.com>, Maximilian Hoffmann <maximilian.hoffmann@julumni.fz-juelich.de>
+Maintainer-email: Julian Belina <j.belina@fz-juelich.de>
+License: MIT License
+        
+        Copyright (c) 2017 Leander Kotzur (FZJ IEK-3), Maximilian Hoffmann (FZJ IEK-3), Peter Markewitz (FZJ IEK-3), Martin Robinius (FZJ IEK-3), Detlef Stolten (FZJ IEK-3)
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
 Keywords: clustering,optimization
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: End Users/Desktop
@@ -17,7 +37,7 @@ Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: <3.13,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: scikit-learn>=0.0
@@ -27,8 +47,16 @@ Requires-Dist: pyomo>=6.4.3
 Requires-Dist: networkx
 Requires-Dist: tqdm
 Requires-Dist: highspy
-
-[![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)
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: codecov; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autobuild; extra == "dev"
+Requires-Dist: sphinx_book_theme; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+[![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> 
@@ -49,28 +77,50 @@ The documentation of the tsam code can be found [**here**](https://tsam.readthed
 
 
 ## Installation
+It is recommended to install tsam within its own environment. If you are no familiar with python environments, plaese consider to read some [external documentation](https://realpython.com/python-virtual-environments-a-primer/). In the following we assume you have a [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) or [conda](https://www.anaconda.com/) installation.  All conda and mamba command are interchangeable.
+
+### Direct Installations from Package Manager Repositories
+
+If you want to prevent any possible dependency conflicts create a new environment using the following command:
+
+	mamba create -n tsam_env python pip
+
+Activate an existing or the newly create environment afterward
+
+	mamba activate tsam_env
+
 Directly install via pip from pypi as follows:
 
 	pip install tsam
 
-of install from conda forge with the following command:
+or install from conda forge with the following command:
 
 	conda install tsam -c conda-forge
 
+### Local Installation for Development
 Alternatively, clone a local copy of the repository to your computer
 
 	git clone https://github.com/FZJ-IEK3-VSA/tsam.git
-	
-Then install tsam via pip as follow
-	
+
+Change the directory of your shell into the root folder of the repository
+
 	cd tsam
-	pip install . 
-	
-Or install directly via python as 
 
-	python setup.py install
+For development, it is recommended to install tsam into its own environment using conda e.g.
+
+	conda env create --file=requirement.yml
+
+Afterward activate the environment
+
+	conda activate tsam_env
+
+Then install tsam via pip as follows
+	
+	
+	pip install -e .[dev]
 	
-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.
+### Installation of MILP Solver for k-medoids	
+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 installed and 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
 
@@ -136,7 +186,7 @@ Copyright (C) 2016-2022 Leander Kotzur (FZJ IEK-3), Maximilian Hoffmann (FZJ IEK
 You should have received a copy of the MIT License along with this program.
 If not, see https://opensource.org/licenses/MIT
 
-The core developer team sits in the [Institute of Energy and Climate Research - Techno-Economic Energy Systems Analysis (IEK-3)](https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html) belonging to the [Forschungszentrum Jülich](https://www.fz-juelich.de/).
+The core developer team sits in the [Institute of Energy and Climate Research - Techno-Economic Energy Systems Analysis (IEK-3)](https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html) belonging to the [Forschungszentrum Jülich](https://www.fz-juelich.de/).
 
 ## Citing and further reading
 
@@ -155,7 +205,7 @@ The publications about time series aggregation for energy system optimization mo
 [**Typical periods or typical time steps? A multi-model analysis to determine the optimal temporal aggregation for energy system models**](https://www.sciencedirect.com/science/article/abs/pii/S0306261921011545)
 * Hoffmann et al. (2020):\
 [**A Review on Time Series Aggregation Methods for Energy System Models**](https://www.mdpi.com/1996-1073/13/3/641)
-* Kannengießer et al. (2019):\
+* Kannengießer et al. (2019):\
 [**Reducing Computational Load for Mixed Integer Linear Programming: An Example for a District and an Island Energy System**](https://www.mdpi.com/1996-1073/12/14/2825)
 * Kotzur et al. (2018):\
 [**Time series aggregation for energy system design: Modeling seasonal storage**](https://www.sciencedirect.com/science/article/pii/S0306261918300242)\

{tsam-2.3.5 → tsam-2.3.6}/README.md

@@ -19,28 +19,50 @@ The documentation of the tsam code can be found [**here**](https://tsam.readthed
 
 
 ## Installation
+It is recommended to install tsam within its own environment. If you are no familiar with python environments, plaese consider to read some [external documentation](https://realpython.com/python-virtual-environments-a-primer/). In the following we assume you have a [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) or [conda](https://www.anaconda.com/) installation.  All conda and mamba command are interchangeable.
+
+### Direct Installations from Package Manager Repositories
+
+If you want to prevent any possible dependency conflicts create a new environment using the following command:
+
+	mamba create -n tsam_env python pip
+
+Activate an existing or the newly create environment afterward
+
+	mamba activate tsam_env
+
 Directly install via pip from pypi as follows:
 
 	pip install tsam
 
-of install from conda forge with the following command:
+or install from conda forge with the following command:
 
 	conda install tsam -c conda-forge
 
+### Local Installation for Development
 Alternatively, clone a local copy of the repository to your computer
 
 	git clone https://github.com/FZJ-IEK3-VSA/tsam.git
-	
-Then install tsam via pip as follow
-	
+
+Change the directory of your shell into the root folder of the repository
+
 	cd tsam
-	pip install . 
-	
-Or install directly via python as 
 
-	python setup.py install
+For development, it is recommended to install tsam into its own environment using conda e.g.
+
+	conda env create --file=requirement.yml
+
+Afterward activate the environment
+
+	conda activate tsam_env
+
+Then install tsam via pip as follows
+	
+	
+	pip install -e .[dev]
 	
-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.
+### Installation of MILP Solver for k-medoids	
+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 installed and 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
 

tsam-2.3.6/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=64.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "tsam"
+version = "2.3.6"
+description = "Time series aggregation module (tsam) to create typical periods"
+authors = [
+    { name = "Leander Kotzur", email = "leander.kotzur@googlemail.com" },
+    { name = "Maximilian Hoffmann", email = "maximilian.hoffmann@julumni.fz-juelich.de" },
+]
+maintainers = [
+  {name = "Julian Belina", email = "j.belina@fz-juelich.de"}
+]
+license = { file = "LICENSE.txt" }
+keywords = ["clustering", "optimization"]
+requires-python = ">=3.9,<3.13"
+readme = "README.md"
+classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: End Users/Desktop",
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 3",
+        "Topic :: Scientific/Engineering :: Mathematics",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+    ]
+dynamic = ["dependencies", "optional-dependencies"]
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies = {dev = { file = ["requirements_dev.txt"] }}
+
+
+#Configureation options
+# https://docs.pytest.org/en/7.1.x/reference/reference.html#configuration-options
+
+[tool.pytest.ini_options]
+testpaths = ["test"] # Sets the path where to look for tests
+pythonpath =["test"] # Sets the path which should be prepended to pythonpath relative to the root folder
+console_output_style = "count"
+
+

{tsam-2.3.5 → tsam-2.3.6}/requirements.yml

@@ -1,8 +1,6 @@
-name: tsam
+name: tsam_env
 channels:
   - conda-forge
 dependencies:
   - python>=3.9,<3.13
   - pip
-  - pip:
-    - -r requirements.txt

{tsam-2.3.5 → tsam-2.3.6}/requirements_dev.txt

@@ -1,8 +1,7 @@
--r requirements.txt
-
 # Testing
 pytest
 pytest-cov
+codecov
 
 # Documentation
 sphinx

{tsam-2.3.5 → tsam-2.3.6/src}/tsam/utils/durationRepresentation.py

@@ -57,17 +57,18 @@ def durationRepresentation(
                 # get all the values of a certain attribute and cluster
                 candidateValues = candidates.loc[indice[0], a]
                 # sort all values
-                sortedAttr = candidateValues.stack(future_stack=True,).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)
                 # respect max and min of the attributes
                 if representMinMax:
                     representationValues.loc[0] = sortedAttr.values[0]
-                    representationValues.loc[
-                        representationValues.index[-1]
-                    ] = sortedAttr.values[-1]
-
+                    representationValues.loc[representationValues.index[-1]] = (
+                        sortedAttr.values[-1]
+                    )
 
                 # get the order of the representation values such that euclidean distance to the candidates is minimized
                 order = candidateValues.mean().sort_values().index
@@ -97,8 +98,12 @@ def durationRepresentation(
             # concat centroid values and cluster weights for all clusters
             meansAndWeights = pd.concat(
                 [
-                    pd.DataFrame(np.array(meanVals)).stack(future_stack=True,),
-                    pd.DataFrame(np.array(clusterLengths)).stack(future_stack=True,),
+                    pd.DataFrame(np.array(meanVals)).stack(
+                        future_stack=True,
+                    ),
+                    pd.DataFrame(np.array(clusterLengths)).stack(
+                        future_stack=True,
+                    ),
                 ],
                 axis=1,
             )
@@ -107,7 +112,14 @@ 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(future_stack=True,).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 = []
@@ -124,8 +136,7 @@ def durationRepresentation(
                     keepSum=True,
                 )
 
-
-            # transform all representation values to a data frame and arrange it 
+            # transform all representation values to a data frame and arrange it
             # according to the order of the sorted
             # centroid values
             representationValues = pd.DataFrame(np.array(representationValues))
@@ -139,9 +150,9 @@ def durationRepresentation(
     return clusterCenters
 
 
-
-def _representMinMax(representationValues, sortedAttr, meansAndWeightsSorted, 
-                     keepSum=True):
+def _representMinMax(
+    representationValues, sortedAttr, meansAndWeightsSorted, keepSum=True
+):
     """
     Represents the the min and max values of the original time series in the
     duration curve representation such that the min and max values of the
@@ -164,8 +175,8 @@ def _representMinMax(representationValues, sortedAttr, meansAndWeightsSorted,
     if np.any(np.array(representationValues) < 0):
         raise ValueError("Negative values in the duration curve representation")
 
-    # first retrieve the change of the values to the min and max values 
-    # of the original time series and their duration in the original 
+    # first retrieve the change of the values to the min and max values
+    # of the original time series and their duration in the original
     # time series
     delta_max = sortedAttr.max() - representationValues[-1]
     appearance_max = meansAndWeightsSorted[1].iloc[-1]
@@ -174,31 +185,36 @@ def _representMinMax(representationValues, sortedAttr, meansAndWeightsSorted,
 
     if delta_min == 0 and delta_max == 0:
         return representationValues
-    
+
     if keepSum:
 
-        # now anticipate the shift of the sum of the time series 
+        # now anticipate the shift of the sum of the time series
         # due to the change of the min and max values
         # of the duration curve
         delta_sum = delta_max * appearance_max + delta_min * appearance_min
-        # and derive how much the other values have to be changed to preserve 
+        # and derive how much the other values have to be changed to preserve
         # the mean of the duration curve
-        correction_factor = - delta_sum / (meansAndWeightsSorted[1].iloc[1:-1] 
-                                            * representationValues[1:-1]).sum()
-        
+        correction_factor = (
+            -delta_sum
+            / (meansAndWeightsSorted[1].iloc[1:-1] * representationValues[1:-1]).sum()
+        )
+
         if correction_factor < -1 or correction_factor > 1:
-            warnings.warn("The cluster is to small to preserve the sum of the duration curve and additionally the min and max values of the original cluster members. The min max values of the cluster are not preserved. This does not necessarily mean that the min and max values of the original time series are not preserved.")
+            warnings.warn(
+                "The cluster is too small to preserve the sum of the duration curve and additionally the min and max values of the original cluster members. The min max values of the cluster are not preserved. This does not necessarily mean that the min and max values of the original time series are not preserved."
+            )
             return representationValues
 
-        # correct the values of the duration curve such 
+        # correct the values of the duration curve such
         # that the mean of the duration curve is preserved
         # since the min and max values are changed
-        representationValues[1:-1] = np.multiply(representationValues[1:-1], (
-            1+ correction_factor))
-        
-    # change the values of the duration curve such that the min and max 
+        representationValues[1:-1] = np.multiply(
+            representationValues[1:-1], (1 + correction_factor)
+        )
+
+    # change the values of the duration curve such that the min and max
     # values are preserved
     representationValues[-1] += delta_max
     representationValues[0] += delta_min
-    
+
     return representationValues

{tsam-2.3.5 → tsam-2.3.6/src}/tsam.egg-info/PKG-INFO

@@ -1,10 +1,30 @@
 Metadata-Version: 2.1
 Name: tsam
-Version: 2.3.5
+Version: 2.3.6
 Summary: Time series aggregation module (tsam) to create typical periods
-Home-page: https://github.com/FZJ-IEK3-VSA/tsam
-Author: Leander Kotzur, Maximilian Hoffmann
-Author-email: leander.kotzur@googlemail.com, maximilian.hoffmann@julumni.fz-juelich.de
+Author-email: Leander Kotzur <leander.kotzur@googlemail.com>, Maximilian Hoffmann <maximilian.hoffmann@julumni.fz-juelich.de>
+Maintainer-email: Julian Belina <j.belina@fz-juelich.de>
+License: MIT License
+        
+        Copyright (c) 2017 Leander Kotzur (FZJ IEK-3), Maximilian Hoffmann (FZJ IEK-3), Peter Markewitz (FZJ IEK-3), Martin Robinius (FZJ IEK-3), Detlef Stolten (FZJ IEK-3)
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
 Keywords: clustering,optimization
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: End Users/Desktop
@@ -17,7 +37,7 @@ Classifier: Programming Language :: Python :: 2
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: <3.13,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: scikit-learn>=0.0
@@ -27,8 +47,16 @@ Requires-Dist: pyomo>=6.4.3
 Requires-Dist: networkx
 Requires-Dist: tqdm
 Requires-Dist: highspy
-
-[![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)
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: codecov; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autobuild; extra == "dev"
+Requires-Dist: sphinx_book_theme; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+[![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> 
@@ -49,28 +77,50 @@ The documentation of the tsam code can be found [**here**](https://tsam.readthed
 
 
 ## Installation
+It is recommended to install tsam within its own environment. If you are no familiar with python environments, plaese consider to read some [external documentation](https://realpython.com/python-virtual-environments-a-primer/). In the following we assume you have a [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) or [conda](https://www.anaconda.com/) installation.  All conda and mamba command are interchangeable.
+
+### Direct Installations from Package Manager Repositories
+
+If you want to prevent any possible dependency conflicts create a new environment using the following command:
+
+	mamba create -n tsam_env python pip
+
+Activate an existing or the newly create environment afterward
+
+	mamba activate tsam_env
+
 Directly install via pip from pypi as follows:
 
 	pip install tsam
 
-of install from conda forge with the following command:
+or install from conda forge with the following command:
 
 	conda install tsam -c conda-forge
 
+### Local Installation for Development
 Alternatively, clone a local copy of the repository to your computer
 
 	git clone https://github.com/FZJ-IEK3-VSA/tsam.git
-	
-Then install tsam via pip as follow
-	
+
+Change the directory of your shell into the root folder of the repository
+
 	cd tsam
-	pip install . 
-	
-Or install directly via python as 
 
-	python setup.py install
+For development, it is recommended to install tsam into its own environment using conda e.g.
+
+	conda env create --file=requirement.yml
+
+Afterward activate the environment
+
+	conda activate tsam_env
+
+Then install tsam via pip as follows
+	
+	
+	pip install -e .[dev]
 	
-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.
+### Installation of MILP Solver for k-medoids	
+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 installed and 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
 
@@ -136,7 +186,7 @@ Copyright (C) 2016-2022 Leander Kotzur (FZJ IEK-3), Maximilian Hoffmann (FZJ IEK
 You should have received a copy of the MIT License along with this program.
 If not, see https://opensource.org/licenses/MIT
 
-The core developer team sits in the [Institute of Energy and Climate Research - Techno-Economic Energy Systems Analysis (IEK-3)](https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html) belonging to the [Forschungszentrum Jülich](https://www.fz-juelich.de/).
+The core developer team sits in the [Institute of Energy and Climate Research - Techno-Economic Energy Systems Analysis (IEK-3)](https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html) belonging to the [Forschungszentrum Jülich](https://www.fz-juelich.de/).
 
 ## Citing and further reading
 
@@ -155,7 +205,7 @@ The publications about time series aggregation for energy system optimization mo
 [**Typical periods or typical time steps? A multi-model analysis to determine the optimal temporal aggregation for energy system models**](https://www.sciencedirect.com/science/article/abs/pii/S0306261921011545)
 * Hoffmann et al. (2020):\
 [**A Review on Time Series Aggregation Methods for Energy System Models**](https://www.mdpi.com/1996-1073/13/3/641)
-* Kannengießer et al. (2019):\
+* Kannengießer et al. (2019):\
 [**Reducing Computational Load for Mixed Integer Linear Programming: An Example for a District and an Island Energy System**](https://www.mdpi.com/1996-1073/12/14/2825)
 * Kotzur et al. (2018):\
 [**Time series aggregation for energy system design: Modeling seasonal storage**](https://www.sciencedirect.com/science/article/pii/S0306261918300242)\

tsam-2.3.6/src/tsam.egg-info/SOURCES.txt

@@ -0,0 +1,54 @@
+LICENSE.txt
+MANIFEST.in
+README.md
+pyproject.toml
+requirements.txt
+requirements.yml
+requirements_dev.txt
+examples/testdata.csv
+examples/results/paretoOptimalAggregation.csv
+examples/results/preprocessed_wind.csv
+examples/results/testperiods_hierarchical.csv
+examples/results/testperiods_kmeans.csv
+examples/results/testperiods_kmedoids.csv
+examples/results/testperiods_predefClusterOrder.csv
+examples/results/testperiods_predefClusterOrderAndClusterCenters.csv
+examples/results/testperiods_segmentation.csv
+src/tsam/__init__.py
+src/tsam/hyperparametertuning.py
+src/tsam/periodAggregation.py
+src/tsam/representations.py
+src/tsam/timeseriesaggregation.py
+src/tsam.egg-info/PKG-INFO
+src/tsam.egg-info/SOURCES.txt
+src/tsam.egg-info/dependency_links.txt
+src/tsam.egg-info/requires.txt
+src/tsam.egg-info/top_level.txt
+src/tsam/utils/__init__.py
+src/tsam/utils/durationRepresentation.py
+src/tsam/utils/k_maxoids.py
+src/tsam/utils/k_medoids_contiguity.py
+src/tsam/utils/k_medoids_exact.py
+src/tsam/utils/segmentation.py
+test/test_accuracyIndicators.py
+test/test_adjacent_periods.py
+test/test_aggregate_hiearchical.py
+test/test_assert_raises.py
+test/test_averaging.py
+test/test_cluster_order.py
+test/test_durationCurve.py
+test/test_durationRepresentation.py
+test/test_extremePeriods.py
+test/test_hierarchical.py
+test/test_hypertuneAggregation.py
+test/test_k_maxoids.py
+test/test_k_medoids.py
+test/test_k_medoids_contiguity.py
+test/test_minmaxRepresentation.py
+test/test_preprocess.py
+test/test_properties.py
+test/test_samemean.py
+test/test_segmentation.py
+test/test_subhourlyResolution.py
+test/test_subhourly_periods.py
+test/test_weightingFactors.py

{tsam-2.3.5 → tsam-2.3.6/src}/tsam.egg-info/requires.txt

@@ -5,3 +5,12 @@ pyomo>=6.4.3
 networkx
 tqdm
 highspy
+
+[dev]
+pytest
+pytest-cov
+codecov
+sphinx
+sphinx-autobuild
+sphinx_book_theme
+twine