[](https://github.com/FZJ-IEK3-VSA/tsam/actions) [](https://pypi.python.org/pypi/tsam) [](https://tsam.readthedocs.io/en/latest/) []((https://github.com/FZJ-IEK3-VSA/tsam/blob/master/LICENSE.txt)) [](https://codecov.io/gh/FZJ-IEK3-VSA/tsam)
[](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>
# tsam - Time Series Aggregation Module
tsam is a python package which uses different machine learning algorithms for the aggregation of time series. The data aggregation can be performed in two freely combinable dimensions: By representing the time series by a user-defined number of typical periods or by decreasing the temporal resolution.
tsam was originally designed for reducing the computational load for large-scale energy system optimization models by aggregating their input data, but is applicable for all types of time series, e.g., weather data, load data, both simultaneously or other arbitrary groups of time series.
The documentation of the tsam code can be found [**here**](https://tsam.readthedocs.io/en/latest/index.html).
## Features
* flexible handling of multidimensional time-series via the pandas module
* different aggregation methods implemented (averaging, k-means, exact k-medoids, hierarchical, k-maxoids, k-medoids with contiguity), which are based on scikit-learn, or self-programmed with pyomo
* hypertuning of aggregation parameters to find the optimal combination of the number of segments inside a period and the number of typical periods
* novel representation methods, keeping statistical attributes, such as the distribution
* flexible integration of extreme periods as own cluster centers
* weighting for the case of multidimensional time-series to represent their relevance
## Installation
Directly install via pip as follows:
pip install tsam
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
cd tsam
pip install .
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.
## Examples
### Basic workflow
A small example how tsam can be used is decribed as follows
```python
import pandas as pd
import tsam.timeseriesaggregation as tsam
```
Read in the time series data set with pandas
```python
raw = pd.read_csv('testdata.csv', index_col = 0)
```
Initialize an aggregation object and define the length of a single period, the number of typical periods, the number of segments in each period, the aggregation method and the representation method - here duration/distribution representation which contains the minimum and maximum value of the original time series
```python
aggregation = tsam.TimeSeriesAggregation(raw,
noTypicalPeriods = 8,
hoursPerPeriod = 24,
segmentation = True,
noSegments = 8,
representationMethod = "distributionAndMinMaxRepresentation",
distributionPeriodWise = False
clusterMethod = 'hierarchical'
)
```
Run the aggregation to typical periods
```python
typPeriods = aggregation.createTypicalPeriods()
```
Store the results as .csv file
```python
typPeriods.to_csv('typperiods.csv')
```
### Detailed examples
A [**first example**](/examples/aggregation_example.ipynb) shows the capabilites of tsam as jupyter notebook.
A [**second example**](/examples/aggregation_optiinput.ipynb) shows in more detail how to access the relevant aggregation results required for paramtrizing e.g. an optimization.
The example time series are based on a department [publication](https://www.mdpi.com/1996-1073/10/3/361) and the [test reference years of the DWD](https://www.dwd.de/DE/leistungen/testreferenzjahre/testreferenzjahre.html).
## License
MIT License
Copyright (C) 2016-2022 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)
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/).
## Citing and further reading
If you want to use tsam in a published work, **please kindly cite** our latest journal articles:
* Hoffmann et al. (2022):\
[**The Pareto-Optimal Temporal Aggregation of Energy System Models**](https://www.sciencedirect.com/science/article/abs/pii/S0306261922004342)
If you are further interested in the impact of time series aggregation on the cost-optimal results on different energy system use cases, you can find a publication which validates the methods and describes their cababilites via the following [**link**](https://www.sciencedirect.com/science/article/pii/S0960148117309783). A second publication introduces a method how to model state variables (e.g. the state of charge of energy storage components) between the aggregated typical periods which can be found [**here**](https://www.sciencedirect.com/science/article/pii/S0306261918300242). Finally yet importantly the potential of time series aggregation to simplify mixed integer linear problems is investigated [**here**](https://www.mdpi.com/1996-1073/12/14/2825).
The publications about time series aggregation for energy system optimization models published alongside the development of tsam are listed below:
* Hoffmann et al. (2021):\
[**The Pareto-Optimal Temporal Aggregation of Energy System Models**](https://www.sciencedirect.com/science/article/abs/pii/S0306261922004342)\
(open access manuscript to be found [**here**](https://arxiv.org/abs/1710.07593))
* Hoffmann et al. (2021):\
[**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):\
[**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)\
(open access manuscript to be found [**here**](https://arxiv.org/abs/1710.07593))
* Kotzur et al. (2018):\
[**Impact of different time series aggregation methods on optimal energy system design**](https://www.sciencedirect.com/science/article/abs/pii/S0960148117309783)\
(open access manuscript to be found [**here**](https://arxiv.org/abs/1708.00420))
## Acknowledgement
This work is supported by the Helmholtz Association under the Joint Initiative ["Energy System 2050 A Contribution of the Research Field Energy"](https://www.helmholtz.de/en/research/energy/energy_system_2050/) and the program ["Energy System Design"](https://www.esd.kit.edu/index.php) and within the [BMWi/BMWk](https://www.bmwk.de/Navigation/DE/Home/home.html) funded project [**METIS**](http://www.metis-platform.net/).
<a href="https://www.helmholtz.de/en/"><img src="https://www.helmholtz.de/fileadmin/user_upload/05_aktuelles/Marke_Design/logos/HG_LOGO_S_ENG_RGB.jpg" alt="Helmholtz Logo" width="200px" style="float:right"></a>
Raw data
{
"_id": null,
"home_page": "https://github.com/FZJ-IEK3-VSA/tsam",
"name": "tsam",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "clustering,optimization",
"author": "Leander Kotzur, Maximilian Hoffmann",
"author_email": "leander.kotzur@googlemail.com, max.hoffmann@fz-juelich.de",
"download_url": "https://files.pythonhosted.org/packages/23/d7/e3953224b9fd3d4cab52563c12fbd1305c194cc77c3fc52c7b32ddfa3ace/tsam-2.3.1.tar.gz",
"platform": null,
"description": "\ufeff[](https://github.com/FZJ-IEK3-VSA/tsam/actions) [](https://pypi.python.org/pypi/tsam) [](https://tsam.readthedocs.io/en/latest/) []((https://github.com/FZJ-IEK3-VSA/tsam/blob/master/LICENSE.txt)) [](https://codecov.io/gh/FZJ-IEK3-VSA/tsam)\n[](https://mybinder.org/v2/gh/FZJ-IEK3-VSA/voila-tsam/HEAD?urlpath=voila/render/Time-Series-Aggregation-Module.ipynb)\n\n<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> \n\n# tsam - Time Series Aggregation Module\ntsam is a python package which uses different machine learning algorithms for the aggregation of time series. The data aggregation can be performed in two freely combinable dimensions: By representing the time series by a user-defined number of typical periods or by decreasing the temporal resolution.\ntsam was originally designed for reducing the computational load for large-scale energy system optimization models by aggregating their input data, but is applicable for all types of time series, e.g., weather data, load data, both simultaneously or other arbitrary groups of time series.\n\nThe documentation of the tsam code can be found [**here**](https://tsam.readthedocs.io/en/latest/index.html).\n\n## Features\n* flexible handling of multidimensional time-series via the pandas module\n* different aggregation methods implemented (averaging, k-means, exact k-medoids, hierarchical, k-maxoids, k-medoids with contiguity), which are based on scikit-learn, or self-programmed with pyomo\n* hypertuning of aggregation parameters to find the optimal combination of the number of segments inside a period and the number of typical periods\n* novel representation methods, keeping statistical attributes, such as the distribution \n* flexible integration of extreme periods as own cluster centers\n* weighting for the case of multidimensional time-series to represent their relevance\n\n\n## Installation\nDirectly install via pip as follows:\n\n\tpip install tsam\n\nAlternatively, clone a local copy of the repository to your computer\n\n\tgit clone https://github.com/FZJ-IEK3-VSA/tsam.git\n\t\nThen install tsam via pip as follow\n\t\n\tcd tsam\n\tpip install . \n\t\nOr install directly via python as \n\n\tpython setup.py install\n\t\nIn 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.\n\t\n\t\n## Examples\n\n### Basic workflow\n\nA small example how tsam can be used is decribed as follows\n```python\n\timport pandas as pd\n\timport tsam.timeseriesaggregation as tsam\n```\n\n\nRead in the time series data set with pandas\n```python\n\traw = pd.read_csv('testdata.csv', index_col = 0)\n```\n\nInitialize an aggregation object and define the length of a single period, the number of typical periods, the number of segments in each period, the aggregation method and the representation method - here duration/distribution representation which contains the minimum and maximum value of the original time series \n```python\n\taggregation = tsam.TimeSeriesAggregation(raw, \n\t\t\t\t\t\tnoTypicalPeriods = 8, \n\t\t\t\t\t\thoursPerPeriod = 24, \n\t\t\t\t\t\tsegmentation = True,\n\t\t\t\t\t\tnoSegments = 8,\n\t\t\t\t\t\trepresentationMethod = \"distributionAndMinMaxRepresentation\",\n\t\t\t\t\t\tdistributionPeriodWise = False\n\t\t\t\t\t\tclusterMethod = 'hierarchical'\n\t\t\t\t\t\t)\n```\n\nRun the aggregation to typical periods\n```python\n\ttypPeriods = aggregation.createTypicalPeriods()\n```\n\nStore the results as .csv file\n\t\n```python\n\ttypPeriods.to_csv('typperiods.csv')\n```\n\n### Detailed examples\n\nA [**first example**](/examples/aggregation_example.ipynb) shows the capabilites of tsam as jupyter notebook. \n\nA [**second example**](/examples/aggregation_optiinput.ipynb) shows in more detail how to access the relevant aggregation results required for paramtrizing e.g. an optimization.\n\nThe example time series are based on a department [publication](https://www.mdpi.com/1996-1073/10/3/361) and the [test reference years of the DWD](https://www.dwd.de/DE/leistungen/testreferenzjahre/testreferenzjahre.html).\n\n## License\n\nMIT License\n\nCopyright (C) 2016-2022 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)\n\nYou should have received a copy of the MIT License along with this program.\nIf not, see https://opensource.org/licenses/MIT\n\nThe 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\u00fclich](https://www.fz-juelich.de/).\n\n## Citing and further reading\n\nIf you want to use tsam in a published work, **please kindly cite** our latest journal articles:\n* Hoffmann et al. (2022):\\\n[**The Pareto-Optimal Temporal Aggregation of Energy System Models**](https://www.sciencedirect.com/science/article/abs/pii/S0306261922004342)\n\n\nIf you are further interested in the impact of time series aggregation on the cost-optimal results on different energy system use cases, you can find a publication which validates the methods and describes their cababilites via the following [**link**](https://www.sciencedirect.com/science/article/pii/S0960148117309783). A second publication introduces a method how to model state variables (e.g. the state of charge of energy storage components) between the aggregated typical periods which can be found [**here**](https://www.sciencedirect.com/science/article/pii/S0306261918300242). Finally yet importantly the potential of time series aggregation to simplify mixed integer linear problems is investigated [**here**](https://www.mdpi.com/1996-1073/12/14/2825).\n\nThe publications about time series aggregation for energy system optimization models published alongside the development of tsam are listed below:\n* Hoffmann et al. (2021):\\\n[**The Pareto-Optimal Temporal Aggregation of Energy System Models**](https://www.sciencedirect.com/science/article/abs/pii/S0306261922004342)\\\n(open access manuscript to be found [**here**](https://arxiv.org/abs/1710.07593))\n* Hoffmann et al. (2021):\\\n[**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)\n* Hoffmann et al. (2020):\\\n[**A Review on Time Series Aggregation Methods for Energy System Models**](https://www.mdpi.com/1996-1073/13/3/641)\n* Kannengie\u00dfer et al. (2019):\\\n[**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)\n* Kotzur et al. (2018):\\\n[**Time series aggregation for energy system design: Modeling seasonal storage**](https://www.sciencedirect.com/science/article/pii/S0306261918300242)\\\n(open access manuscript to be found [**here**](https://arxiv.org/abs/1710.07593))\n* Kotzur et al. (2018):\\\n[**Impact of different time series aggregation methods on optimal energy system design**](https://www.sciencedirect.com/science/article/abs/pii/S0960148117309783)\\\n(open access manuscript to be found [**here**](https://arxiv.org/abs/1708.00420))\n\n\n\n## Acknowledgement\n\nThis work is supported by the Helmholtz Association under the Joint Initiative [\"Energy System 2050 A Contribution of the Research Field Energy\"](https://www.helmholtz.de/en/research/energy/energy_system_2050/) and the program [\"Energy System Design\"](https://www.esd.kit.edu/index.php) and within the [BMWi/BMWk](https://www.bmwk.de/Navigation/DE/Home/home.html) funded project [**METIS**](http://www.metis-platform.net/).\n\n<a href=\"https://www.helmholtz.de/en/\"><img src=\"https://www.helmholtz.de/fileadmin/user_upload/05_aktuelles/Marke_Design/logos/HG_LOGO_S_ENG_RGB.jpg\" alt=\"Helmholtz Logo\" width=\"200px\" style=\"float:right\"></a>\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Time series aggregation module (tsam) to create typical periods",
"version": "2.3.1",
"project_urls": {
"Homepage": "https://github.com/FZJ-IEK3-VSA/tsam"
},
"split_keywords": [
"clustering",
"optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23d7e3953224b9fd3d4cab52563c12fbd1305c194cc77c3fc52c7b32ddfa3ace",
"md5": "6275a102d302ded36e0790c735ed5d3e",
"sha256": "ce75db4e18f3110c08bd78325ae368b2259688ad93f5bf0b72813ff6e0aa6503"
},
"downloads": -1,
"filename": "tsam-2.3.1.tar.gz",
"has_sig": false,
"md5_digest": "6275a102d302ded36e0790c735ed5d3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1764356,
"upload_time": "2023-08-25T07:10:17",
"upload_time_iso_8601": "2023-08-25T07:10:17.761640Z",
"url": "https://files.pythonhosted.org/packages/23/d7/e3953224b9fd3d4cab52563c12fbd1305c194cc77c3fc52c7b32ddfa3ace/tsam-2.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-25 07:10:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FZJ-IEK3-VSA",
"github_project": "tsam",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "tsam"
}
JSON
