Installation

In the following, instructions for installing and using the tsam package are given.

tsam installation

Install via pip by typing

pip install tsam

into the command prompt. Alternatively, download or clone a local copy of the repository to your computer

git clone https://github.com/FZJ-IEK3-VSA/tsam.git

and install tsam in the folder where the setup.py is located with

pip install -e .

or install directly via python as

python setup.py install

Installation of an optimization solver

Some clustering algorithms implemented in tsam are based on Mixed-Integer Linear Programming. Accordingy, an appropriate solver for using these functionalities is required that can be accessed by Pyomo. The HiGHS solver is set as default and installed via highspy but can be replaced by any other solver that is supported by Pyomo.