(v2.2.4) - Documentation Update (#296)

* Changed version from 2.2.3 to 2.2.4 * Updated documentation copyright year * Deleting unused or out-dated images in documentation and README.md * Added updated images for documentation and README * Added shields.html to templates in documentation web * Added general blueprint of Sinergym in README * Added introduction with new images in documentation: environments section * Added shields to documentation introduction
ugr-sail · Mar 1, 2023 · fbbc893 · fbbc893
1 parent 5a6748e
commit fbbc893
Show file tree

Hide file tree

Showing 23 changed files with 78 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,10 @@
 
 **Welcome to Sinergym!**
 
+<div align="center">
+  <img src="images/general_blueprint.png" width=80%><br><br>
+</div>
+
 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
diff --git a/docs/source/_static/container2.png b/docs/source/_static/container2.png
diff --git a/docs/source/_static/general_blueprint.png b/docs/source/_static/general_blueprint.png
diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png
diff --git a/docs/source/_static/operation_diagram.jpg b/docs/source/_static/operation_diagram.jpg
diff --git a/docs/source/_static/sinergym_diagram.png b/docs/source/_static/sinergym_diagram.png
diff --git a/docs/source/_static/socket.png b/docs/source/_static/socket.png
diff --git a/docs/source/_static/weather_variability.png b/docs/source/_static/weather_variability.png
diff --git a/docs/source/_templates/shields.html b/docs/source/_templates/shields.html
@@ -0,0 +1,39 @@
+</p>
+<p align="center">
+    <a href="https://github.com/ugr-sail/sinergym/releases">
+        <img alt="Github latest release" src="https://img.shields.io/github/release-date/ugr-sail/sinergym" />
+    </a>
+    <a href="https://github.com/ugr-sail/sinergym/commits/main">
+        <img alt="Github last commit" src="https://img.shields.io/github/last-commit/ugr-sail/sinergym" />
+    </a>
+    <a href="https://pypi.org/project/sinergym/">
+        <img alt="Pypi version" src="https://img.shields.io/pypi/v/sinergym" />
+    </a>
+    <a href="https://github.com/ugr-sail/sinergym/stargazers">
+        <img alt="Pypi downloads" src="https://img.shields.io/pypi/dm/sinergym" />
+    </a>
+    <a href="https://codecov.io/gh/ugr-sail/sinergym">
+        <img src="https://codecov.io/gh/ugr-sail/sinergym/branch/main/graph/badge.svg" />
+    </a>
+    <a href="https://github.com/ugr-sail/sinergym/graphs/contributors">
+        <img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/ugr-sail/sinergym" />
+    </a>
+    <a href="https://github.com/ugr-sail/sinergym/issues">
+        <img alt="Github issues" src="https://img.shields.io/github/issues/ugr-sail/sinergym?color=0088ff" />
+    </a>
+    <a href="https://github.com/ugr-sail/sinergym/pulls">
+        <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/ugr-sail/sinergym?color=0088ff" />
+    </a>
+    <a href="https://github.com/ugr-sail/sinergym/blob/main/LICENSE">
+        <img alt="Github License" src="https://img.shields.io/github/license/ugr-sail/sinergym" />
+    </a>
+    <a href="https://www.python.org/downloads/release/python-3100/">
+        <img alt="Pypi Python version" src="https://img.shields.io/pypi/pyversions/sinergym" />
+    </a>
+    <br />
+    <br />
+    <a href="https://code.visualstudio.com/">
+        <img
+            src="https://img.shields.io/badge/Supported%20by-VSCode%20Power%20User%20%E2%86%92-gray.svg?colorA=655BE1&colorB=4F44D6&style=for-the-badge" />
+    </a>
+</p>
diff --git 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
@@ -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
@@ -273,22 +273,13 @@ Google Cloud use a **Container-Optimized OS** (see
 `documentation <https://cloud.google.com/container-optimized-os/docs>`__) 
 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 <container-name-or-ID>
 
-.. 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
@@ -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
@@ -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 <https://github.com/ugr-sail/sinergym/issues>`__. 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
diff --git a/images/general_blueprint.png b/images/general_blueprint.png
diff --git a/images/operation_diagram.jpg b/images/operation_diagram.jpg
diff --git a/images/operation_diagram.png b/images/operation_diagram.png
diff --git a/images/weather_types.png b/images/weather_types.png
diff --git a/images/weather_variability.png b/images/weather_variability.png
diff --git a/images/weather_variation.png b/images/weather_variation.png
diff --git a/sinergym/version.txt b/sinergym/version.txt
@@ -1 +1 @@
-2.2.3
+2.2.4