tsam

A Python package which uses different machine learning algorithms for the aggregation of time series.
https://github.com/fzj-iek3-vsa/tsam

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords

aggregation clustering energy-system optimization python time-series timeseries typical-periods

Keywords from Contributors

renewable-energy energy-system-model geospatial-analysis

Last synced: about 18 hours ago
JSON representation

Repository metadata

Time series aggregation module (tsam). Determines typical operation periods or dereases the temporal resolution. Accelerates model or experiment runs.

Host: GitHub
URL: https://github.com/fzj-iek3-vsa/tsam
Owner: FZJ-IEK3-VSA
License: mit
Created: 2017-05-15T08:36:11.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-10-15T12:48:00.000Z (6 months ago)
Last Synced: 2025-04-20T09:44:19.590Z (7 days ago)
Topics: aggregation, clustering, energy-system, optimization, python, time-series, timeseries, typical-periods
Language: Python
Homepage: https://tsam.readthedocs.io/
Size: 11.1 MB
Stars: 159
Watchers: 12
Forks: 34
Open Issues: 3
Releases: 20
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

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.

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

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. In the following we assume you have a mamba or conda 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

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

Change the directory of your shell into the root folder of the repository

cd tsam

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]

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 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

In order to setup a virtual environment in Linux, correct the python name in the Makefile and call

make setup_venv

Examples

Basic workflow

A small example how tsam can be used is decribed as follows

	import pandas as pd
	import tsam.timeseriesaggregation as tsam

Read in the time series data set with pandas

	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

	aggregation = tsam.TimeSeriesAggregation(raw, 
						noTypicalPeriods = 8, 
						hoursPerPeriod = 24, 
						segmentation = True,
						noSegments = 8,
						representationMethod = "distributionAndMinMaxRepresentation",
						distributionPeriodWise = False
						clusterMethod = 'hierarchical'
						)

Run the aggregation to typical periods

	typPeriods = aggregation.createTypicalPeriods()

Store the results as .csv file

	typPeriods.to_csv('typperiods.csv')

Detailed examples

A first example shows the capabilites of tsam as jupyter notebook.

A second example 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 and the test reference years of the DWD.

License

MIT License

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) belonging to the Forschungszentrum Jülich.

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

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. 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. Finally yet importantly the potential of time series aggregation to simplify mixed integer linear problems is investigated here.

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
(open access manuscript to be found here)
Hoffmann et al. (2021):
Typical periods or typical time steps? A multi-model analysis to determine the optimal temporal aggregation for energy system models
Hoffmann et al. (2020):
A Review on Time Series Aggregation Methods for Energy System Models
Kannengießer et al. (2019):
Reducing Computational Load for Mixed Integer Linear Programming: An Example for a District and an Island Energy System
Kotzur et al. (2018):
Time series aggregation for energy system design: Modeling seasonal storage
(open access manuscript to be found here)
Kotzur et al. (2018):
Impact of different time series aggregation methods on optimal energy system design
(open access manuscript to be found here)

Acknowledgement

This work is supported by the Helmholtz Association under the Joint Initiative "Energy System 2050 A Contribution of the Research Field Energy" and the program "Energy System Design" and within the BMWi/BMWk funded project METIS.

Owner metadata

Name: Forschungszentrum Jülich - Jülich Systems Analysis
Login: FZJ-IEK3-VSA
Email:
Kind: organization
Description: Institute of Climate and Energy Systems (ICE)
Website: https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html
Location: Forschungszentrum Jülich
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/28654423?v=4
Repositories: 16
Last ynced at: 2024-12-23T04:12:17.721Z
Profile URL: https://github.com/FZJ-IEK3-VSA

GitHub Events

Total

Watch event: 12
Issue comment event: 4
Pull request event: 1
Fork event: 1

Last Year

Watch event: 12
Issue comment event: 4
Pull request event: 1
Fork event: 1

Committers metadata

Last synced: 4 days ago

Total Commits: 314
Total Committers: 20
Avg Commits per committer: 15.7
Development Distribution Score (DDS): 0.573

Commits in past year: 21
Committers in past year: 4
Avg Commits per committer in past year: 5.25
Development Distribution Score (DDS) in past year: 0.571

Name	Email	Commits
l-kotzur	l**r@f**e	134
maximilian-hoffmann	m**n@f**e	98
Leander Kotzur	l**r@r**e	26
j.schoenau	j**u@f**e	10
julian-belina	5****a	9
Julian Schönau	6****e	7
Cord Kaldemeyer	c**r@f**e	4
Fabian Neumann	f**n@o**e	4
Samuel Letellier-Duchesne	s**e@m**m	4
Amedeo Paolo Ceruti	g**z@m**e	3
Robert Schwarz	r**t@d**l	3
Lars Schellhas	l**s@o**m	2
andreas smolenko	a**o@f**e	2
simnh	s**t@u**e	2
Amedeo Ceruti	a**i@t**e	1
Francesco Witte	g**b@w**h	1
jo-omoyele	1****e	1
noah80	n****0	1
rodo	r**d@d**m	1
Dilara Gulcin Caglayan	d**n@f**e	1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 38
Total pull requests: 60
Average time to close issues: 6 months
Average time to close pull requests: 25 days
Total issue authors: 17
Total pull request authors: 18
Average comments per issue: 2.47
Average comments per pull request: 1.22
Merged pull request: 46
Bot issues: 0
Bot pull requests: 0

Past year issues: 7
Past year pull requests: 9
Past year average time to close issues: 27 days
Past year average time to close pull requests: 1 day
Past year issue authors: 1
Past year pull request authors: 3
Past year average comments per issue: 1.0
Past year average comments per pull request: 2.22
Past year merged pull request: 6
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/fzj-iek3-vsa/tsam

Top Issue Authors

julian-belina (7)
ckaldemeyer (7)
l-kotzur (6)
l-welder (4)
sbruche (2)
curiousleo (1)
jacob-mannhardt (1)
alicia-le (1)
mfleschutz (1)
fneum (1)
SilkeJo (1)
larsschellhas (1)
samuelduchesne (1)
ulfmueller (1)
FlRedder (1)

Top Pull Request Authors

l-kotzur (23)
OfficialCodexplosive (7)
maximilian-hoffmann (7)
julian-belina (4)
larsschellhas (3)
fneum (2)
samuelduchesne (2)
ddceruti (2)
ckaldemeyer (1)
noah80 (1)
dollro (1)
kimvk (1)
fwitte (1)
OriolRaventos (1)
swit22 (1)

Top Issue Labels

Top Pull Request Labels

Package metadata

Total packages: 4
Total downloads:
- pypi: 8,899 last-month
Total dependent packages: 7 (may contain duplicates)
Total dependent repositories: 29 (may contain duplicates)
Total versions: 63
Total maintainers: 5

pypi.org: tsam

Time series aggregation module (tsam) to create typical periods

Homepage:
Documentation: https://tsam.readthedocs.io/
Licenses: 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.
Latest release: 2.3.6 (published 6 months ago)
Last Synced: 2025-04-25T12:09:33.911Z (2 days ago)
Versions: 26
Dependent Packages: 6
Dependent Repositories: 29
Downloads: 8,899 Last month
Rankings:
- Dependent packages count: 1.596%
- Dependent repos count: 2.716%
- Average: 4.737%
- Downloads: 6.188%
- Stargazers count: 6.257%
- Forks count: 6.928%
Maintainers (5)
- l.kotzur
- machaitch1993
- t-gross
- j.belina
- j-weinand

proxy.golang.org: github.com/fzj-iek3-vsa/tsam

Homepage:
Documentation: https://pkg.go.dev/github.com/fzj-iek3-vsa/tsam#section-documentation
Licenses:
Latest release: v2.3.5+incompatible (published 7 months ago)
Last Synced: 2025-04-25T12:09:34.250Z (2 days ago)
Versions: 18
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%

proxy.golang.org: github.com/FZJ-IEK3-VSA/tsam

Homepage:
Documentation: https://pkg.go.dev/github.com/FZJ-IEK3-VSA/tsam#section-documentation
Licenses:
Latest release: v2.3.5+incompatible (published 7 months ago)
Last Synced: 2025-04-25T12:09:34.426Z (2 days ago)
Versions: 18
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 6.999%
- Average: 8.173%
- Dependent repos count: 9.346%

conda-forge.org: tsam

Homepage: https://github.com/FZJ-IEK3-VSA/tsam
Licenses: MIT
Latest release: 2.0.1 (published about 3 years ago)
Last Synced: 2025-04-02T02:13:07.817Z (25 days ago)
Versions: 1
Dependent Packages: 1
Dependent Repositories: 0
Rankings:
- Dependent packages count: 28.82%
- Stargazers count: 29.339%
- Forks count: 29.863%
- Average: 30.512%
- Dependent repos count: 34.025%

Dependencies

requirements.txt pypi

networkx *
numpy >=1.11.0
pandas >=0.18.1
pyomo >=5.3
scikit-learn >=0.0
tqdm *

.github/workflows/pytest.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

requirements_dev.txt pypi

pytest * development
sphinx * development
sphinx-autobuild * development
sphinx_book_theme * development
twine * development

setup.py pypi

Score: 17.181619476953934