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: 56969c84903cfe5de986d4183e638a9f
+config: e50e9e9e725e4c4a79fe6389537e7fd0
 tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -28,6 +28,24 @@ main source of heat comes from the hosted servers.
   :alt: Datacenter building
   :align: center
 
+**************************
+Small Datacenter
+**************************
+
+**1ZoneDataCenterCRAC_wApproachTemp.epJSON**:
+This file demonstrates a simple data center model with air-cooled IT equipment 
+(ITE) served by a CRAC system. The air-cooled ITE illustrates the user of various schedules 
+and curves to vary server power use. The CRAC system has been setup to represent a 
+Lieber DSE 125 with pumped refrigerant economizer DX cooling coil system.Fictional 
+1 zone building with resistive walls. No windows. Data Center server ITE object 
+for internal gains.  No internal mass.  The building is oriented due north.
+
+
+.. image:: /_static/small_datacenter.png
+  :width: 700
+  :alt: Small Datacenter building
+  :align: center
+
 **************************
 5Zone
 **************************

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

@@ -420,54 +420,64 @@ available for *Sinergym* visit section :ref:`Extra Configuration in Sinergym sim
 Adding new weathers for environments
 **************************************
 
-*Sinergym* includes several weathers covering different types of climate in different areas of the world. 
-The aim is to provide the greatest possible diversity for the experiments taking into account certain 
-characteristics.
+*Sinergym* includes diverse weather files covering various climates worldwide to maximize experiment diversity.
 
-However, you may need or want to include a **new weather** for an experiment. Therefore, this section 
-is dedicated to give an explanation of how to do it:
+To add a **new weather**:
 
-1. Download **EPW** file and **DDY** file in `EnergyPlus page <https://energyplus.net/weather>`__. *DDY* file
-   contains information about the location and different design days available for that weather.
-2. Both files (*EPW* and *DDY*) must have exactly the same name, being the extension the only difference. 
-   They should be placed in the `weathers <https://github.com/ugr-sail/sinergym/tree/main/sinergym/data/weather>`__ folder.
+1. Download an **EPW** and a corresponding **DDY** file from the `EnergyPlus page <https://energyplus.net/weather>`__.
+   The *DDY* file specifies location and design day information.
 
-That is all! *Sinergym* should be able to adapt ``SizingPeriod:DesignDays`` and ``Site:Location`` fields in building 
-model file using *DDY* automatically for that weather.
+2. Ensure both files have identical names, differing only in their extensions, and place them in 
+   the `weathers <https://github.com/ugr-sail/sinergym/tree/main/sinergym/data/weather>`__ folder.
+
+*Sinergym* will automatically adjust the ``SizingPeriod:DesignDays`` and ``Site:Location`` fields in 
+the building model file using the *DDY* file for the added weather.
 
 **************************************
 Adding new buildings for environments
 **************************************
 
-As we have already mentioned, a user can change the already available environments or even create new environment 
-definitions including new climates, action and observation spaces, etc. However, perhaps you want to use a 
-**new building model** (*epJSON* file) than the ones we support.
+Users can modify existing environments or create new environment definitions, incorporating new climates, 
+action and observation spaces. Additionally, they have the option to use a different **building model** (epJSON file) 
+than the ones currently supported.
+
+To add new buildings for use with *Sinergym*, follow these steps:
+
+1. **Add your building file** (*epJSON*) to the `buildings <https://github.com/ugr-sail/sinergym/tree/main/sinergym/data/buildings>`__.
+   Ensure compatibility with EnergyPlus version used in *Sinergym*.
+   If you are using an *IDF* file with an older version, it is advisable to update it with **IDFVersionUpdater** and then convert 
+   it to *epJSON* format using **ConvertInputFormat**. Both tools are accessible in the EnergyPlus installation folder.
+
+2. **Adjusting building objects** like ``RunPeriod`` and ``SimulationControl`` to meet user needs, 
+   as these elements define how interaction episodes will be in *Sinergym*.
 
-This section is intended to provide information if someone decides to add new buildings for use with *Sinergym*. 
-The main steps you have to follow are the next:
+3. We need to **identify the components** of the building that we want to observe and control, respectively. This is the most 
+   challenging part of the process. Typically, the user is already familiar with the building and therefore knows the *name* 
+   and *key* of the elements in advance. If not, the following process can be followed.
 
-1. Add your building file (*epJSON*) to `buildings <https://github.com/ugr-sail/sinergym/tree/main/sinergym/data/buildings>`__.
-   *EnergyPlus* pretends to work with *JSON* format instead of *IDF* format in their building definitions and simulations. Then,
-   *Sinergym* pretends to work with this format from v2.4.0 or higher directly. You can download a *IDF* file and convert
-   to *epJSON* using their **ConvertInputFormat tool** from *EnergyPlus*.
-   **Be sure that new epJSON model version is compatible with EnergyPlus version**.
+   To view the different ``OutputVariables`` and ``Meters``, a preliminary simulation with EnergyPlus can be conducted directly 
+   without establishing any control flow. The output files, specifically the file with the *RDD* extension, can be consulted 
+   to identify the possible observable variables.
 
-2. Add your own *EPW* file for weather conditions (section :ref:`Adding new weathers for environments`) 
-   or use ours in environment constructor. 
+   The challenge lies in knowing the names but not the possible *Keys* (EnergyPlus does not initially provide this information). 
+   These names can be used to define the environment (see step 3). If the *Key* is incorrect, *Sinergym* will notify of the 
+   error and provide a file called **data_available.txt** in the aoutput, since it has already connected with the EnergyPlus API. This file will 
+   contain all the **controllable schedulers** for the actions and all the **observable variables**, this time with their respective *Keys*, 
+   enabling the correct definition of the environment.
 
-3. *Sinergym* will check that observation and action variables specified in environments constructor are 
-   available in the simulation before starting. You need to ensure that the variables definition are correct. 
+4. Once this information is obtained, the next step is **defining the environment** using the building model. 
+   We have several options:
 
-4. Use the environment constructor or register your own environment ID `here <https://github.com/ugr-sail/sinergym/blob/main/sinergym/__init__.py>`__ 
-   following the same structure than the demo environment. You will have to specify environment components. 
-   We have examples about how to get environment information in :ref:`Getting information about Sinergym environments`.
+  a. Use the *Sinergym* environment constructor directly. The arguments for building observation and 
+     control are explained within the class and should be specified in the same format as the EnergyPlus API.
 
-5. Now, you can use your own environment ID with ``gym.make()`` like our documentation examples.
+  b. Set up the configuration to register environment IDs directly. For detailed information on this, refer to 
+     the documentation :ref:`Environments Configuration and Registration`. *Sinergym* will verify that the 
+     established configuration is entirely correct and notify of any potential errors.
 
-Once the first step has been performed, it is also possible to **register a set of environments 
-automatically** in *Sinergym* by writing its corresponding configuration file in ``sinergym/data/default_configuration/<configuration_JSON_file>``. 
-For more information on this, see :ref:`Environments Configuration and Registration`.
+5. If you've used *Sinergym*'s registry, you'll have access to environment IDs paired with your building. Use them 
+   with ``gym.make(<environment_id>)`` as usual. If you've created an environment instance directly, simply use 
+   that instance to start interacting with the building.
 
-.. important:: In order to know the available variables, meters, actuators, etc. You can try to do an empty control in the building and look for files
-               such as RDD, MDD, MTD or ``data_available.txt`` file generated with *EnergyPlus* API in the output folder by *Sinergym*.
+.. note:: For obtain information about the environment instance with the new building model, see reference :ref:`Getting information about Sinergym environments`.
 

docs/compilation/main/pages/buildings.html

@@ -57,11 +57,12 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">3. Buildings</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#datacenter">3.1. Datacenter</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#zone">3.2. 5Zone</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#warehouse">3.3. Warehouse</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#officemedium">3.4. OfficeMedium</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#shopwithvanbattery">3.5. ShopWithVanBattery</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#officegridstoragesmoothing">3.6. OfficeGridStorageSmoothing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#small-datacenter">3.2. Small Datacenter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#zone">3.3. 5Zone</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#warehouse">3.4. Warehouse</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#officemedium">3.5. OfficeMedium</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#shopwithvanbattery">3.6. ShopWithVanBattery</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#officegridstoragesmoothing">3.7. OfficeGridStorageSmoothing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="weathers.html">4. Weathers</a></li>
@@ -142,8 +143,19 @@ <h2><span class="section-number">3.1. </span>Datacenter<a class="headerlink" hre
 main source of heat comes from the hosted servers.</p>
 <a class="reference internal image-reference" href="../_images/datacenter.png"><img alt="Datacenter building" class="align-center" src="../_images/datacenter.png" style="width: 700px;" /></a>
 </section>
+<section id="small-datacenter">
+<h2><span class="section-number">3.2. </span>Small Datacenter<a class="headerlink" href="#small-datacenter" title="Link to this heading"></a></h2>
+<p><strong>1ZoneDataCenterCRAC_wApproachTemp.epJSON</strong>:
+This file demonstrates a simple data center model with air-cooled IT equipment
+(ITE) served by a CRAC system. The air-cooled ITE illustrates the user of various schedules
+and curves to vary server power use. The CRAC system has been setup to represent a
+Lieber DSE 125 with pumped refrigerant economizer DX cooling coil system.Fictional
+1 zone building with resistive walls. No windows. Data Center server ITE object
+for internal gains.  No internal mass.  The building is oriented due north.</p>
+<a class="reference internal image-reference" href="../_images/small_datacenter.png"><img alt="Small Datacenter building" class="align-center" src="../_images/small_datacenter.png" style="width: 700px;" /></a>
+</section>
 <section id="zone">
-<h2><span class="section-number">3.2. </span>5Zone<a class="headerlink" href="#zone" title="Link to this heading"></a></h2>
+<h2><span class="section-number">3.3. </span>5Zone<a class="headerlink" href="#zone" title="Link to this heading"></a></h2>
 <p><strong>5ZoneAutoDXVAV.epJSON:</strong>
 A single-story building divided
 into 5 zones (1 indoor and 4 outdoor). Its surface area is 463.6
@@ -153,7 +165,7 @@ <h2><span class="section-number">3.2. </span>5Zone<a class="headerlink" href="#z
 <a class="reference internal image-reference" href="../_images/5zone.png"><img alt="5Zone building" class="align-center" src="../_images/5zone.png" style="width: 700px;" /></a>
 </section>
 <section id="warehouse">
-<h2><span class="section-number">3.3. </span>Warehouse<a class="headerlink" href="#warehouse" title="Link to this heading"></a></h2>
+<h2><span class="section-number">3.4. </span>Warehouse<a class="headerlink" href="#warehouse" title="Link to this heading"></a></h2>
 <p><strong>ASHRAE9012016_Warehouse.epJSON:</strong>
 It is a non-residential 4598 m2 floor building,
 divided into 3 zones: bulk storage, fine storage and an office.
@@ -164,15 +176,15 @@ <h2><span class="section-number">3.3. </span>Warehouse<a class="headerlink" href
 <a class="reference internal image-reference" href="../_images/warehouse.png"><img alt="Warehouse building" class="align-center" src="../_images/warehouse.png" style="width: 700px;" /></a>
 </section>
 <section id="officemedium">
-<h2><span class="section-number">3.4. </span>OfficeMedium<a class="headerlink" href="#officemedium" title="Link to this heading"></a></h2>
+<h2><span class="section-number">3.5. </span>OfficeMedium<a class="headerlink" href="#officemedium" title="Link to this heading"></a></h2>
 <p><strong>ASHRAE9012016_OfficeMedium.epJSON:</strong>
 It is a 4979.6 m2 building with 3 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.</p>
 <a class="reference internal image-reference" href="../_images/officeMedium.png"><img alt="OfficeMedium building" class="align-center" src="../_images/officeMedium.png" style="width: 700px;" /></a>
 </section>
 <section id="shopwithvanbattery">
-<h2><span class="section-number">3.5. </span>ShopWithVanBattery<a class="headerlink" href="#shopwithvanbattery" title="Link to this heading"></a></h2>
+<h2><span class="section-number">3.6. </span>ShopWithVanBattery<a class="headerlink" href="#shopwithvanbattery" title="Link to this heading"></a></h2>
 <p><strong>ShopWithVanBattery.epJSON:</strong>
 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.
@@ -185,7 +197,7 @@ <h2><span class="section-number">3.5. </span>ShopWithVanBattery<a class="headerl
 <a class="reference internal image-reference" href="../_images/shop.png"><img alt="Shop building" class="align-center" src="../_images/shop.png" style="width: 700px;" /></a>
 </section>
 <section id="officegridstoragesmoothing">
-<h2><span class="section-number">3.6. </span>OfficeGridStorageSmoothing<a class="headerlink" href="#officegridstoragesmoothing" title="Link to this heading"></a></h2>
+<h2><span class="section-number">3.7. </span>OfficeGridStorageSmoothing<a class="headerlink" href="#officegridstoragesmoothing" title="Link to this heading"></a></h2>
 <p><strong>OfficeGridStorageSmoothing.epJSON:</strong>
 It is a large office building with 12 floors and 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