RubyGems - openstudio-calibration - Versions diffs - 0.7.0 → 0.9.0 - Mend

openstudio-calibration 0.7.0 → 0.9.0

Files changed (125) hide show

data/lib/measures/RoofThermalPropertiesMultiplier/LICENSE.md CHANGED Viewed

@@ -1,27 +1,13 @@
-OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
-Redistribution and use in source and binary forms, with or without modification, are permitted
-provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-(1) Redistributions of source code must retain the above copyright notice, this list of conditions
-and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
-and the following disclaimer in the documentation and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse
-or promote products derived from this software without specific prior written permission from the
-respective party.
+3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
-(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other
-derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar
-designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT,
-OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
-OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/RoofThermalPropertiesMultiplier/measure.rb CHANGED Viewed

@@ -1,36 +1,6 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
-# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
 # *******************************************************************************
 # start the measure

data/lib/measures/RoofThermalPropertiesMultiplier/measure.xml CHANGED Viewed

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>roof_thermal_properties_multiplier</name>
   <uid>6c4eb22b-770f-456c-bcd1-084cfad89eeb</uid>
-  <version_id>8d985618-d187-4491-8b80-45711e889dc9</version_id>
-  <version_modified>20221115T231449Z</version_modified>
+  <version_id>2bb4add5-d936-4469-8a46-d458142e98dd</version_id>
+  <version_modified>20230602T154657Z</version_modified>
   <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>RoofThermalPropertiesMultiplier</class_name>
   <display_name>Roof Thermal Properties Multiplier</display_name>
@@ -86,7 +86,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <checksum>BFFB1AA6</checksum>
     </file>
     <file>
       <version>
@@ -97,13 +97,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>B9518183</checksum>
+      <checksum>7C6B77F6</checksum>
     </file>
     <file>
       <filename>RoofThermalPropertiesMultiplier_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>C98635A2</checksum>
+      <checksum>7197D29B</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/RoofThermalPropertiesPercentChange/LICENSE.md CHANGED Viewed

@@ -1,27 +1,13 @@
-OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
-Redistribution and use in source and binary forms, with or without modification, are permitted
-provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-(1) Redistributions of source code must retain the above copyright notice, this list of conditions
-and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
-and the following disclaimer in the documentation and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse
-or promote products derived from this software without specific prior written permission from the
-respective party.
+3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
-(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other
-derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar
-designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT,
-OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
-OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/RoofThermalPropertiesPercentChange/measure.rb CHANGED Viewed

@@ -1,36 +1,6 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
-# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
 # *******************************************************************************
 # start the measure

data/lib/measures/RoofThermalPropertiesPercentChange/measure.xml CHANGED Viewed

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>roof_thermal_properties_percent_change</name>
   <uid>07516685-60fd-4da8-9872-1154a995047d</uid>
-  <version_id>31e6f50f-fdec-4791-8e73-c672998edd50</version_id>
-  <version_modified>20221115T231447Z</version_modified>
+  <version_id>db469840-e1ca-40ba-a628-58855984662f</version_id>
+  <version_modified>20230602T154656Z</version_modified>
   <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>RoofThermalPropertiesPercentChange</class_name>
   <display_name>Roof Thermal Properties Percent Change</display_name>
@@ -86,7 +86,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <checksum>BFFB1AA6</checksum>
     </file>
     <file>
       <version>
@@ -97,13 +97,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>C9FA7592</checksum>
+      <checksum>3A4BB94C</checksum>
     </file>
     <file>
       <filename>RoofThermalPropertiesMultiplier_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>2B71C690</checksum>
+      <checksum>3F4E0142</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/TimeseriesObjectiveFunction/LICENSE.md CHANGED Viewed

@@ -1,27 +1,13 @@
-OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
-Redistribution and use in source and binary forms, with or without modification, are permitted
-provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-(1) Redistributions of source code must retain the above copyright notice, this list of conditions
-and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
-and the following disclaimer in the documentation and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse
-or promote products derived from this software without specific prior written permission from the
-respective party.
+3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
-(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other
-derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar
-designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT,
-OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
-OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/TimeseriesObjectiveFunction/README.md CHANGED Viewed

@@ -18,6 +18,56 @@ ReportingMeasure
 ## Arguments
+**verbose_messages** will display all the runner.registerInfo statements for the metered value, simulated value and their difference at EVERY timestep. while this is useful for debugging the usage of the Measure, it has a MAJOR impact on performance and will slow the running of the measure.  Turn to False for production runs.
+**csv_name** is the file path, relative to the Measure at runtime, to the CSV data. If this run is taking place on an OS-Server or (OSAF) instance, where the project data is zipped up into an OSA.zip file and posted to the OS-Server Web node (in a directory called **calibration_data**), then relative path to the data would be: '../../../lib/calibration_data/electric_json.json'.  Notice the **lib** in the path name for the OSAF use case.
+**csv_time_header** is the Header Value in the CSV file with metered data for the TIMESTAMP, ex: "timestamp"
+**csv_var**, is the column name of the metered data, ex: "Electricity:Facility[J]"
+**convert_data** is used to convert the units in the CSV from 'F to C', 'WH to J', 'CFM to m3/s', 'PSI to Pa' or **None**
+The timestamp of the CSV data should follow a mm/dd/yyyy hh:mm:ss format with NO AM/PM
+**year** (true) Is the Year in the csv data timestamp => mm/dd/yyyy or mm/dd
+**seconds** (true) Is the Seconds in the csv data timestamp => hh:mm:ss or hh:mm
+The model output variables/meters are listed in the eplusout.rdd and .mdd files.
+The Measure argument **find_avail** (true)  will print out ALL the available RunPeriods (EnvPeriod), ReportingFrequencies, Variables and key values in the run.log file:
+`[15:11:26.640379 INFO] environment_periods: ["Run Period 1"]`\
+`[15:11:26.640418 INFO] available timeseries: ["Electricity:Facility", "NaturalGas:Facility", "Surface Inside Face Temperature", "Zone Outdoor Air Drybulb Temperature"]`\
+`[15:11:26.640424 INFO] `\
+`[15:11:26.640443 INFO] available EnvPeriod: Run Period 1, available ReportingFrequencies: ["Daily", "Hourly", "Zone Timestep"]`\
+`[15:11:26.640454 INFO]   available ReportingFrequency: Daily, available variable names: ["Electricity:Facility", "NaturalGas:Facility"]`\
+`[15:11:26.640463 INFO]     variable names: Electricity:Facility`\
+`[15:11:26.640469 INFO]     available key value: [""]`\
+`[15:11:26.640476 INFO]     variable names: NaturalGas:Facility`\
+`[15:11:26.640481 INFO]     available key value: [""]`\
+`[15:11:26.640493 INFO]   available ReportingFrequency: Hourly, available variable names: ["Electricity:Facility", "NaturalGas:Facility", "Surface Inside Face Temperature", "Zone Outdoor Air Drybulb Temperature"]`\
+`[15:11:26.640499 INFO]     variable names: Electricity:Facility`\
+`[15:11:26.640505 INFO]     available key value: [""]`\
+`[15:11:26.640511 INFO]     variable names: NaturalGas:Facility`\
+`[15:11:26.640516 INFO]     available key value: [""]`\
+`[15:11:26.640526 INFO]     variable names: Surface Inside Face Temperature`\
+`[15:11:26.640539 INFO]     available key value: ["SUB SURFACE 1", "SUB SURFACE 2", "SURFACE 1"]`\
+`[15:11:26.640546 INFO]     variable names: Zone Outdoor Air Drybulb Temperature`\
+`[15:11:26.640552 INFO]     available key value: ["THERMAL ZONE 1"]`\
+`[15:11:26.640561 INFO]   available ReportingFrequency: Zone Timestep, available variable names: ["Electricity:Facility", "NaturalGas:Facility"]`\
+`[15:11:26.640567 INFO]     variable names: Electricity:Facility`\
+`[15:11:26.640573 INFO]     available key value: [""]`\
+`[15:11:26.640579 INFO]     variable names: NaturalGas:Facility`\
+`[15:11:26.640585 INFO]     available key value: [""]`\
+* The name of the variable/timeseries to be compared is used in the **timeseries_name** measure argument.
+* Some variables require a further **key_value** to narrow down the results to a specific object like a Surface or Zone.  Some Meter based outputs have no key, i.e, Electricity:Facility.  For those, use the value **no_key**
+* RunPeriods/EnvPeriod are set in the **environment_period** measure argument.
+* ReportingFrequencies ["Daily", "Hourly", "Zone Timestep"] are set in the **reporting_frequency** measure argument.
 ### Path to CSV file for the metered data
 Path to CSV file including file name.
@@ -60,7 +110,7 @@ CSV variable display name. Not yet Implemented
 **Model Dependent:** false
 ### Year in csv data timestamp
-Is the Year in the csv data timestamp => mm:dd:yy or mm:dd (true/false)
+Is the Year in the csv data timestamp => mm/dd/yyyy or mm/dd (true/false)
 **Name:** year,
 **Type:** Boolean,
 **Units:** ,

data/lib/measures/TimeseriesObjectiveFunction/measure.rb CHANGED Viewed

@@ -1,36 +1,6 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
-# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
 # *******************************************************************************
 # see the URL below for information on how to write OpenStudio measures
@@ -45,17 +15,17 @@ require 'erb'
 class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
   # human readable name
   def name
-    'TimeSeries Objective Function'
+    return 'TimeSeries Objective Function'
   end
   # human readable description
   def description
-    'Creates Objective Function from Timeseries Data'
+    return 'Creates Objective Function from Timeseries Data'
   end
   # human readable description of modeling approach
   def modeler_description
-    "Creates Objective Function from Timeseries Data.  The measure applies a Norm at each timestep between the difference of CSV metered data and SQL model data. A timeseries plot can also be created.  Possible outputs are 'cvrmse', 'nmbe', 'simdata' = sum of the simulated data, 'csvdata' = sum of metered data, 'diff' = P Norm between the metered and simulated data if Norm is 1 or 2, else its just the Difference."
+    return "Creates Objective Function from Timeseries Data.  The measure applies a Norm at each timestep between the difference of CSV metered data and SQL model data. A timeseries plot can also be created.  Possible outputs are 'cvrmse', 'nmbe', 'simdata' = sum of the simulated data, 'csvdata' = sum of metered data, 'diff' = P Norm between the metered and simulated data if Norm is 1 or 2, else its just the Difference."
   end
   # define the arguments that the user will input
@@ -101,7 +71,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
     years = OpenStudio::Measure::OSArgument.makeBoolArgument('year', true)
     years.setDisplayName('Year in csv data timestamp')
-    years.setDescription('Is the Year in the csv data timestamp => mm:dd:yy or mm:dd (true/false)')
+    years.setDescription('Is the Year in the csv data timestamp => mm/dd/yyyy or mm/dd (true/false)')
     years.setDefaultValue(true)
     args << years
@@ -112,9 +82,9 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
     args << seconds
     sql_key = OpenStudio::Measure::OSArgument.makeStringArgument('key_value', true)
-    sql_key.setDisplayName('SQL key value')
+    sql_key.setDisplayName('SQL key value. use no_key if there is no key, i.e. Electricity:Facility')
     sql_key.setDescription('SQL key value for the SQL query to find the variable in the SQL file')
-    sql_key.setDefaultValue('')
+    sql_key.setDefaultValue('no_key')
     args << sql_key
     sql_var = OpenStudio::Measure::OSArgument.makeStringArgument('timeseries_name', true)
@@ -125,7 +95,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
     reportfreq_chs = OpenStudio::StringVector.new
     reportfreq_chs << 'Detailed'
-    reportfreq_chs << 'Timestep'
+    reportfreq_chs << 'Zone Timestep'
     reportfreq_chs << 'Hourly'
     reportfreq_chs << 'Daily'
     reportfreq_chs << 'Monthly'
@@ -175,7 +145,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
     plot_name = OpenStudio::Measure::OSArgument.makeStringArgument('plot_name', true)
     plot_name.setDisplayName('Plot name')
     plot_name.setDescription('Name to include in reporting file name.')
-    plot_name.setDefaultValue('')
+    plot_name.setDefaultValue('plot_name')
     args << plot_name
     verbose_messages = OpenStudio::Measure::OSArgument.makeBoolArgument('verbose_messages', true)
@@ -292,6 +262,11 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
     convert_data = runner.getStringArgumentValue('convert_data', user_arguments)
     last_zero = runner.getBoolArgumentValue('add_last_zero_for_plots', user_arguments)
     first_zero = runner.getBoolArgumentValue('add_first_zero_for_plots', user_arguments)
+    # remove leading and trailing double quotes
+    # windows users can shift + right click a file to copy as path, which has double quotes
+    csv_name.gsub!('"', '')
     @name = plot_name
     # Method to translate from OpenStudio's time formatting
     # to Javascript time formatting
@@ -368,11 +343,11 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
         runner.registerInfo("available EnvPeriod: #{env_s}, available ReportingFrequencies: #{freqs}")
         freqs.each do |freq|
           vn = sql.availableVariableNames(env_s, freq.to_s)
-          runner.registerInfo("available variable names: #{vn}")
+          runner.registerInfo("  available ReportingFrequency: #{freq}, available variable names: #{vn}")
           vn.each do |v|
             kv = sql.availableKeyValues(env_s, freq.to_s, v)
-            runner.registerInfo("variable names: #{v}")
-            runner.registerInfo("available key value: #{kv}")
+            runner.registerInfo("    variable names: #{v}")
+            runner.registerInfo("    available key value: #{kv}")
           end
         end
       end
@@ -380,63 +355,63 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
     runner.registerInfo("year: #{years}")
     runner.registerInfo("seconds: #{seconds}")
     if !years && seconds
-      # mm:dd hh:mm:ss
+      # mm/dd hh:mm:ss
       # check day time splits into two valid parts
       if !csv[1][0].split(' ')[0].nil? && !csv[1][0].split(' ')[1].nil?
         # check remaining splits are valid
         if !csv[1][0].split(' ')[0].split('/')[0].nil? && !csv[1][0].split(' ')[0].split('/')[1].nil? && !csv[1][0].split(' ')[1].split(':')[0].nil? && !csv[1][0].split(' ')[1].split(':')[1].nil? && !csv[1][0].split(' ')[1].split(':')[2].nil?
-          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm:dd hh:mm:ss")
+          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm/dd hh:mm:ss")
         else
-          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm:dd hh:mm:ss")
+          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm/dd hh:mm:ss")
           return false
         end
       else
-        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm:dd hh:mm:ss")
+        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm/dd hh:mm:ss")
         return false
       end
     elsif !years && !seconds
-      # mm:dd hh:mm
+      # mm/dd hh:mm
       # check day time splits into two valid parts
       if !csv[1][0].split(' ')[0].nil? && !csv[1][0].split(' ')[1].nil?
         # check remaining splits are valid
         if !csv[1][0].split(' ')[0].split('/')[0].nil? && !csv[1][0].split(' ')[0].split('/')[1].nil? && !csv[1][0].split(' ')[1].split(':')[0].nil? && !csv[1][0].split(' ')[1].split(':')[1].nil?
-          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm:dd hh:mm")
+          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm/dd hh:mm")
         else
-          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm:dd hh:mm")
+          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm/dd hh:mm")
           return false
         end
       else
-        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm:dd hh:mm")
+        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm/dd hh:mm")
         return false
       end
     elsif years && !seconds
-      # mm:dd:yy hh:mm
+      # mm/dd/yyyy hh:mm
       # check day time splits into two valid parts
       if !csv[1][0].split(' ')[0].nil? && !csv[1][0].split(' ')[1].nil?
         # check remaining splits are valid
         if !csv[1][0].split(' ')[0].split('/')[0].nil? && !csv[1][0].split(' ')[0].split('/')[1].nil? && !csv[1][0].split(' ')[0].split('/')[2].nil? && !csv[1][0].split(' ')[1].split(':')[0].nil? && !csv[1][0].split(' ')[1].split(':')[1].nil?
-          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm:dd:yy hh:mm")
+          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm/dd/yyyy hh:mm")
         else
-          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm:dd:yy hh:mm")
+          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm/dd/yyyy hh:mm")
           return false
         end
       else
-        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm:dd:yy hh:mm")
+        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm/dd/yyyy hh:mm")
         return false
       end
     elsif years && seconds
-      # mm:dd:yy hh:mm:ss
+      # mm/dd/yyyy hh:mm:ss
       # check day time splits into two valid parts
       if !csv[1][0].split(' ')[0].nil? && !csv[1][0].split(' ')[1].nil?
         # check remaining splits are valid
         if !csv[1][0].split(' ')[0].split('/')[0].nil? && !csv[1][0].split(' ')[0].split('/')[1].nil? && !csv[1][0].split(' ')[0].split('/')[2].nil? && !csv[1][0].split(' ')[1].split(':')[0].nil? && !csv[1][0].split(' ')[1].split(':')[1].nil? && !csv[1][0].split(' ')[1].split(':')[2].nil?
-          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm:dd:yy hh:mm:ss")
+          runner.registerInfo("CSV Time format is correct: #{csv[1][0]} mm/dd/yyyy hh:mm:ss")
         else
-          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm:dd:yy hh:mm:ss")
+          runner.registerError("CSV Time format not correct: #{csv[1][0]}. Selected format is mm/dd/yyyy hh:mm:ss")
           return false
         end
       else
-        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm:dd:yy hh:mm:ss")
+        runner.registerError("CSV Time format not correct: #{csv[1][0]}. Does not split into 'day time'. Selected format is mm/dd/yyyy hh:mm:ss")
         return false
       end
     end
@@ -541,9 +516,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
             if year.nil?
               dat = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(cal[mon]), day)
             else
-              # dat = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(cal[mon]),day,year)
-              # hack since year is not in the sql file correctly
-              dat = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(cal[mon]), day)
+              dat = OpenStudio::Date.new(OpenStudio::MonthOfYear.new(cal[mon]),day,year)
             end
             tim = if sec.nil?
                     OpenStudio::Time.new(0, hou, min, 0)
@@ -659,7 +632,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
         if algorithm_download
           require 'csv'
-          CSV.open("timeseries#{plot_name}.csv", 'wb') do |csv|
+          CSV.open("timeseries_#{plot_name}.csv", 'wb') do |csv|
             csv << ['Simulation Time', 'Simulated Value', 'Metered time', 'Metered Value']
             data.size.times do |i|
               csv << [data[i]['time'], data[i]['y'], data2[i]['time'], data2[i]['y']]
@@ -688,7 +661,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
         Dir.mkdir(directory_name) unless File.exist?(directory_name)
         FileUtils.cp("timeseries_#{csv_var}.json", directory_name)
         FileUtils.cp("allseries_#{csv_var}.json", directory_name)
-        FileUtils.cp("timeseries#{plot_name}.csv", directory_name)
+        FileUtils.cp("timeseries_#{plot_name}.csv", directory_name)
       end
     end
     diff = Math.sqrt(diff) if norm == 2