Issue464 move io html

contributors.md

@@ -21,3 +21,4 @@ Thank you to all who have provided guidance on the development of this software.
 - Harald Walnum, SINTEF
 - Michael Wetter, Lawrence Berkeley National Laboratory
 - Tao Yang, University of Southern Denmark
+- Ettore Zanetti, Lawrence Berkeley National Laboratory

data/README.md

@@ -58,3 +58,14 @@ object in the process of initializing the test.
 data only for the requested index or period of time. This
 method would be used by the ``KPI_Calculator`` or
 ``Forecaster`` modules.
+
+## Generate Documentation for Test Case I/O Points
+``get_html_IO.py`` can be used to generate the html documentation
+code for I/O in alphabetical order.
+Outputs of the script:
+- ``inputs.txt``: html code documenting the inputs
+- ``measurements.txt``: html code documenting the outputs
+
+In order to run the script, deploy the BOPTEST testcase, where the deployment
+guide is in the ``README.md`` file in the root directory. Then, open a terminal
+in the ``/data`` folder and run the script ``python get_html_IO.py``.

releasenotes.md

@@ -6,8 +6,9 @@ Released on xx/xx/xxxx.
 
 **The following changes are backwards-compatible and do not significantly change benchmark results:**
 
-- Add unit test reporting script to each individual unit test target in the ``testing/makefile``.  This is for [#466](https://github.com/ibpsa/project1-boptest/issues/466).
+- Add ``get_html_IO.py`` to ``/data`` folder and remove it from ``/testcases`` folders to avoid code duplication. This is for [#464](https://github.com/ibpsa/project1-boptest/issues/464).
 - Abstract the definition of input and output lists within if-else statements in the API unit tests in ``utilities.py`` to the setUp method in each test cases's specific testing file ``test_<testcase>``, by introducing the ``input`` and ``measurement`` attributes.  This is for [#463](https://github.com/ibpsa/project1-boptest/issues/463).
+- Add unit test reporting script to each individual unit test target in the ``testing/makefile``.  This is for [#466](https://github.com/ibpsa/project1-boptest/issues/466).
 
 ## BOPTEST v0.3.0