Updates for 0.6.0 release

ibpsa · Apr 3, 2024 · 30f650e · 30f650e
1 parent 74a0e24
commit 30f650e
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 10 deletions.
diff --git a/docs/user_guide/source/api.rst b/docs/user_guide/source/api.rst
@@ -225,13 +225,14 @@ PUT /forecast
 POST /advance
 -------------
 
-- **Description:** Advance simulation one control step with optional control input(s) and receive measurements.  If specified, control input value(s) will be constant over the control step.
+- **Description:** Advance simulation one control step with optional control input(s) and receive measurements.  If specified, control input value(s) will be constant over the control step.  Use <input_name_u> to specify value and corresponding <input_name_activate> to enable value overwrite for the input.
 
 - **Arguments:**
 
     ::
 
-        <input_name>  // optional, float, value of input point
+        <input_name_u>          // optional, float, value of input point to overwrite
+        <input_name_activate>   // optional, float, enable corresponding input overwrite if greater than 0 (default is 0)
 
 - **Returns:**
 

diff --git a/docs/user_guide/source/conf.py b/docs/user_guide/source/conf.py
@@ -45,7 +45,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'BOPTEST User Guide v0.5.0'
+project = u'BOPTEST User Guide v0.6.0'
 copyright = u''
 author = u''
 
@@ -56,7 +56,7 @@
 # The short X.Y version.
 #version = u'0.1'
 # The full version, including alpha/beta/rc tags.
-release = u'0.5.0'
+release = u'0.6.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -238,7 +238,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'BOPTESTUserGuide.tex', u'BOPTEST User Guide v0.5.0',
+    (master_doc, 'BOPTESTUserGuide.tex', u'BOPTEST User Guide v0.6.0',
      u'', 'manual'),
 ]
 
@@ -268,7 +268,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'BOPTESTUserGuide', u'BOPTEST User Guide v0.5.0',
+    (master_doc, 'BOPTESTUserGuide', u'BOPTEST User Guide v0.6.0',
      [author], 1)
 ]
 
@@ -282,7 +282,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'BOPTESTUserGuide', u'BOPTEST User Guide v0.5.0',
+    (master_doc, 'BOPTESTUserGuide', u'BOPTEST User Guide v0.6.0',
      author, 'BOPTESTUserGuide', 'One line description of project.',
      'Miscellaneous'),
 ]

diff --git a/web/01_software.md b/web/01_software.md
@@ -7,11 +7,11 @@ hero_height: is-fullwidth
 
 # Download the Latest BOPTEST Software
 
-The latest version is ``v0.5.0``, released on October 04, 2023.
+The latest version is ``v0.6.0``, released on April 03, 2024.
 
 Click the button below to download the latest version as a zip file.
 
-<a class="button is-primary" href="https://github.com/ibpsa/project1-boptest/releases/download/v0.5.0/project1-boptest-0.5.0.zip"><b>Download</b></a>
+<a class="button is-primary" href="https://github.com/ibpsa/project1-boptest/releases/download/v0.6.0/project1-boptest-0.6.0.zip"><b>Download</b></a>
 
 Get started with the [User Guide](/docs-userguide/index.html).
 

diff --git a/web/08_contributors.md b/web/08_contributors.md
@@ -37,6 +37,7 @@ Thank you to all contributors of the project.  They are in alphabetical order:
 - **Bart Merema (dnergy, Belgium)** for test case implementation (multizone_office_simple_hybrid).
 - **Kefei Mo (Pacific Northwest National Laboratory, USA)** for software implementation.
 - **Erik Paulson (Independent, USA)** for BACnet interface development.
+- **Matt Robinson (University of Colorado Boulder, USA)** for software implementation.
 - **Marjorie Schott (National Renewable Energy Laboratory, USA)** for online dashboard development.
 - **Jermy Thomas (National Renewable Energy Laboratory, USA)** for web-service development, tutorial development.
 - **Christian Veje (Southern Denmark University, Denmark)** for framework development.

diff --git a/web/_data/testcases_menubar.yml b/web/_data/testcases_menubar.yml
@@ -1,4 +1,4 @@
-- label: Available in Latest Release (v0.5.0)
+- label: Available in Latest Release (v0.6.0)
   items:
     - name: BESTEST Air
       link: /testcases/ibpsa/testcases_ibpsa_bestest_air/

diff --git a/web/_posts/2024-04-03-v060.md b/web/_posts/2024-04-03-v060.md
@@ -0,0 +1,14 @@
+---
+layout: post
+title: v0.6.0 released (<a href="https://github.com/ibpsa/project1-boptest/releases/tag/v0.6.0/">highlights and release notes</a>)
+hero_height: is-fullwidth
+author: David Blum
+---
+
+This is a new development version that contains mostly maintenance updates. Highlights include:
+
+- Allow simulations and forecast to work across the end of the year to the next year.
+- Add storing of scenario result trajectories, kpis, and test information to simulation directory within test case docker container.
+- Improve test case input documentation.
+
+For all changes and more details, see [releasenotes.md](https://github.com/ibpsa/project1-boptest/blob/v0.6.0/releasenotes.md).