Beobench

------------------

* Fixes:

* Ensure agent script stdout is shown (e.g. log statements and so on) by replacing ``check_output`` call with ``check_call``. This fixes 99 raised by XkunW (Thanks!).

* Other:

* Add note on maintenance status of project to main readme and docs. Beobench is only receiving minor maintenance updates at this point. Therefore, Beobench may also no longer support the latest versions of the integrated building simulation tools. If you would like to use the latest versions of these tools, it is recommended to use them directly without Beobench.

------------------

* Features:

* Add support for installing agent script's requirements via requirements file (71).

* Improvements

* Add support for dry running ``beobench run`` with ``--dry-run`` flag. This aims to help with testing and debugging.
* Add explicit warning for windows users with recommended fixes (i.e. using WSL instead).

* Fixes:

* Fix Sinergym data ranges in Sinergym experiment container definition in beobench_contrib (96). Fix by XkunW, thanks!
* Remove default normalisation with Sinergym (as this may fail with newer Sinergym versions as pointed out by kad99kev (thanks!)).
* Pin the version of sinergym to the currently latest version to avoid future issues (v2.1.2).
* Change the way Beobench is installed inside experiment containers. Previously this was done using conditional logic inside Dockerfiles. Now the logic is done in Python, with two different dockerfiles for local and pypi installations. This enables the use of non-buildx in the construction of Beobench experiment containers. Credit and thanks to HYDesmondLiu and david-woelfle for finding and sharing the underlying error.
* Fix 90 by removing access to env config before env_creator script. Thanks to HYDesmondLiu, who first flagged this bug in 82.
* If one of the Beobench scheduler subprocesses fails (e.g. docker run) the main process now fails as well.

------------------

* Known issues

* This release breaks the experiment build process for most machines. Thus, this release was yanked on pypi and is not installed unless specifically pinned to. See 82 for more details.

* Improvements:

* Add more informative error when there are issues with access to Docker from Beobench.

* Fixes:

* Revert default build command to ``docker build`` from ``docker buildx build``. Only arm64 machines use ``buildx`` now. This aims to enable usage of older docker versions such as v19.03 on non-arm64 machines. Arm64 machines require buildx and thus also newer docker versions.
* Fix wrong env name in logging output. Removes unused default env name var and fix logging output to use new env name location.

------------------

* Features:

* Add pretty logging based on loguru package. Now all Beobench output is clearly marked as such.

* Improvements:

* Enable adding wrapper without setting config.
* Add ``demo.yaml`` simple example config.

* Fixes:

* Update Sinergym integration to latest Sinergym version.

------------------

* Features:

* Mean and cummulative metrics can now be logged by WandbLogger wrapper.
* Support for automatically running multiple samples/trials of same experiment via ``num_samples`` config parameter.
* Configs named `.beobench.yml` will be automatically parsed when Beobench is run in directory containing such a config. This allows users to set e.g. wandb API keys without referring to the config in every Beobench command call.
* Configs from experiments now specify the Beobench version used. When trying to rerun an experiment this version will be checked, and an error thrown if there is a mismatch between installed and requested version.
* Add improved high-level API for getting started. This uses the CLI arguments ``--method``, ``--gym`` and ``--env``. Example usage: ``beobench run --method ppo --gym sinergym --env Eplus-5Zone-hot-continuous-v1`` (55).

* Improvements:

* Add ``CITATION.cff`` file to make citing software easier.
* By default, docker builds of experiment images are now skipped if an image with tag corresponding to installed Beobench version already exists.
* Remove outdated guides and add yaml configuration description from docs (38, 76, 78).
* Add support for logging multidimensional actions to wandb.
* Add support for logging summary metrics on every env reset to wandb.
* Energym config now uses ``name`` argument like other integrations (34).

* Fixes:

* Updated BOPTEST integration to work with current version of Beobench.

------------------

* Features:

* Add general support for wrappers. (28)

* Improvements:

* Make dev beobench build part of image build process for improved
speed.
* Add number of environment steps (``env_step``) to wandb logging.
* Update logo to new version (48)
* Update docs and main readme to include more useful quickstart guide, which includes a custom agent (47)

* Fixes:

* Enable automatic episode data logging in RLlib integration for long training periods.
* Update broken links in main readme env list (40)