Installation

To install sinergym, follow these steps:

First, it is recommended to create a virtual environment. You can do so by:

$ sudo apt-get install python-virtualenv virtualenv
$ virtualenv env_sinergym --python=python3.7
$ source env_sinergym/bin/activate

There are other alternatives like conda environments, for example.

Then, clone this repository using this command:

$ git clone https://github.com/jajimer/sinergym.git

Docker container

We include a Dockerfile for installing all dependencies and setting up the image for running sinergym.

By default, Dockerfile will do pip install -e .[extras], if you want to install a diffetent setup, you will have to do in root repository:

$ docker build -t <tag_name> --build-arg SINERGYM_EXTRAS=[<setup_tag(s)>] .

For example, if you want a container with only documentation libaries and testing:

$ docker build -t example1/sinergym:latest --build-arg SINERGYM_EXTRAS=[doc,test] .

On the other hand, if you don’t want any extra library, it’s neccesary to write an empty value like this:

$ docker build -t example1/sinergym:latest --build-arg SINERGYM_EXTRAS= .

Note

You can install directly our container from Docker Hub repository, all releases of this project are there.

Note

If you use Visual Studio Code, by simply opening the root directory and clicking on the pop-up button “Reopen in container“, all the dependencies will be installed automatically and you will be able to run sinergym in an isolated environment.

Manual installation

If you prefer installing sinergym manually, follow the steps below:

1. Install EnergyPlus 9.5.0

Firstly, install EnergyPlus. Currently it has been update compability to 9.5.0 and it has been tested, but code may also work with other versions. Sinergym ensure this support:

Sinergym Version	EnergyPlus version
1.0.0 or before	8.6.0
1.1.0 or later	9.5.0

Other combination may works, but they don’t have been tested.

Follow the instructions here and install it for Linux (only Ubuntu is supported). Choose any location to install the software. Once installed, a folder called Energyplus-9-5-0 should appear in the selected location.

1. Install BCVTB software

Follow the instructions here for installing BCVTB software. Another option is to copy the bcvtb folder from this repository.

3. Set environment variables

Two environment variables must be set: EPLUS_PATH and BCVTB_PATH, with the locations where EnergyPlus and BCVTB are installed respectively.

4. Install the package

Finally, sinergym can be installed by running this command at the repo root folder:

$ pip install -e .

Extra libraries can be installed by typing pip install -e .[extras]. extras include all optional libraries which have been considered in this project such as testing, visualization, Deep Reinforcement Learning, monitoring , etc. It’s possible to select a subset of these libraries instead of ‘extras’ tag in which we select all optional libaries, for example:

$ pip install -e .[test,doc]

In order to check all our tag list, visit setup.py in Sinergym root repository.

In any case, they are not a requirement of the package.

Cloud Computing

You can run your experiments in the Cloud too. We are using Google Cloud in order to make it possible. Our team aim to set up an account in which execute our Sinergym container with remote storage and mlflow tracking. For more detail about installation and getting Google Cloud SDK ready to run your experiments, visit our section Preparing Google Cloud.