Documentation source update detected and pushed compilation build dir…

…ectory for Github Pages

docs/compilation/main/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6ec10aa988f56f8653db3d2767195dda
+config: 6ae9c1cd9f2482e2b23dd5023239db6c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/compilation/main/_sources/index.rst.txt

@@ -52,6 +52,8 @@ If you use Sinergym in your work, please cite our `paper <https://dl.acm.org/doi
    :hidden:
    :caption: sinergym
 
+   pages/buildings.rst
+   pages/weathers.rst
    pages/environments.rst
    pages/rewards.rst
    pages/controllers.rst

docs/compilation/main/_sources/pages/buildings.rst.txt

@@ -0,0 +1,104 @@
+############
+Buildings
+############
+
+This section provides information specific to the buildings included in Sinergym, 
+independently of the rest of the components that make up the environment to be 
+used in each experiment. If you are interested in including new buildings to this 
+framework, please visit section :ref:`Adding new buildings for environments`.
+
+**************************
+Datacenter
+**************************
+
+.. image:: /_static/datacenter.png
+  :width: 700
+  :alt: Datacenter building
+  :align: center
+
+**2ZoneDataCenterHVAC_wEconomizer.idf:**
+It is a 491.3 m2 building divided into two asymmetrical zones. Each
+zone has an HVAC system consisting of air economizers, evaporative
+coolers, DX cooling coil, chilled water coil, and VAV. The
+main source of heat comes from the hosted servers.
+
+**************************
+5Zone
+**************************
+
+.. image:: /_static/5zone.png
+  :width: 700
+  :alt: 5Zone building
+  :align: center
+
+**5ZoneAutoDXVAV.idf:**
+A single-story building divided
+into zones (1 indoor and 4 outdoor). Its surface area is 463.6
+m2, and it is equipped with a VAV package (DX cooling coil
+and gas heating coils) with fully auto-sized input as the HVAC
+system to be controlled.
+
+**************************
+Warehouse
+**************************
+
+.. image:: /_static/warehouse.png
+  :width: 700
+  :alt: Warehouse building
+  :align: center
+
+**ASHRAE9012016_Warehouse.idf:**
+It is a non-residential 4598 m2 floor building, 
+divided into three zones: bulk storage, fine storage and an office. 
+The Office zone is enclosed on two sides and at the top by the 
+Fine Storage zone, and it is the unique zone with windows. 
+Available fuel types are gas and electricity, and it is equipped 
+with HVAC system.
+
+**************************
+OfficeMedium
+**************************
+
+.. image:: /_static/officeMedium.png
+  :width: 700
+  :alt: OfficeMedium building
+  :align: center
+
+**ASHRAE9012016_OfficeMedium.idf:**
+It is a 4979.6 m2 building with three floors. Each floor has 
+four perimeter zones and one core zone. Available fuel types 
+are gas and electricity, and it is equipped with HVAC system.
+
+**************************
+ShopWithVanBattery
+**************************
+
+.. image:: /_static/shop.png
+  :width: 700
+  :alt: Shop building
+  :align: center
+
+**ShopWithVanBattery.idf:**
+It is a 390.2 m2 building, with only one floor. It has five
+zones; four of them are perimeter zones and one in the center.
+This is a low-energy building with photovoltaic panel and 
+electrical storage. It demonstrates the use of the battery 
+model for electrical storage. It has a full HVAC model and 
+water heating service.
+This is a small repair shop. Open Monday through Friday,
+45 hours per week. 
+
+**************************
+OfficeGridStorageSmoothing
+**************************
+
+.. image:: /_static/officeGrid.png
+  :width: 700
+  :alt: Shop building
+  :align: center
+
+**OfficeGridStorageSmoothing.idf:**
+It is an office building with 12 floors + a basement, with a rectangular aspect and 46,320 m2. 
+The building is organized in 19 zones: the basement, bot, mid and top level. Each level has a
+core zone and 4 perimeter zones. Floor zone is described for bot, mid and top level too.
+It has a battery control for charging and discharging from the grid.

docs/compilation/main/_sources/pages/github-actions.rst.txt

@@ -16,11 +16,11 @@ Pull Request
 - **Python Code format check**: Python code format is checked in every pull 
   request following **Pep8** `standard <https://www.python.org/dev/peps/pep-0008/>`__ 
   (Level 2 aggressive) and `isort <https://github.com/PyCQA/isort>`__ to sort imports. 
-  In case the code does not follow the standar, a warning will rise during the workflow execution.
+  In case the code does not follow the standard, a warning will rise during the workflow execution.
 
 - **Code type check**: We are using `pytype <https://github.com/google/pytype>`__ in 
-  *Sinergym* module. This check controls input and output types in functions and methods. This workflow ignores `import-error` 
-  type using command `pytype -d import-error sinergym/`.
+  *Sinergym* module. This check controls input and output types in functions and methods. 
+  This workflow ignores `import-error` type using command `pytype -d import-error sinergym/`.
   For example, **pytype** cannot include google cloud storage module, so this option 
   specification is necessary. If some type error happens, the workflow shows an error until the
   user fixes it.
@@ -29,20 +29,23 @@ Pull Request
   modified in every pull-request. If source documentation has been updated, it will 
   **compile** documentation with *Sphinx* and raise errors if they exist.
   This workflow checks **vocabulary spelling** too. If you have a mistake and *Sphinx* 
-  finds an unknown word, this workflow will return an error. In case you want to use a word that is not in the default 
-  dictionary, please add that word to `docs/source/spelling_wordlist.txt` 
+  finds an unknown word, this workflow will return an error. In case you want to use a 
+  word that is not in the default dictionary, please add that word to `docs/source/spelling_wordlist.txt` 
   (please, respect alphabetical order) because Sphinx-spelling accepts words allocated 
   in that list.
 
 .. Warning:: Sphinx Warning messages behave like errors for workflow status.
 
 .. Note:: Sphinx Spelling works on code docstring too.
 
-- **Testing**: It is an action that builds a remote container using *Dockerfile* and executes **Pytest** inside that container. It is a remote container because it is built in Github, just for testing purposes.
+- **Testing**: It is an action that builds a remote container using *Dockerfile* and executes **Pytest** 
+  inside that container. It is a remote container because it is built in Github, just for testing purposes.
 
-- **Repository security**: This workflow identifies differences between source and base in workflows and tests. It executes that functionality only in forked repositories in order to **prevent malicious software** in the workflow, for instances, attemps to ignore tests. 
-  The event is *pull_request_target*, this means the workflow is checkout from base repository 
-  (our main branch) and it cannot be manipulated by third-parties.
+- **Repository security**: This workflow identifies differences between source and base in workflows 
+  and tests. It executes that functionality only in forked repositories in order to **prevent malicious 
+  software** in the workflow, for instances, attempts to ignore tests. The event is *pull_request_target*, 
+  this means the workflow is checkout from base repository (our main branch) and it cannot be manipulated 
+  by third-parties.
 
 .. Note:: These checks can be skipped in a specific commit writing `[ci skip]` string 
           in commit message. For more information, see issue 
@@ -66,7 +69,8 @@ These workflows will be executed in sequential order:
 - **Update our Docker Hub repository**: This job builds a container with all extra 
   requirements and it is pushed to our 
   `Docker Hub repository <https://hub.docker.com/r/sailugr/sinergym>`__ 
-  using *latest* tag automatically. This update is execured only when the preivous format and documentation workflows have succesfully finished.
+  using *latest* tag automatically. This update is executed only when the previous format 
+  and documentation workflows have successfully finished.
 
 ********************************
 New release created or modified

docs/compilation/main/_sources/pages/modules/sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.rst.txt

@@ -0,0 +1,44 @@
+sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper
+==========================================================================
+
+.. currentmodule:: sinergym.utils.wrappers
+
+.. autoclass:: OfficeGridStorageSmoothingActionConstraintsWrapper
+   :members:                                                           
+   :undoc-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.__init__
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.action
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.class_name
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.close
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.compute_reward
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.render
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.reset
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.reverse_action
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.seed
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.step
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.action_space
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.metadata
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.observation_space
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.reward_range
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.spec
+      ~OfficeGridStorageSmoothingActionConstraintsWrapper.unwrapped
+
+

docs/compilation/main/_sources/pages/modules/sinergym.utils.wrappers.rst.txt

@@ -1,4 +1,4 @@
-sinergym.utils.wrappers
+sinergym.utils.wrappers
 =======================
 
 .. automodule:: sinergym.utils.wrappers
@@ -22,6 +22,7 @@ sinergym.utils.wrappers
       LoggerWrapper
       MultiObsWrapper
       NormalizeObservation
+      OfficeGridStorageSmoothingActionConstraintsWrapper
 
 
 

docs/compilation/main/_sources/pages/weathers.rst.txt

@@ -0,0 +1,40 @@
+############
+Weathers
+############
+
+Specific information on the climates included in Sinergym is provided below, 
+independently of the rest of the components that make up the environment to 
+be used in each experiment.
+
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| Weather file                                                 | Location                  | Climate type                                                                               | M.A.T (ºC)  | M.A.H (%)  |
++==============================================================+===========================+============================================================================================+=============+============+
+| AUS_NSW.Sydney.947670_IWEC                                   | Sydney, Australia         | Humid subtropical (no dry seasons and hot summers)                                         | 17.9        | 68.83      |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| COL_Bogota.802220_IWEC                                       | Bogota, Colombia          | Mediterranean (dry, warm summers and mild winters).                                        | 13.2        | 80.3       |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| ESP_Granada.084190_SWEC                                      | Granada, Spain            | Mid-latitude dry semiarid and hot dry periods in summer, but passive cooling is possible.  | 14.84       | 59.83      |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| FIN_Helsinki.029740_IWEC                                     | Helsinki, Finland         | Moist continental (warm summers, cold winters, no dry seasons).                            | 5.1         | 79.25      |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| JPN_Tokyo.Hyakuri.477150_IWEC                                | Tokyo, Japan              | Humid subtropical (mild with no dry season, hot summer).                                   | 8.9         | 78.6       |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| MDG_Antananarivo.670830_IWEC                                 | Antananarivo, Madagascar  | Mediterranean climate (dry warm summer, mild winter).                                      | 18.35       | 75.91      |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| USA_AZ_Davis-Monthan.AFB.722745_TMY3                         | Arizona, USA              | Subtropical hot desert (hot and dry).                                                      | 21.7        | 34.9       |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| USA_CO_Aurora-Buckley.Field.ANGB.724695_TMY3                 | Colorado, USA             | Mid-latitude dry semiarid (cool and dry).                                                  | 9.95        | 55.25      |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| USA_IL_Chicago-OHare.Intl.AP.725300_TMY3                     | Illinois, USA             | Humid continental (mixed and humid).                                                       | 9.92        | 70.3       |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3              | New York, USA             | Humid continental (mixed and humid).                                                       | 12.6        | 68.5       |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| USA_PA_Pittsburgh-Allegheny.County.AP.725205_TMY3            | Pennsylvania, USA         | Humid continental (cool and humid).                                                        | 10.5        | 66.41      |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+| USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3  | Washington, USA           | Cool Marine west coastal (warm summer, mild winter, rain all year).                        | 9.3         | 81.1       |
++--------------------------------------------------------------+---------------------------+--------------------------------------------------------------------------------------------+-------------+------------+
+
+Weather types according to `DOE's
+classification <https://www.energycodes.gov/development/commercial/prototype_models#TMY3>`__.
+
+If you are interested in including new weathers to this framework, please visit section :ref:`Adding new weathers for environments`.