Sinergym

Patch Notes

- Workflows have been updated in order to support pull requests from forked repositories.
- Now workflow in pull request check code format (warnings), documentation and tests.
- Protection workflow is created in order to check users have no modified workflows or tests (this workflow use code base PR always).
- When a pull request is merged or there is a commit pushed in main branch, a workflow will update documentation and code format using a bot commit and it will update container latest tag in Docker Hub
- Github Action documentation has been updated.

Patch Notes

- Close 110 118 117 115 113 112 111 109 108
- Get runperiod info uses **opyplus** functionality.
- Get episode length uses **opyplus** functionality.
- **Class Config** created and integrated in Sinergym simulator like instance.
- IDF's specific for each weather have been deleted (only original IDF's are in the repository).
- DDY's files added to repository to get **Location and DesignDays** about each weather file.
- Tests have been updated for new simulator structure and some tests about Config class have been added.

Config Class

- Config class has **all models like python objects** (using opyplus module for that purpose):
- Building (IDF)
- Weather (EPW)
- Energyplus dictionary (IDD)
- Location and Designday available for each weather (DDY)
- Config class has functionality to **save EPW and IDF** version files in episodes dir_path output from python models.
- Currently, Config class **manages experiments directory path and subdirectories** (migrated from simulator).
- Get runperiod, get episode length and all functionality which depends on building models (opyplus object) have been **migrated** from simulator too.
- Config can **modify building** in order to apply **weather location and designdays** (adaptation to a specific EPŴ functionality) and **apply extra configuration** in simulation with a dictionary parameter (documentation will be updated).
- **Auto-delete episodes directories** when number of them is upper than maximum is migrated to config too.
- Config **apply variation to EPW** and store the file in episode folder.

Common

- Added sinergym.utils.common.py functionality to **read and update building model**:
- Get opyplus record keys.
- Prepare a batch of records.

Simulator

- Deleted all functionality integrated in Config.

Dockerfile

- Dockerfile has been updated with python `3.9.10` in order to close 115 BUG.

GitHub Workflows

- Workflow update the latest tag in Docker Hub has been separated from testing process (now is executed when pull request is merged definitively).

Documentation

- Documentation for this pull request has been written.

Patch notes

- [BUGFIX] Solved documentation workflow bug with API reference compilation (Sphinx).
- [BUGFIX] ZeroDivision Exception managed in normalization wrapper.
- Added gcloud modules in [extras] packages from setup.py.
- Added Documentation for Google Cloud Credentials
- Added Exception management when MLFLOW_TRACKING_URI is an invalid IP.
- Enhanced some docstring code.
- Added *docs/source/_build* to gitignore (this directory is generated by visual studio code preview).
- Update README.md

DRL_battery.py

- Configuration for remote_store and/or mlflow_store.
- Added artifact management in mlflow server.

Patch Notes

- Remote containers auto-delete when their experiments finish.
- Dockerfile has been updated in order to support Mlflow functionality and solve 87.
- Added *DRL* dependency to container registry built from `setup.py`.
- *cloud_manager.py* create a remote bucket if it doesn't exist to store experiments results.
- Added `autopep8` to repository requirements.
- Added functionality to *sinergym/utils/gcloud.py* in order to manage buckets and Google cloud Command from remote containers.
- Experiments now have better names.
- Ternsorboard log path can be customized.
- Mlflow script to set up a Mlflow tracking server in Google Cloud.
- Migrate eplus_old to eplus in simulator script
- Set __version__ variable in sinergym package
- Documentation (some details of this pull request have been added too)

closes 77 79 80 85 88

Bugs Solved

Fix 86, 87, 89, 90, 92 and 93

Patch Notes

- The name of this project and tool will be **Sinergym**!
- All documentation and script have been adaped to this new name.
- Third party accounts and tools have been adapted accordingly as well such as Google Cloud Platform, Docker Hub, container registry, etc.

GitHub Actions is here!

:x: **Travis** has been deactivated due to its temporal interruption service. (in any case, travis conf will be in repository)
:heavy_check_mark: **GitHub Action** will do this job instead and more!

Patch Notes
- There is a bot checking **autopep8** format in python code during pull request (automated commits).
- There is another bot **building** repository environment with *Dockerfile*, Executing **tests** with that and **updating Docker Hub the latest tag** if all tests have been passed.
- Release event is caught in order to **update Docker Hub** with specified tag for repository. (repared)