Minimal Installation

The minimal installation should be preferred by all users who do not contribute directly to Energym by adding new building models.

Installation steps are explained below for Linux and Windows 10.

Windows 10

All steps listed below are demonstrated in the following video:

Before starting, you must have a running version of Python>=3.6. Check here.

  1. Download Energyplus 9.5 for Windows from this link and install it.

  2. Edit Windows environment variables, add Energyplus to your path follwing the steps:

    • Search “edit environment variables” in the taskbar, open the proposed link, click on Environment Variables.

    ../_images/env_var_windows1.PNG

    • Click on “Path” and then Edit as displayed below.

    ../_images/env_var_windows2.PNG

    • Add your Energyplus installation path.

    ../_images/env_var_windows3.PNG

  3. Install Energym:

    git clone <energym gitlab adress>
cd <energym main folder>
python setup.py install --verbose

Linux (Ubuntu)

Before starting, you must have a running version of Python>=3.6. Check here.

  1. Make sure you have gcc, g++, gfortran installed. If not there, install the required compilers and librairies using:

    sudo apt-get update
sudo apt-get install gcc-7 g++-7 gfortran-7 libgfortran5

#On Ubuntu 18.04, use libgfortran3 instead of libgfortran5.

  2. Download and install Energyplus 9.5:

    curl -SLO https://github.com/NREL/EnergyPlus/releases/download/v9.5.0/EnergyPlus-9.5.0-de239b2e5f-Linux-Ubuntu20.04-x86_64.sh
chmod +x EnergyPlus-9.5.0-de239b2e5f-Linux-Ubuntu20.04-x86_64.sh  #here for Ubuntu 20.04
sudo echo "y\r" | ./EnergyPlus-9.5.0-de239b2e5f-Linux-Ubuntu20.04-x86_64.sh
rm EnergyPlus-9.5.0-de239b2e5f-Linux-Ubuntu20.04-x86_64.sh

  3. Install Energym:

    git clone <energym gitlab adress>
cd <energym main folder>
python setup.py install --verbose

Docker

For users willing to launch the library within a docker (just for model evaluation and controllers benchmarking), use the file Dockerfile.

  1. Prior to using docker, install it following the instructions:

  2. Clone the repository using git:

    git clone <energym adress>
cd <energym main folder>

  3. Build and run the container

    • On Windows:

      docker build --pull --rm -f "Dockerfile" -t energym:latest "."
docker run -d -p 80:80 energym:latest

    • On Linux. Use the dockerlauncher in the main repository:

      ./dockerlauncher
SwissHouseRSlaTank notebook example Getting Started