Skip to content

Commit

Permalink
Merge pull request #62 from FZJ-IEK3-VSA/release201_doc
Browse files Browse the repository at this point in the history
Updated docstrings for tsam release 2.0.1
  • Loading branch information
maximilian-hoffmann committed Apr 19, 2022
2 parents 49bfc92 + e6dbc99 commit a102f02
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/source/conf.py
Expand Up @@ -69,17 +69,17 @@

# General information about the project.
project = "tsam"
copyright = "2016-2021, tsam Developer Team"
copyright = "2016-2022, tsam Developer Team"
author = "Leander Kotzur, Maximilian Hoffmann"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = "2.0.0"
version = "2.0.1"
# The full version, including alpha/beta/rc tags.
release = "2.0.0"
release = "2.0.1"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/legalNoticeDoc.rst
Expand Up @@ -8,7 +8,7 @@ License

`MIT License <https://opensource.org/licenses/MIT>`_

Copyright (C) 2016-2020 Leander Kotzur, Maximilian Hoffmann, Peter Markewitz, Martin Robinius, Detlef Stolten
Copyright (C) 2016-2022 Leander Kotzur, Maximilian Hoffmann, Peter Markewitz, Martin Robinius, Detlef Stolten

***************
Acknowledgement
Expand Down
10 changes: 9 additions & 1 deletion docs/source/newsDoc.rst
Expand Up @@ -2,11 +2,19 @@
tsam's Change Log
#################

*********************
Release version 2.0.1
*********************

tsam release (1.1.2) includes the following new functionalities:
* Changed dependency of scikit-learn to make tsam conda-forge runnable.


*********************
Release version 2.0.0
*********************

In tsam’s latest release (2.0.0) the following functionalities were included:
In tsam release 2.0.0 the following functionalities were included:
* A new comprehensive structure that allows for free cross-combination of clustering algorithms and cluster representations, e.g. centroids or medoids.
* A novel cluster representation method that precisely replicates the original time series value distribution in the aggregated time series based on “Hoffmann, Kotzur and Stolten (2021): The Pareto-Optimal Temporal Aggregation of Energy System Models (https://arxiv.org/abs/2111.12072)”
* Maxoids as representation algorithm which represents time series by outliers only based on “Sifa and Bauckhage (2017): Online k-Maxoids clustering”
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -8,7 +8,7 @@

setuptools.setup(
name="tsam",
version="2.0.0",
version="2.0.1",
author="Leander Kotzur, Maximilian Hoffmann",
author_email="l.kotzur@fz-juelich.de, max.hoffmann@fz-juelich.de",
description="Time series aggregation module (tsam) to create typical periods",
Expand Down

0 comments on commit a102f02

Please sign in to comment.