Installation

HAMLET is a Python-based tool designed for easy setup. This guide explains how to install HAMLET using Anaconda, PyCharm, and Gurobi. Other IDEs and package managers may also be used.

  1. Prerequisites:

    • IDE: (e.g., PyCharm)

    • Package Manager: (e.g., Anaconda)

    • Solver: Gurobi (recommended) or HiGHS.

  2. Clone the Repository: Clone HAMLET to a local directory using Git:

git clone https://github.com/tum-ewk/hamlet.git

  1. Set Up a Virtual Environment: Use Anaconda to create and activate an environment:

conda env create -f ./hamlet/env.yml

  1. Configure IDE: In PyCharm:

    • Open HAMLET’s directory.

    • Go to File -> Settings -> Project -> Python Interpreter.

    • Add the new environment.

  2. Install Gurobi (optional):

    • If you do not have a license yet, you might be able to acquire one through your university by visiting https://www.gurobi.com and create an account using your university email.

    • Download the latest Gurobi version.

    • Follow the Academic License instructions for activation.

  3. Test Your Installation: Run simple example scenario:

examples/create_simple_scenario/run.ipynb