Merge pull request #125 from ibpsa/issue93_versioning

Issue93 versioning

docs/tutorials/CCAI_Summer_School_2022/Building_Control_with_RL_using_BOPTEST.ipynb

@@ -20,6 +20,7 @@
       ]
     },
     {
+      "attachments": {},
       "cell_type": "markdown",
       "metadata": {
         "id": "oT2QjTu24zwV"
@@ -40,13 +41,10 @@
         "- The BOPTEST API and its Gym interface.\n",
         "\n",
         "📌 **Note**: This tutorial is prepared for use with BOPTEST v0.4.0.\n",
-        "and uses a web-based version of BOPTEST (called \"BOPTEST-Service\") as not to require installation of any BOPTEST software on a user's own device. It is also possible to use BOPTEST on a user's own (local) device. Both the web-based and local versions have the same functionality, and will produce the same results, with only small changes in the API (changing the BOPTEST-service url to your localhost url, that is, to: `http://127.0.0.1:5000/<request>`).\n",
+        "and uses a web-based version of BOPTEST (called \"BOPTEST-Service\") as not to require installation of any BOPTEST software on a user's own device. It is also possible to use BOPTEST on a user's own (local) device. \n",
+        "Both the web-based and local versions have the same functionality, and will produce the same results, with only small changes in the API (changing the BOPTEST-service url to your localhost url, that is, to: `http://127.0.0.1:5000/<request>`). The tutorial is continuously updated to work with the latest BOPTEST versions. See [the release notes](https://github.com/ibpsa/project1-boptest-gym/blob/master/releasenotes.md) for the version history.\n",
         "\n",
-        "**EDIT**: This tutorial was originally developed with BOPTEST v0.2.0. and has been continuously updated to work with the latest BOPTEST versions. Specifically, the following updates have been implemented:\n",
-        "\n",
-        "- **BOPTEST v0.4.0.** *Jul 13, 2023*. BOPTEST-Gym internally updates for new BOPTEST API changes when getting results and forecast. Update to Gym v0.26.2. and stable-baselines3 v2.0.0. Import Gymnasium instead of Gym. Change from `compute_reward` to `get_reward` not to fall into Stable Baseline's convention for goal environments. Use `terminated` and `trunctated` outputs from Gym instead of directly `done`. Return `info` upon calling the reset method of Gym.\n",
-        "- **BOPTEST v0.3.0.** *Oct 25, 2022*. There are just small changes required for this update, basically retrieving the `'payload'` after each request. That is the origin of the differences between the notebook explained in the recording and this updated notebook.  \n",
-        "- **BOPTEST v0.2.0.** *Aug 18, 2022*. Initial version."
+        "🎥 **Video**: An explanatory video of this tutorial can be seen [here](https://drive.google.com/file/d/1lvCVQef_kctwCagA5QOVj7QljHQ1xKUQ/view?usp=sharing) for the CCAI2022 Summer School on August 18, 2022. The video starts with a one-hour lecture on the application of machine learning in buildings. The part of BOPTEST-Gym follows right after and lasts for 1.5 hours. Please note that the software version used in the video is v0.2.0. The framework and tutorial have been updated since then so you may notice slight differences in the content and interface. However, the main concepts and explanation behind remains the same. \n"
       ]
     },
     {

releasenotes.md

@@ -0,0 +1,29 @@
+# Release Notes
+
+BOPTEST-Gym has two main dependencies: BOPTEST and Stable-Baselines3. For simplicity, the first two digits of the version number match the same two digits of the BOPTEST version of which BOPTEST-Gym is compatible with. For example, BOPTEST-Gym v0.3.x is compatible with BOPTEST v0.3.x. The last digit is reserved for other internal edits specific to this repository only. See [here](https://github.com/ibpsa/project1-boptest/blob/master/releasenotes.md) for BOPTEST release notes. 
+
+## BOPTEST-Gym v0.4.0-dev
+
+Released on xx/xx/xxxx.
+
+## BOPTEST-Gym v0.4.0
+
+Released on 17/07/2023.
+
+- Update for new BOPTEST API changes when getting forecast. This is for [BOPTEST #356](https://github.com/ibpsa/project1-boptest/issues/356).  
+- Update for new BOPTEST API changes when getting results. This is for [BOPTEST #398](https://github.com/ibpsa/project1-boptest/issues/398).  
+- Update to `Gym v0.26.2.` and `stable-baselines3 v2.0.0`. 
+- Import Gymnasium instead of Gym. Change from `compute_reward` to `get_reward` not to fall into Stable Baseline's convention for goal environments. 
+- Use `terminated` and `trunctated` outputs from Gym instead of directly `done`. Return `info` upon calling the reset method of Gym.
+
+## BOPTEST-Gym v0.3.0
+
+Released on 25/10/2022.
+
+- Retrieve `'payload'` after each request call to BOPTEST. 
+
+## BOPTEST v0.2.0
+
+Released on 18/08/2022.
+
+This is an initial development release.