{ "info": { "author": "Leander Kotzur", "author_email": "l.kotzur@fz-juelich.de", "bugtrack_url": null, "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 :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering :: Mathematics", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "\u00ef\u00bb\u00bf[![PyPI](https://img.shields.io/pypi/dm/tsam.svg)](https://pypi.python.org/pypi/tsam) [![Build Status](https://travis-ci.com/FZJ-IEK3-VSA/tsam.svg?branch=master)](https://travis-ci.com/FZJ-IEK3-VSA/tsam) [![Version](https://img.shields.io/pypi/v/tsam.svg)](https://pypi.python.org/pypi/tsam)\n\n\"Forschungszentrum \n\n# tsam - Time Series Aggregation Module\ntsam is a python package which uses different machine learning algorithms for the aggregation of typical periods. It is applicable for all type of time series, eather weather data, load data or both simultaneously. The module is able to significantly reduce input time series for energy system models, and therefore the model's complexity and computational time. \n\n\nIf you want to use tsam in a published work, please [**kindly cite following publication**](https://www.sciencedirect.com/science/article/pii/S0960148117309783) which validates the methods and describes their cababilites. The manuscript is found [**here**](https://arxiv.org/abs/1708.00420). \n\nA [**second publication**](https://www.sciencedirect.com/science/article/pii/S0306261918300242) introduces a method how to model states (e.g. state of charge of storage) between the aggregated typical periods. The manuscript is found [**here**](https://arxiv.org/abs/1710.07593).\n\n## Features\n* flexible read-in and handling of multidimensional time-series via the pandas module\n* different aggregation methods implemented (averaging, k-means, exact k-medoids, hierarchical), which are based on scikit-learn or pyomo\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\nThen install tsam via pip as follow\n\n\tcd tsam\n\tpip install . \n\nOr install directly via python as \n\n\tpython setup.py install\n\nIn order to use the k-medoids clustering, make sure that you have installed a MILP solver. As default solver GLPK 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\n\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 number of typical periods, the length of a single period and the aggregation method\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\tclusterMethod = 'hierarchical')\n```\n\nRun the aggregation to typical periods\n```python\n\ttypPeriods = aggregation.createTypicalPeriods()\n```\n\nStore the results as .csv file\n\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-2019 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\n## About Us \n\"Abteilung \n\nWe are the [Techno-Economic Energy Systems Analysis](https://www.fz-juelich.de/iek/iek-3/EN/Forschung/_Process-and-System-Analysis/_node.html) department at the [Institute of Energy and Climate Research: Electrochemical Process Engineering (IEK-3)](https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html) belonging to the [Forschungszentrum J\u00c3\u00bclich](https://www.fz-juelich.de/). Our interdisciplinary department's research is focusing on energy-related process and systems analyses. Data searches and system simulations are used to determine energy and mass balances, as well as to evaluate performance, emissions and costs of energy systems. The results are used for performing comparative assessment studies between the various systems. Our current priorities include the development of energy strategies, in accordance with the German Federal Government\u00e2\u20ac\u2122s greenhouse gas reduction targets, by designing new infrastructures for sustainable and secure energy supply chains and by conducting cost analysis studies for integrating new technologies into future energy market frameworks.\n\n## Contributions and Users\n\nWithin the BMWi funded project [**METIS**](http://www.metis-platform.net/) we extend the methodology together with the RWTH-Aachen ([**Prof. Aaron Praktiknjo**](https://www.wiwi.rwth-aachen.de/cms/Wirtschaftswissenschaften/Die-Fakultaet/Institute-und-Lehrstuehle/Professoren/~jgfr/Praktiknjo-Aaron/?allou=1&lidx=1)), the EDOM Team at FAU ([**PD Lars Schewe**](https://www.mso.math.fau.de/de/edom/team/schewe-lars/dr-lars-schewe/)) and the [**J\u00c3\u00bclich Supercomputing Centre**](https://www.fz-juelich.de/ias/jsc/DE/Home/home_node.html).\n\n\"METIS \n\n\n## Acknowledgement\n\nThis work was 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/).\n\n\"Helmholtz\n\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.597956.svg)](https://doi.org/10.5281/zenodo.597956)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/FZJ-IEK3-VSA/tsam", "keywords": "clustering,optimization", "license": "", "maintainer": "", "maintainer_email": "", "name": "tsam", "package_url": "https://pypi.org/project/tsam/", "platform": "", "project_url": "https://pypi.org/project/tsam/", "project_urls": { "Homepage": "https://github.com/FZJ-IEK3-VSA/tsam" }, "release_url": "https://pypi.org/project/tsam/1.0.5/", "requires_dist": [ "sklearn (>=0.0)", "pandas (>=0.18.1)", "numpy (>=1.11.0)", "pyomo (>=5.3)" ], "requires_python": "", "summary": "Time series aggregation module (tsam) to create typical periods", "version": "1.0.5" }, "last_serial": 5487098, "releases": { "0.9.6": [ { "comment_text": "", "digests": { "md5": "f2362f195f2e330d8a1d34ecaaf8de71", "sha256": "a5cb8f31bb43720d26abaafaf7eccea9640d95552cefc711cf7666bf80f80f87" }, "downloads": -1, "filename": "tsam-0.9.6-py3-none-any.whl", "has_sig": false, "md5_digest": "f2362f195f2e330d8a1d34ecaaf8de71", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16448, "upload_time": "2018-05-22T18:53:30", "url": "https://files.pythonhosted.org/packages/2b/de/25ae03dde9d9fb96383a3abf4931111e7eea1166b7607bc2bea54bbd0ffa/tsam-0.9.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "90c9346421043eb648087f105523f42c", "sha256": "c9468a9f15ca6db96a995e02d3ede8563cb4d55707f37111aac423cbb0dc3d73" }, "downloads": -1, "filename": "tsam-0.9.6.tar.gz", "has_sig": false, "md5_digest": "90c9346421043eb648087f105523f42c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322186, "upload_time": "2018-05-22T18:53:33", "url": "https://files.pythonhosted.org/packages/f7/75/892b28437c6aeb0179534fb1a003d6b5acfc2016b2c40b1f17c549097c60/tsam-0.9.6.tar.gz" } ], "0.9.7": [ { "comment_text": "", "digests": { "md5": "e6135310760c955f776565bfbaaa11b8", "sha256": "a82d5851ca77e8c615846a8f34d7534cc6463b622651b701f2b4b6164b8bb09f" }, "downloads": -1, "filename": "tsam-0.9.7-py3-none-any.whl", "has_sig": false, "md5_digest": "e6135310760c955f776565bfbaaa11b8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16447, "upload_time": "2018-05-22T18:53:31", "url": "https://files.pythonhosted.org/packages/8a/04/c8d080d15f80b7a81016ab8ec441681f2bace0450fb129f65ecb0db33290/tsam-0.9.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c0c3ab7762fe37484ce9dd19e1f1310d", "sha256": "040e24b04c510cf893f173d8416627e6dad5e2a75ac2209e259f2e0b7ba96104" }, "downloads": -1, "filename": "tsam-0.9.7.tar.gz", "has_sig": false, "md5_digest": "c0c3ab7762fe37484ce9dd19e1f1310d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322190, "upload_time": "2018-05-22T18:53:36", "url": "https://files.pythonhosted.org/packages/43/cd/ea270e8a7e8b5a888ab8933eefd69349405cc4debfbb04c4ed134fbf7e08/tsam-0.9.7.tar.gz" } ], "0.9.8": [ { "comment_text": "", "digests": { "md5": "cae2d2e0de1b028b45c04ebf3d60116d", "sha256": "592953702815878c3d9d5fec5fe8ebb2dec10ede95d2f2154ecc70b81d1f7269" }, "downloads": -1, "filename": "tsam-0.9.8-py3-none-any.whl", "has_sig": false, "md5_digest": "cae2d2e0de1b028b45c04ebf3d60116d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16467, "upload_time": "2018-05-22T18:59:35", "url": "https://files.pythonhosted.org/packages/09/4c/79803039c2aa9920fcb67092949ea2f4d471c6d8f3780baaee03c00f841f/tsam-0.9.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3aff0606600d865a7785a5e364d6b2ef", "sha256": "55a273510ae2b80d40875a64e588b0896a44a4ec67b592c43faf209d119c891d" }, "downloads": -1, "filename": "tsam-0.9.8.tar.gz", "has_sig": false, "md5_digest": "3aff0606600d865a7785a5e364d6b2ef", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322238, "upload_time": "2018-05-22T18:59:37", "url": "https://files.pythonhosted.org/packages/7c/1d/92ce6f8c42cc86b3b48c11c4a987a35d1f482fb407dd1edc289d5190d3f9/tsam-0.9.8.tar.gz" } ], "0.9.9": [ { "comment_text": "", "digests": { "md5": "1516ce7a242b924a318e510ea098ecf6", "sha256": "ec495e7d6ef665d8652aed109fb56cb8a527cc981715327c3e81fdd095f9eef7" }, "downloads": -1, "filename": "tsam-0.9.9-py3-none-any.whl", "has_sig": false, "md5_digest": "1516ce7a242b924a318e510ea098ecf6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16464, "upload_time": "2018-05-22T19:12:34", "url": "https://files.pythonhosted.org/packages/83/b4/e2d191fd8f0305d5a5d96c026b49a2d73cbfb192f771a1ef00076a6baa5a/tsam-0.9.9-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6520c5be07dac99f2d694ad3814db031", "sha256": "e5c86252e392aa9404682227cf2a1c8a01d86c31cc43b5b258294d183a85dc45" }, "downloads": -1, "filename": "tsam-0.9.9.tar.gz", "has_sig": false, "md5_digest": "6520c5be07dac99f2d694ad3814db031", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322220, "upload_time": "2018-05-22T19:12:36", "url": "https://files.pythonhosted.org/packages/c3/b7/2c43438aea1e2021833ec2c36a559abf92762d9ec68e95d04142547a4ac5/tsam-0.9.9.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "926fe8c68982827eb34abeb0c77b52a9", "sha256": "28bcf1deda4b0be7febaa0f804a5d966af89c9b9352a1929e81ec11048598108" }, "downloads": -1, "filename": "tsam-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "926fe8c68982827eb34abeb0c77b52a9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15920, "upload_time": "2018-09-10T15:51:20", "url": "https://files.pythonhosted.org/packages/f8/12/86df7813959f4cd74b9bf3c68a40ec270e9d55923ece56a84224181fa449/tsam-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f0cc5e6d0767631572b83778c561dfb5", "sha256": "51c02396c930db58586faf56e44474dccc9e32bdfeeeecea717287f07ff822e5" }, "downloads": -1, "filename": "tsam-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f0cc5e6d0767631572b83778c561dfb5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322234, "upload_time": "2018-09-10T15:51:23", "url": "https://files.pythonhosted.org/packages/fd/bd/9c3e35bb213ba34b94c92a68d8b0d1cb797c699292f035e89558616eafe6/tsam-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "8fd1646f9f7504424e358a11848d6911", "sha256": "b0493b1ced41667a4ed72cdfbdbda6793e9f1e213bf47ff5526c20966f9b0bec" }, "downloads": -1, "filename": "tsam-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "8fd1646f9f7504424e358a11848d6911", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16839, "upload_time": "2019-01-23T15:55:51", "url": "https://files.pythonhosted.org/packages/f7/92/71477285b45184b78e7163b661cd695c7f90bb63c8c064e01d10099a1396/tsam-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b98406901d0a576ed32a160d6f09bbb3", "sha256": "6b62317311dc8bcf61be0da9521068a372f804f27e0fe1877a084e76a1569271" }, "downloads": -1, "filename": "tsam-1.0.1.tar.gz", "has_sig": false, "md5_digest": "b98406901d0a576ed32a160d6f09bbb3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 360677, "upload_time": "2019-01-23T15:55:54", "url": "https://files.pythonhosted.org/packages/c5/bc/675b95035ffba608c4a76d80d173348232e78dc22e8dee8160d3b7f08952/tsam-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "a82fd1835b00d794256b8c197496e447", "sha256": "ca49c468a58457ae81715537e145c5e7a4eb88715c3dd0e8d3766c70946a1ee6" }, "downloads": -1, "filename": "tsam-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "a82fd1835b00d794256b8c197496e447", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17187, "upload_time": "2019-01-24T11:07:41", "url": "https://files.pythonhosted.org/packages/57/04/900c2146f190f1d2dd813f0bd09420aad21156be12e4a69e8b2f8fa5c1c3/tsam-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bd3de9dce592b8de64962e0d3a2dd234", "sha256": "522eabb36371869f89e3cbcd042df51b19a3e2c720307e696d0db254a16c7c27" }, "downloads": -1, "filename": "tsam-1.0.2.tar.gz", "has_sig": false, "md5_digest": "bd3de9dce592b8de64962e0d3a2dd234", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 361449, "upload_time": "2019-01-24T11:07:44", "url": "https://files.pythonhosted.org/packages/1e/88/cc888d546bee6d50737a32f1c08e0dda4c82df69a94aa194b3242a918300/tsam-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "5eb35b7a424b3571a45473ee0615e881", "sha256": "34ca7d112348e80018e28ad8c6a2ab5571fc8845d50e3cbd23652db6a4fa7ff1" }, "downloads": -1, "filename": "tsam-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "5eb35b7a424b3571a45473ee0615e881", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17250, "upload_time": "2019-03-14T16:06:18", "url": "https://files.pythonhosted.org/packages/5e/3e/87969957841e59fecf231b03736df2c03716667aa53fa5fb128af4dae19f/tsam-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ee08a44b5a6103cfff0b3f3fffe8f799", "sha256": "39e3d0681b191de640a7923488a06da787d131c5856846d0486c9ff8ca14b3ff" }, "downloads": -1, "filename": "tsam-1.0.3.tar.gz", "has_sig": false, "md5_digest": "ee08a44b5a6103cfff0b3f3fffe8f799", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 361663, "upload_time": "2019-03-14T16:06:22", "url": "https://files.pythonhosted.org/packages/fc/cf/d8fee6757d3fb2ec1d8bc2af8fcc1936d4466815d573f161a02bb9331e45/tsam-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "3b222000f4ce41e86f7d221914c42f6c", "sha256": "c7a4677d43158b2ddce81c9d9544cc222e76b3be27d50ccda0dbd5d2e086b915" }, "downloads": -1, "filename": "tsam-1.0.4.tar.gz", "has_sig": false, "md5_digest": "3b222000f4ce41e86f7d221914c42f6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 361815, "upload_time": "2019-06-14T16:59:06", "url": "https://files.pythonhosted.org/packages/b0/51/43369bf3d1fe22308356bfe40565e607f89a3a5a753f8f19e287b32588df/tsam-1.0.4.tar.gz" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "665c19a69b7583c70e4592b00d190f66", "sha256": "6c0f4015527f4336ec31ba2273b7087ba2ccffa73cd5cebc1c944725e99c376b" }, "downloads": -1, "filename": "tsam-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "665c19a69b7583c70e4592b00d190f66", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18307, "upload_time": "2019-07-04T14:52:06", "url": "https://files.pythonhosted.org/packages/03/67/f1fbf45edae1f0fd9961c6c2e4beb9a1ea787cd609045be2cf86f58a7e70/tsam-1.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "786ff6480d54bc412839162c7c85a8f2", "sha256": "61fbf8a6eb146306014ab28b5e55a640e62b9f73fd94db745f83db8e5faa3c6b" }, "downloads": -1, "filename": "tsam-1.0.5.tar.gz", "has_sig": false, "md5_digest": "786ff6480d54bc412839162c7c85a8f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 482967, "upload_time": "2019-07-04T14:52:10", "url": "https://files.pythonhosted.org/packages/e2/d7/14b0af7e79a27b5cf13d51e4113921eacc9df7926abff4e1ade412ffd5fb/tsam-1.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "665c19a69b7583c70e4592b00d190f66", "sha256": "6c0f4015527f4336ec31ba2273b7087ba2ccffa73cd5cebc1c944725e99c376b" }, "downloads": -1, "filename": "tsam-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "665c19a69b7583c70e4592b00d190f66", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18307, "upload_time": "2019-07-04T14:52:06", "url": "https://files.pythonhosted.org/packages/03/67/f1fbf45edae1f0fd9961c6c2e4beb9a1ea787cd609045be2cf86f58a7e70/tsam-1.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "786ff6480d54bc412839162c7c85a8f2", "sha256": "61fbf8a6eb146306014ab28b5e55a640e62b9f73fd94db745f83db8e5faa3c6b" }, "downloads": -1, "filename": "tsam-1.0.5.tar.gz", "has_sig": false, "md5_digest": "786ff6480d54bc412839162c7c85a8f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 482967, "upload_time": "2019-07-04T14:52:10", "url": "https://files.pythonhosted.org/packages/e2/d7/14b0af7e79a27b5cf13d51e4113921eacc9df7926abff4e1ade412ffd5fb/tsam-1.0.5.tar.gz" } ] }