diff --git a/README.md b/README.md index 3a3f0a524f..db98bfd6c9 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,10 @@ **Welcome to Sinergym!** +
+

+
+ The goal of this project is to create an environment following [Gymnasium interface](https://gymnasium.farama.org/), for wrapping simulation engines for building control using **deep reinforcement learning**. Please, help us to improve by **reporting your questions and issues** [here](https://github.com/ugr-sail/sinergym/issues). It is easy, just 2 clicks using our issue templates (questions, bugs, improvements, etc.). More detailed info on how to report issues [here](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue). diff --git a/docs/source/_static/container1.png b/docs/source/_static/container1.png deleted file mode 100644 index 7fef9b5783..0000000000 Binary files a/docs/source/_static/container1.png and /dev/null differ diff --git a/docs/source/_static/container2.png b/docs/source/_static/container2.png deleted file mode 100644 index 8514091da1..0000000000 Binary files a/docs/source/_static/container2.png and /dev/null differ diff --git a/docs/source/_static/general_blueprint.png b/docs/source/_static/general_blueprint.png new file mode 100644 index 0000000000..ebb45fba42 Binary files /dev/null and b/docs/source/_static/general_blueprint.png differ diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png deleted file mode 100644 index 5fd178b3f7..0000000000 Binary files a/docs/source/_static/logo.png and /dev/null differ diff --git a/docs/source/_static/operation_diagram.jpg b/docs/source/_static/operation_diagram.jpg deleted file mode 100644 index a266189919..0000000000 Binary files a/docs/source/_static/operation_diagram.jpg and /dev/null differ diff --git a/docs/source/_static/sinergym_diagram.png b/docs/source/_static/sinergym_diagram.png new file mode 100644 index 0000000000..6aa281103f Binary files /dev/null and b/docs/source/_static/sinergym_diagram.png differ diff --git a/docs/source/_static/socket.png b/docs/source/_static/socket.png new file mode 100644 index 0000000000..c7706e26d6 Binary files /dev/null and b/docs/source/_static/socket.png differ diff --git a/docs/source/_static/weather_variability.png b/docs/source/_static/weather_variability.png deleted file mode 100644 index 6aa019b673..0000000000 Binary files a/docs/source/_static/weather_variability.png and /dev/null differ diff --git a/docs/source/_templates/shields.html b/docs/source/_templates/shields.html new file mode 100644 index 0000000000..a7fca64d49 --- /dev/null +++ b/docs/source/_templates/shields.html @@ -0,0 +1,39 @@ +

+

+ + Github latest release + + + Github last commit + + + Pypi version + + + Pypi downloads + + + + + + GitHub Contributors + + + Github issues + + + GitHub pull requests + + + Github License + + + Pypi Python version + +
+
+ + + +

\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 7dc371e6d3..8082aac5de 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'sinergym' -copyright = '2021, J. Jiménez, J. Gómez, M. Molina, A. Manjavacas, A. Campoy' +copyright = '2023, J. Jiménez, J. Gómez, M. Molina, A. Manjavacas, A. Campoy' author = 'J. Jiménez, J. Gómez, M.l Molina, A. Manjavacas, A. Campoy' diff --git a/docs/source/pages/environments.rst b/docs/source/pages/environments.rst index db8a229477..3c78f28ca6 100644 --- a/docs/source/pages/environments.rst +++ b/docs/source/pages/environments.rst @@ -2,6 +2,29 @@ Environments ############ +As mentioned in introduction, Sinergym follows the next structure: + +.. image:: /_static/sinergym_diagram.png + :width: 800 + :alt: Sinergym backend + :align: center + +| + +Sinergym is composed of three main components: agent, +communication interface and simulation. The agent sends actions and receives observations from the environment +through the Gymnasium interface. At the same time, the gym interface communicates with the simulator engine +via BCVTB, which provide the socket in order to parse the information in EnergyPlus format. + +The next image shows that socket connection: + +.. image:: /_static/socket.png + :width: 800 + :alt: Sinergym backend + :align: center + +| + ************************** Environments List ************************** @@ -198,7 +221,7 @@ in order to introduce **noise** to the weather data episode to episode. Then, pa (*sigma*, *mu* and *tau*) whose values define the nature of that noise. .. image:: /_static/ornstein_noise.png - :scale: 120 % + :scale: 80 % :alt: Ornstein-Uhlenbeck process noise with different hyperparameters. :align: center diff --git a/docs/source/pages/gcloudAPI.rst b/docs/source/pages/gcloudAPI.rst index d9984af9e4..7b1f0f638a 100644 --- a/docs/source/pages/gcloudAPI.rst +++ b/docs/source/pages/gcloudAPI.rst @@ -273,22 +273,13 @@ Google Cloud use a **Container-Optimized OS** (see `documentation `__) in VM. This SO have docker pre-installed with *Sinergym* container. -.. image:: /_static/container1.png - :width: 800 - :alt: GCE VM containers list - :align: center - - To use this container in our machine you only have to do: .. code:: sh $ docker attach -.. image:: /_static/container2.png - :width: 800 - :alt: GCE VM container usage. - :align: center + And now you can execute your own experiments in Google Cloud! For example, you can enter in remote container with *gcloud ssh* and execute diff --git a/docs/source/pages/github-actions.rst b/docs/source/pages/github-actions.rst index b141da5ed6..ce3ee469f3 100644 --- a/docs/source/pages/github-actions.rst +++ b/docs/source/pages/github-actions.rst @@ -72,6 +72,10 @@ These workflows will be executed in sequential order: using *latest* tag automatically. This update is executed only when the previous format and documentation workflows have successfully finished. +- **Testing and CodeCov update**: Project tests are executed in the same way than pull request event. + However, when test are executed, the coverage report is uploaded to CodeCov service in order to + register the code coverage percentage in the project. + ******************************** New release created or modified ******************************** diff --git a/docs/source/pages/introduction.rst b/docs/source/pages/introduction.rst index 19fedcbce9..fcc3724312 100644 --- a/docs/source/pages/introduction.rst +++ b/docs/source/pages/introduction.rst @@ -1,13 +1,16 @@ The goal of *sinergym* is to create an environment following *Gymnasium* interface for wrapping simulation engines (*Energyplus*) for building control using **deep reinforcement learning**. -.. image:: /_static/operation_diagram.jpg +.. image:: /_static/general_blueprint.png :width: 800 :alt: Sinergym diagram :align: center | +.. raw:: html + :file: ../_templates/shields.html + .. note:: Please, help us to improve by **reporting your questions and issues** `here `__. It is easy, just 2 clicks using our issue templates (questions, bugs, improvements, etc.). More detailed diff --git a/images/Sinergym_cloud_API.png b/images/Sinergym_cloud_API.png deleted file mode 100644 index 6e9fd120a4..0000000000 Binary files a/images/Sinergym_cloud_API.png and /dev/null differ diff --git a/images/general_blueprint.png b/images/general_blueprint.png new file mode 100644 index 0000000000..ebb45fba42 Binary files /dev/null and b/images/general_blueprint.png differ diff --git a/images/operation_diagram.jpg b/images/operation_diagram.jpg deleted file mode 100644 index a266189919..0000000000 Binary files a/images/operation_diagram.jpg and /dev/null differ diff --git a/images/operation_diagram.png b/images/operation_diagram.png deleted file mode 100644 index 8d2916253b..0000000000 Binary files a/images/operation_diagram.png and /dev/null differ diff --git a/images/weather_types.png b/images/weather_types.png deleted file mode 100644 index e2cfd48333..0000000000 Binary files a/images/weather_types.png and /dev/null differ diff --git a/images/weather_variability.png b/images/weather_variability.png deleted file mode 100644 index 6aa019b673..0000000000 Binary files a/images/weather_variability.png and /dev/null differ diff --git a/images/weather_variation.png b/images/weather_variation.png deleted file mode 100755 index 606235ec1b..0000000000 Binary files a/images/weather_variation.png and /dev/null differ diff --git a/sinergym/version.txt b/sinergym/version.txt index 585940699b..530cdd91a2 100644 --- a/sinergym/version.txt +++ b/sinergym/version.txt @@ -1 +1 @@ -2.2.3 +2.2.4