From 9fdf4e995fa8671d2909a5d09e116353b50cc11d Mon Sep 17 00:00:00 2001 From: Javier Arroyo Date: Sat, 11 Nov 2023 12:13:36 +0100 Subject: [PATCH] Add versioning and main dependencies section to README.md. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 40911f3..970e4cf 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,12 @@ Running BOPTEST locally is substantially faster 2) Run a BOPTEST case with the building emulator model to be controlled (instructions [here](https://github.com/ibpsa/project1-boptest/blob/master/README.md)). 3) Check out the `master` branch of this repository and run the example above replacing the url to be `url = 'http://127.0.0.1:5000'` and avoiding the `testcase` argument to the `BoptestGymEnv` class. +## Versioning and main dependencies + +Current BOPTEST-Gym version is `v0.5.0` which is compatible with BOPTEST `v0.5.0` +(BOPTEST-Gym version should always be even with the BOPTEST version used). +The framework has been tested with `gymnasium==0.28.1` and `stable-baselines3==2.0.0`. +You can see [testing/Dockerfile](testing/Dockerfile) for a full description of the testing environment. ## Citing the project