Merge branch 'master' into gh-pages-custom

ibpsa · Sep 21, 2023 · 4695dde · 4695dde
2 parents a7bd1f5 + 8bba2c8
commit 4695dde
Show file tree

Hide file tree

Showing 9 changed files with 2,254 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ that is being developed as part of the [IBPSA Project 1](https://ibpsa.github.io
 ## Run an example test controller:
 
 * For Python-based example controllers:
-  * Add the directory path to the root of this repository to the ``PYTHONPATH`` environment variable. Use ``export PYTHONPATH=$(pwd):$PYTHONPATH``.
+  * Optionally, add the directory path to the root of this repository to the ``PYTHONPATH`` environment variable. Use ``export PYTHONPATH=$(pwd):$PYTHONPATH``. Note: The Python example updates the ``PYTHONPATH`` just in time.
   * Build and deploy ``testcase1``.  Then, in a separate terminal, use ``$ cd examples/python/ && python testcase1.py`` to test a simple proportional feedback controller on this test case over a two-day period.
   * Build and deploy ``testcase1``.  Then, in a separate terminal, use ``$ cd examples/python/ && python testcase1_scenario.py`` to test a simple proportional feedback controller on this test case over a test period defined using the ``/scenario`` API.
   * Build and deploy ``testcase2``.  Then, in a separate terminal, use ``$ cd examples/python/ && python testcase2.py`` to test a simple supervisory controller on this test case over a two-day period.

diff --git a/docs/workshops/BS23Workshop_20230904/Introduction_to_the_BOPTEST_framework_BS2023.ipynb b/docs/workshops/BS23Workshop_20230904/Introduction_to_the_BOPTEST_framework_BS2023.ipynb
diff --git a/docs/workshops/BS23Workshop_20230904/README.md b/docs/workshops/BS23Workshop_20230904/README.md
@@ -0,0 +1,9 @@
+## BS2023 Workshop
+
+This folder contains materials for the BS2023 Workshop tutorial.
+
+This tutorial was prepared for use with BOPTEST v0.4.0.
+
+Date: September 4, 2023
+
+Place: Shanghai, China
diff --git a/docs/workshops/BS23Workshop_20230904/presentations/Adrenalin_boptest_workshop_pitch.pdf b/docs/workshops/BS23Workshop_20230904/presentations/Adrenalin_boptest_workshop_pitch.pdf
diff --git a/docs/workshops/BS23Workshop_20230904/presentations/BOPTEST_Overview_BS23_20230904.pdf b/docs/workshops/BS23Workshop_20230904/presentations/BOPTEST_Overview_BS23_20230904.pdf
diff --git a/examples/python/testcase1.py b/examples/python/testcase1.py
@@ -11,8 +11,8 @@
 # ----------------------
 import sys
 import os
-from examples.python.interface import control_test
 sys.path.insert(0, '/'.join((os.path.dirname(os.path.abspath(__file__))).split('/')[:-2]))
+from examples.python.interface import control_test
 
 
 def run(plot=False):

diff --git a/examples/python/testcase2.py b/examples/python/testcase2.py
@@ -11,8 +11,8 @@
 # ----------------------
 import sys
 import os
-from examples.python.interface import control_test
 sys.path.insert(0, '/'.join((os.path.dirname(os.path.abspath(__file__))).split('/')[:-2]))
+from examples.python.interface import control_test
 
 
 def run(plot=False):

diff --git a/examples/python/testcase3.py b/examples/python/testcase3.py
@@ -11,8 +11,8 @@
 # ----------------------
 import sys
 import os
-from examples.python.interface import control_test
 sys.path.insert(0, '/'.join((os.path.dirname(os.path.abspath(__file__))).split('/')[:-2]))
+from examples.python.interface import control_test
 
 
 def run(plot=False):

diff --git a/releasenotes.md b/releasenotes.md
@@ -6,13 +6,15 @@ Released on xx/xx/xxxx.
 
 **The following changes are backwards-compatible and do not significantly change benchmark results:**
 
+- Add materials for BS2023 workshop at ``docs/workshops/BS23Workshop_20230904``. This is for [#552](https://github.com/ibpsa/project1-boptest/issues/552). 
 - Allow forecast horizons of 0 to retrieve boundary condition data at current time like pricing or temperature setpoints. This is for [#554](https://github.com/ibpsa/project1-boptest/issues/554).
 - Update ``docs/tutorials/tutorial1_developer`` and ``docs/workshops/BS21Workshop_20210831``.  This is for [#532](https://github.com/ibpsa/project1-boptest/issues/532).
 - In examples and unit test Python requests, use ``json`` attribute instead of ``data``.  This is for [#528](https://github.com/ibpsa/project1-boptest/issues/528).
 - In unit test checking fetching of single forecast variable, specify specific forecast point to check for each test case.  This is for [#529](https://github.com/ibpsa/project1-boptest/issues/529).
 - Update ``KPI_Calculator.get_computational_time_ratio`` to return ``None`` if no simulation steps have been processed. This is for [#540](https://github.com/ibpsa/project1-boptest/issues/540).
 - Add ``forecastParameters`` to dashboard submission with empty dictionary and update url for submitting dashboard results.  This is for [#548](https://github.com/ibpsa/project1-boptest/issues/548).
 - Fix so that results can be submitted to dashboard if sitting at end of scenario time period instead of needing to try to advance one step past.  This is for [#546](https://github.com/ibpsa/project1-boptest/issues/546).
+- Fix for just-in-time adding example python controller scripts to PYTHONPATH.  This is for [#565](https://github.com/ibpsa/project1-boptest/issues/565).
 
 **The following changes are backwards-compatible, but might change benchmark results:**