Skip to content

Commit

Permalink
Documentation source update detected and pushed compilation build dir…
Browse files Browse the repository at this point in the history 
…ectory for Github Pages
  • Loading branch information
@AlejandroCN7 @github-actions
AlejandroCN7 authored and github-actions[bot] committed Jun 1, 2023
1 parent afe190d commit a81917f
Show file tree
Hide file tree
Showing 4,482 changed files with 47,268 additions and 49 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Binary file modified docs/compilation/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/compilation/doctrees/pages/installation.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/doctrees/pages/modules/sinergym.config.modeling.ModelJSON.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/compilation/main/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 0a4198400d430cd6e174e8322fe9329a
config: 65dd2ce9f6af94c901933bede715cded
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/compilation/main/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/API-reference.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/buildings.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/controllers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/deep-reinforcement-learning.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/environments.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/extra-configuration.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/gcloudAPI.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/github-actions.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/installation.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/introduction.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.modeling.Model.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.modeling.ModelJSON.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.modeling.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.envs.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.envs.eplus_env.EplusEnv.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.envs.eplus_env.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.base.BaseSimulator.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.base.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.eplus.EnergyPlus.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.eplus.doctree
View file
Binary file not shown.
Binary file modified ...mpilation/main/.doctrees/pages/modules/sinergym.simulators.eplus_alpha.EnergyPlus.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.eplus_alpha.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.callbacks.LoggerCallback.doctree
View file
Binary file not shown.
Binary file modified ...pilation/main/.doctrees/pages/modules/sinergym.utils.callbacks.LoggerEvalCallback.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.callbacks.doctree
View file
Binary file not shown.
Binary file modified ...lation/main/.doctrees/pages/modules/sinergym.utils.common.create_variable_weather.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.doctree
View file
Binary file not shown.
Binary file modified ...mpilation/main/.doctrees/pages/modules/sinergym.utils.common.eppy_element_to_dict.doctree
View file
Binary file not shown.
Binary file modified ...tion/main/.doctrees/pages/modules/sinergym.utils.common.export_actuators_to_excel.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.common.get_delta_seconds.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.get_record_keys.doctree
View file
Binary file not shown.
Binary file modified ...ation/main/.doctrees/pages/modules/sinergym.utils.common.get_season_comfort_range.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.is_wrapped.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.ranges_getter.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.unwrap_wrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.constants.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.controllers.RBC5Zone.doctree
View file
Binary file not shown.
Binary file modified ...compilation/main/.doctrees/pages/modules/sinergym.utils.controllers.RBCDatacenter.doctree
View file
Binary file not shown.
Binary file modified ...pilation/main/.doctrees/pages/modules/sinergym.utils.controllers.RandomController.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.controllers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.env_checker.check_env.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.env_checker.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.evaluation.doctree
View file
Binary file not shown.
Binary file modified ...ompilation/main/.doctrees/pages/modules/sinergym.utils.evaluation.evaluate_policy.doctree
View file
Binary file not shown.
Binary file modified .../.doctrees/pages/modules/sinergym.utils.gcloud.delete_instance_MIG_from_container.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.doctree
View file
Binary file not shown.
Binary file modified ...tion/main/.doctrees/pages/modules/sinergym.utils.gcloud.get_service_account_token.doctree
View file
Binary file not shown.
Binary file modified ...ompilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.init_storage_client.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.read_from_bucket.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.upload_to_bucket.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.CSVLogger.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.Logger.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.logger.WandBOutputFormat.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.BaseReward.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.ExpReward.doctree
View file
Binary file not shown.
Binary file modified ...ompilation/main/.doctrees/pages/modules/sinergym.utils.rewards.HourlyLinearReward.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.LinearReward.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.DatetimeWrapper.doctree
View file
Binary file not shown.
Binary file modified ...n/main/.doctrees/pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.LoggerWrapper.doctree
View file
Binary file not shown.
Binary file modified ...ilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.MultiObjectiveReward.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.MultiObsWrapper.doctree
View file
Binary file not shown.
Binary file modified ...ilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.NormalizeObservation.doctree
View file
Binary file not shown.
Binary file modified ...odules/sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.doctree
View file
Binary file not shown.
Binary file modified ...n/main/.doctrees/pages/modules/sinergym.utils.wrappers.PreviousObservationWrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/basic_example.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/change_environment.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/default_building_control.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/drl.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/personalize_loggerwrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/rule_controller_example.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/wrappers_examples.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/output.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/rewards.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/tests.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/usage-example.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/weathers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/wrappers.doctree
View file
Binary file not shown.
32 changes: 18 additions & 14 deletions docs/compilation/main/_sources/pages/installation.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,21 @@ Sinergym has a set of dependencies (such as the simulator), which have
to be covered depending on the version. Below it is a summary table showing
the versions supported by Sinergym throughout its releases:

+----------------------+--------------------+--------------------+------------------------+
| **Sinergym version** | **Ubuntu version** | **Python version** | **EnergyPlus version** |
+----------------------+--------------------+--------------------+------------------------+
| **0.0** | 18.04 LTS | 3.6 | 8.3.0 |
+----------------------+--------------------+--------------------+------------------------+
| **1.1.0** | 18.04 LTS | 3.6 | **9.5.0** |
+----------------------+--------------------+--------------------+------------------------+
| **1.7.0** | 18.04 LTS | **3.9** | 9.5.0 |
+----------------------+--------------------+--------------------+------------------------+
| **1.9.5** | **22.04 LTS** | **3.10** | 9.5.0 |
+----------------------+--------------------+--------------------+------------------------+
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **Sinergym version** | **Ubuntu version** | **Python version** | **EnergyPlus version** | **Building model file** |
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **0.0** | 18.04 LTS | 3.6 | 8.3.0 | IDF |
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **1.1.0** | 18.04 LTS | 3.6 | **9.5.0** | IDF |
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **1.7.0** | 18.04 LTS | **3.9** | 9.5.0 | IDF |
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **1.9.5** | **22.04 LTS** | **3.10.6** | 9.5.0 | IDF |
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **2.4.0** | 22.04 LTS | 3.10.6 | 9.5.0 | **epJSON** |
+----------------------+--------------------+--------------------+------------------------+---------------------------+
| **2.5.0** | 22.04 LTS | 3.10.6 | **23.1.0** | epJSON |
+----------------------+--------------------+--------------------+------------------------+---------------------------+

In any case, it is recommended to always use the latest version of Sinergym
supported by the container to avoid having to go into the installation details.
Expand Down Expand Up @@ -101,16 +105,16 @@ Now, we have a correct python version with required modules to run *Sinergym*.
Let's continue with the rest of the programs that are needed outside of Python
to run the simulations:

Install EnergyPlus 9.5.0
Install EnergyPlus 23.1.0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Install *EnergyPlus*. Currently it has been update compatibility to ``9.5.0`` and it has
Install *EnergyPlus*. Currently it has been update compatibility to ``23.1.0`` and it has
been tested, but code may also work with other versions, but they don't have been tested.

Follow the instructions `here <https://energyplus.net/downloads>`__ and
install it for Linux (only **Ubuntu** is supported by us). Choose any location
to install the software. Once installed, a folder called
``Energyplus-9-5-0`` should appear in the selected location.
``Energyplus-23-1-0`` should appear in the selected location.

Install BCVTB software
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,7 @@ <h2 id="Z">Z</h2>
<dd><a href="../v2.3.2/index.html">v2.3.2</a></dd>
<dd><a href="../v2.3.3/index.html">v2.3.3</a></dd>
<dd><a href="../v2.3.4/index.html">v2.3.4</a></dd>
<dd><a href="../v2.4.1/index.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,7 @@ <h2>Citing Sinergym<a class="headerlink" href="#citing-sinergym" title="Permalin
<dd><a href="../v2.3.2/index.html">v2.3.2</a></dd>
<dd><a href="../v2.3.3/index.html">v2.3.3</a></dd>
<dd><a href="../v2.3.4/index.html">v2.3.4</a></dd>
<dd><a href="../v2.4.1/index.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
Binary file modified docs/compilation/main/objects.inv
View file
Binary file not shown.
1 change: 1 addition & 0 deletions docs/compilation/main/pages/API-reference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ <h1>API reference<a class="headerlink" href="#api-reference" title="Permalink to
<dd><a href="../../v2.3.2/pages/API-reference.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/API-reference.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/API-reference.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/API-reference.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/buildings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@ <h2><span class="section-number">3.6. </span>OfficeGridStorageSmoothing<a class=
<dd><a href="../../v2.3.2/pages/buildings.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/buildings.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/buildings.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/buildings.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/controllers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ <h1><span class="section-number">7. </span>Controllers<a class="headerlink" href
<dd><a href="../../v2.3.2/pages/controllers.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/controllers.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/controllers.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/controllers.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/deep-reinforcement-learning.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,7 @@ <h3><span class="section-number">11.4.2. </span>Load a trained model<a class="he
<dd><a href="../../v2.3.2/pages/deep-reinforcement-learning.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/deep-reinforcement-learning.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/deep-reinforcement-learning.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/deep-reinforcement-learning.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/environments.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1109,6 +1109,7 @@ <h2><span class="section-number">5.5. </span>Adding new buildings for environmen
<dd><a href="../../v2.3.2/pages/environments.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/environments.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/environments.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/environments.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/extra-configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ <h2><span class="section-number">9.2. </span>runperiod<a class="headerlink" href
<dd><a href="../../v2.3.2/pages/extra-configuration.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/extra-configuration.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/extra-configuration.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/extra-configuration.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/gcloudAPI.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,7 @@ <h2><span class="section-number">12.3. </span>Google Cloud Alerts<a class="heade
<dd><a href="../../v2.3.2/pages/gcloudAPI.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/gcloudAPI.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/gcloudAPI.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/gcloudAPI.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/github-actions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ <h2><span class="section-number">13.3. </span>New release created or modified<a
<dd><a href="../../v2.3.2/pages/github-actions.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/github-actions.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/github-actions.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/github-actions.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
30 changes: 24 additions & 6 deletions docs/compilation/main/pages/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l2"><a class="reference internal" href="#docker-container">1.1. Docker container</a></li>
<li class="toctree-l2"><a class="reference internal" href="#manual-installation">1.2. Manual installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#configure-python-environment">1.2.1. Configure Python environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-energyplus-9-5-0">1.2.2. Install EnergyPlus 9.5.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-energyplus-23-1-0">1.2.2. Install EnergyPlus 23.1.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-bcvtb-software">1.2.3. Install BCVTB software</a></li>
<li class="toctree-l3"><a class="reference internal" href="#set-environment-variables">1.2.4. Set environment variables</a></li>
</ul>
Expand Down Expand Up @@ -129,26 +129,43 @@ <h1><span class="section-number">1. </span>Installation<a class="headerlink" hre
<td><p><strong>Ubuntu version</strong></p></td>
<td><p><strong>Python version</strong></p></td>
<td><p><strong>EnergyPlus version</strong></p></td>
<td><p><strong>Building model file</strong></p></td>
</tr>
<tr class="row-even"><td><p><strong>0.0</strong></p></td>
<td><p>18.04 LTS</p></td>
<td><p>3.6</p></td>
<td><p>8.3.0</p></td>
<td><p>IDF</p></td>
</tr>
<tr class="row-odd"><td><p><strong>1.1.0</strong></p></td>
<td><p>18.04 LTS</p></td>
<td><p>3.6</p></td>
<td><p><strong>9.5.0</strong></p></td>
<td><p>IDF</p></td>
</tr>
<tr class="row-even"><td><p><strong>1.7.0</strong></p></td>
<td><p>18.04 LTS</p></td>
<td><p><strong>3.9</strong></p></td>
<td><p>9.5.0</p></td>
<td><p>IDF</p></td>
</tr>
<tr class="row-odd"><td><p><strong>1.9.5</strong></p></td>
<td><p><strong>22.04 LTS</strong></p></td>
<td><p><strong>3.10</strong></p></td>
<td><p><strong>3.10.6</strong></p></td>
<td><p>9.5.0</p></td>
<td><p>IDF</p></td>
</tr>
<tr class="row-even"><td><p><strong>2.4.0</strong></p></td>
<td><p>22.04 LTS</p></td>
<td><p>3.10.6</p></td>
<td><p>9.5.0</p></td>
<td><p><strong>epJSON</strong></p></td>
</tr>
<tr class="row-odd"><td><p><strong>2.5.0</strong></p></td>
<td><p>22.04 LTS</p></td>
<td><p>3.10.6</p></td>
<td><p><strong>23.1.0</strong></p></td>
<td><p>epJSON</p></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -224,14 +241,14 @@ <h3><span class="section-number">1.2.1. </span>Configure Python environment<a cl
Let’s continue with the rest of the programs that are needed outside of Python
to run the simulations:</p>
</section>
<section id="install-energyplus-9-5-0">
<h3><span class="section-number">1.2.2. </span>Install EnergyPlus 9.5.0<a class="headerlink" href="#install-energyplus-9-5-0" title="Permalink to this heading"></a></h3>
<p>Install <em>EnergyPlus</em>. Currently it has been update compatibility to <code class="docutils literal notranslate"><span class="pre">9.5.0</span></code> and it has
<section id="install-energyplus-23-1-0">
<h3><span class="section-number">1.2.2. </span>Install EnergyPlus 23.1.0<a class="headerlink" href="#install-energyplus-23-1-0" title="Permalink to this heading"></a></h3>
<p>Install <em>EnergyPlus</em>. Currently it has been update compatibility to <code class="docutils literal notranslate"><span class="pre">23.1.0</span></code> and it has
been tested, but code may also work with other versions, but they don’t have been tested.</p>
<p>Follow the instructions <a class="reference external" href="https://energyplus.net/downloads">here</a> and
install it for Linux (only <strong>Ubuntu</strong> is supported by us). Choose any location
to install the software. Once installed, a folder called
<code class="docutils literal notranslate"><span class="pre">Energyplus-9-5-0</span></code> should appear in the selected location.</p>
<code class="docutils literal notranslate"><span class="pre">Energyplus-23-1-0</span></code> should appear in the selected location.</p>
</section>
<section id="install-bcvtb-software">
<h3><span class="section-number">1.2.3. </span>Install BCVTB software<a class="headerlink" href="#install-bcvtb-software" title="Permalink to this heading"></a></h3>
Expand Down Expand Up @@ -355,6 +372,7 @@ <h2><span class="section-number">1.5. </span>Cloud Computing<a class="headerlink
<dd><a href="../../v2.3.2/pages/installation.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/installation.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/installation.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/installation.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/introduction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@
<dd><a href="../../v2.3.2/pages/introduction.html">v2.3.2</a></dd>
<dd><a href="../../v2.3.3/pages/introduction.html">v2.3.3</a></dd>
<dd><a href="../../v2.3.4/pages/introduction.html">v2.3.4</a></dd>
<dd><a href="../../v2.4.1/pages/introduction.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@
<dd><a href="../../../v2.3.2/index.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/index.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/index.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.config.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.config.modeling.Model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ <h1>sinergym.config.modeling.Model<a class="headerlink" href="#sinergym-config-m
<dd><a href="../../../v2.3.2/index.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/index.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/index.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.config.modeling.Model.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
3 changes: 2 additions & 1 deletion docs/compilation/main/pages/modules/sinergym.config.modeling.ModelJSON.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ <h1>sinergym.config.modeling.ModelJSON<a class="headerlink" href="#sinergym-conf
<li><p><strong>experiment_path</strong> – Path for Sinergym experiment output</p></li>
<li><p><strong>episode_path</strong> – Path for Sinergym specific episode (before first simulator reset this param is None)</p></li>
<li><p><strong>max_ep_store</strong> – Number of episodes directories will be stored in experiment_path</p></li>
<li><p><strong>config</strong> – Dict config with extra configuration which is required to modify IDF model (may be None)</p></li>
<li><p><strong>config</strong> – Dict config with extra configuration which is required to modify building model (may be None)</p></li>
<li><p><strong>_idd</strong> – IDD opyplus object to set up Epm</p></li>
<li><p><strong>building</strong> – Building model (Dictionary extracted from JSON)</p></li>
<li><p><strong>ddy_model</strong> – opyplus Epm object with DDY model</p></li>
Expand Down Expand Up @@ -443,6 +443,7 @@ <h1>sinergym.config.modeling.ModelJSON<a class="headerlink" href="#sinergym-conf
<dd><a href="../../../v2.3.2/index.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/index.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/index.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.config.modeling.ModelJSON.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.config.modeling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@
<dd><a href="../../../v2.3.2/index.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/index.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/index.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.config.modeling.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.envs.eplus_env.EplusEnv.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,7 @@ <h1>sinergym.envs.eplus_env.EplusEnv<a class="headerlink" href="#sinergym-envs-e
<dd><a href="../../../v2.3.2/pages/modules/sinergym.envs.eplus_env.EplusEnv.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/pages/modules/sinergym.envs.eplus_env.EplusEnv.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/pages/modules/sinergym.envs.eplus_env.EplusEnv.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.envs.eplus_env.EplusEnv.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.envs.eplus_env.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@
<dd><a href="../../../v2.3.2/pages/modules/sinergym.envs.eplus_env.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/pages/modules/sinergym.envs.eplus_env.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/pages/modules/sinergym.envs.eplus_env.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.envs.eplus_env.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.envs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@
<dd><a href="../../../v2.3.2/pages/modules/sinergym.envs.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/pages/modules/sinergym.envs.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/pages/modules/sinergym.envs.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.envs.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.simulators.base.BaseSimulator.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ <h1>sinergym.simulators.base.BaseSimulator<a class="headerlink" href="#sinergym-
<dd><a href="../../../v2.3.2/pages/modules/sinergym.simulators.base.BaseSimulator.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/pages/modules/sinergym.simulators.base.BaseSimulator.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/pages/modules/sinergym.simulators.base.BaseSimulator.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.simulators.base.BaseSimulator.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.simulators.base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@
<dd><a href="../../../v2.3.2/pages/modules/sinergym.simulators.base.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/pages/modules/sinergym.simulators.base.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/pages/modules/sinergym.simulators.base.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.simulators.base.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
1 change: 1 addition & 0 deletions docs/compilation/main/pages/modules/sinergym.simulators.eplus.EnergyPlus.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@ <h1>sinergym.simulators.eplus.EnergyPlus<a class="headerlink" href="#sinergym-si
<dd><a href="../../../v2.3.2/pages/modules/sinergym.simulators.eplus.EnergyPlus.html">v2.3.2</a></dd>
<dd><a href="../../../v2.3.3/pages/modules/sinergym.simulators.eplus.EnergyPlus.html">v2.3.3</a></dd>
<dd><a href="../../../v2.3.4/pages/modules/sinergym.simulators.eplus.EnergyPlus.html">v2.3.4</a></dd>
<dd><a href="../../../v2.4.1/pages/modules/sinergym.simulators.eplus.EnergyPlus.html">v2.4.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
Expand Down
Loading

0 comments on commit a81917f

Please sign in to comment.