openstudio-calibration 0.3.1 → 0.4.0

data/lib/measures/{zone_report → inspect_and_edit_parametric_schedules}/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2021, 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:

data/lib/measures/inspect_and_edit_parametric_schedules/README.md

@@ -0,0 +1,41 @@
+
+
+
+![Apply Measures Now Dialog](./docs/apply_measures_now.png?raw=true)
+*Each parametric schedule will have a series of arguments including one or more profile, and optionally a ceiling and floor value which can be used in the profile formulas.*
+
+Additional documentation will follow at a later date.
+
+###### (Automatically generated documentation below)
+
+# Inspect and Edit Parametric Schedules
+
+## Description
+This model will create arguments out of additional property inputs for parametric schedules in the model. You can use this just to inspect, or you can alter the inputs. It will not make parametric inputs for schedules that are not already setup as parametric. If you want to generate parametric schedules you can first run the Shift Hours of Operation Schedule with default 0 argument values for change in hours of operation.
+
+## Modeler Description
+This can be used in apply measure now, or can be used in a parametric workflow to load in any custom user profiles or floor/ceiling values.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Apply Parametric Schedules to the Model
+When this is true the parametric schedules will be regenerated based on modified formulas, ceiling and floor values, and current horus of operation for building.
+**Name:** apply_parametric_sch,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+
+
+
+

data/lib/measures/inspect_and_edit_parametric_schedules/README.md.erb

@@ -0,0 +1,53 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+
+![Apply Measures Now Dialog](./docs/apply_measures_now.png?raw=true)
+*Each parametric schedule will have a series of arguments including one or more profile, and optionally a ceiling and floor value which can be used in the profile formulas.*
+
+Additional documentation will follow at a later date.
+
+###### (Automatically generated documentation below)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+
+<% if argument[:type] == "Choice" && !argument[:model_dependent]%>
+**Choice Display Names** <%= argument[:choice_display_names] %>
+<% end %>
+
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>

data/lib/measures/inspect_and_edit_parametric_schedules/measure.rb

@@ -0,0 +1,224 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2021, 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.
+# *******************************************************************************
+
+# insert your copyright here
+
+# see the URL below for information on how to write OpenStudio measures
+# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
+
+require 'openstudio-standards'
+
+# load OpenStudio measure libraries from openstudio-extension gem
+require 'openstudio-extension'
+require 'openstudio/extension/core/os_lib_helper_methods'
+
+# start the measure
+class InspectAndEditParametricSchedules < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    # Measure name should be the title case of the class name.
+    return 'Inspect and Edit Parametric Schedules'
+  end
+
+  # human readable description
+  def description
+    return 'This model will create arguments out of additional property inputs for parametric schedules in the model. You can use this just to inspect, or you can alter the inputs. It will not make parametric inputs for schedules that are not already setup as parametric. If you want to generate parametric schedules you can first run the Shift Hours of Operation Schedule with default 0 argument values for change in hours of operation.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'This can be used in apply measure now, or can be used in a parametric workflow to load in any custom user profiles or floor/ceiling values.'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # code to inspect formulas and code floor/ceiling values
+    model.getScheduleRulesets.sort.each do |sch|
+      # get ceiling and floor
+      floor = sch.additionalProperties.getFeatureAsDouble('param_sch_floor')
+      ceiling = sch.additionalProperties.getFeatureAsDouble('param_sch_ceiling')
+      if floor.is_initialized || ceiling.is_initialized
+
+        # argument for floor
+        arg_name = "#{sch.name} Floor Value"
+        floor_val = OpenStudio::Measure::OSArgument.makeDoubleArgument(arg_name.downcase.gsub(' ', '_'), true)
+        floor_val.setDisplayName(arg_name)
+        floor_val.setDescription('floor can be used by formulas')
+        floor_val.setDefaultValue(floor.get)
+        args << floor_val
+
+        # argument for floor
+        arg_name = "#{sch.name} Ceiling Value"
+        ceiling_val = OpenStudio::Measure::OSArgument.makeDoubleArgument(arg_name.downcase.gsub(' ', '_'), true)
+        ceiling_val.setDisplayName(arg_name)
+        ceiling_val.setDescription('ceiling can be used by formulas')
+        ceiling_val.setDefaultValue(ceiling.get)
+        args << ceiling_val
+
+      end
+
+      # loop through rules
+      sch_days = {}
+      sch.scheduleRules.each do |rule|
+        if rule.startDate.is_initialized
+          start_date = "#{rule.startDate.get.monthOfYear.value}/#{rule.startDate.get.dayOfMonth}"
+        else
+          start_date = 'na'
+        end
+        if rule.startDate.is_initialized
+          end_date = "#{rule.endDate.get.monthOfYear.value}/#{rule.endDate.get.dayOfMonth}"
+        else
+          end_date = 'na'
+        end
+        dow = []
+        if rule.applyMonday then dow << 'mon' end
+        if rule.applyTuesday then dow << 'tue' end
+        if rule.applyWednesday then dow << 'wed' end
+        if rule.applyThursday then dow << 'thur' end
+        if rule.applyFriday then dow << 'fri' end
+        if rule.applySaturday then dow << 'sat' end
+        if rule.applySunday then dow << 'sun' end
+
+        sch_days[rule.daySchedule] = "#{dow.inspect} from #{start_date} through #{end_date}"
+      end
+
+      # add default profile
+      sch_days[sch.defaultDaySchedule] = 'default profile'
+
+      # should appear in similar oder to GUI now with default on the bottom
+      sch_days.each do |sch_day, description|
+        prop = sch_day.additionalProperties.getFeatureAsString('param_day_profile')
+        if prop.is_initialized
+
+          # argument for formulas
+          arg_name = "#{sch.name}_#{sch_day.name}"
+          formula = OpenStudio::Measure::OSArgument.makeStringArgument(arg_name.downcase.gsub(' ', '_'), true)
+          formula.setDisplayName(arg_name)
+          formula.setDescription(description)
+          formula.setDefaultValue(prop.to_s)
+          args << formula
+        end
+      end
+    end
+
+    # merge internal loads
+    apply_parametric_sch = OpenStudio::Measure::OSArgument.makeBoolArgument('apply_parametric_sch', true)
+    apply_parametric_sch.setDisplayName('Apply Parametric Schedules to the Model')
+    apply_parametric_sch.setDescription('When this is true the parametric schedules will be regenerated based on modified formulas, ceiling and floor values, and current horus of operation for building.')
+    apply_parametric_sch.setDefaultValue(true)
+    args << apply_parametric_sch
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+
+    # assign the user inputs to variables
+    args = OsLib_HelperMethods.createRunVariables(runner, model, user_arguments, arguments(model))
+    if !args then return false end
+
+    # setup log messages that will come from standards
+    OsLib_HelperMethods.setup_log_msgs(runner, true) # bool is debug
+
+    # load standards
+    standard = Standard.build('90.1-2004') # selected template doesn't matter
+
+    # change formulas, ceiling, adn floor values from arguments
+    counter_parametric_schedules = []
+    model.getScheduleRulesets.sort.each do |sch|
+      # get ceiling and floor
+      floor = sch.additionalProperties.getFeatureAsDouble('param_sch_floor')
+      ceiling = sch.additionalProperties.getFeatureAsDouble('param_sch_ceiling')
+      if floor.is_initialized || ceiling.is_initialized
+
+        # argument for floor
+        arg_name = "#{sch.name} Floor Value"
+        sch.additionalProperties.setFeature('param_sch_floor', args[arg_name.downcase.gsub(' ', '_')])
+
+        # argument for ceiling
+        arg_name = "#{sch.name} Ceiling Value"
+        sch.additionalProperties.setFeature('param_sch_ceiling', args[arg_name.downcase.gsub(' ', '_')])
+      end
+
+      # loop through rules
+      sch_days = {}
+      sch.scheduleRules.each do |rule|
+        sch_days[rule.daySchedule] = nil
+      end
+
+      # add default profile
+      sch_days[sch.defaultDaySchedule] = 'default profile'
+
+      # should appear in similar oder to GUI now with default on the bottom
+      sch_days.each do |sch_day, not_used|
+        prop = sch_day.additionalProperties.getFeatureAsString('param_day_profile')
+        if prop.is_initialized
+
+          # argument for formulas
+          arg_name = "#{sch.name}_#{sch_day.name}"
+          sch_day.additionalProperties.setFeature('param_day_profile', args[arg_name.downcase.gsub(' ', '_')])
+
+          # add to counter for initial condition
+          counter_parametric_schedules << sch
+
+        end
+      end
+    end
+
+    # report initial condition of model
+    runner.registerInitialCondition("The building started with #{counter_parametric_schedules.uniq.size.size} parametric schedules.")
+
+    #   if requested re-generate schedules
+    if args['apply_parametric_sch']
+      parametric_schedules = standard.model_apply_parametric_schedules(model, ramp_frequency: nil, infer_hoo_for_non_assigned_objects: true, error_on_out_of_order: true)
+      runner.registerInfo("Applying #{parametric_schedules.size} parametric schedules.")
+    end
+
+    # report final condition of model
+    runner.registerFinalCondition("The building finished with #{parametric_schedules.size} parametric schedules.")
+
+    # report log messages from standards
+    OsLib_HelperMethods.log_msgs
+
+    return true
+  end
+end
+
+# register the measure to be used by the application
+InspectAndEditParametricSchedules.new.registerWithApplication

data/lib/measures/inspect_and_edit_parametric_schedules/measure.xml

@@ -0,0 +1,131 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>inspect_and_edit_parametric_schedules</name>
+  <uid>4b5f610d-caac-47c2-bd5b-610e2fc0768e</uid>
+  <version_id>63f5e931-e682-4ed2-8f66-23c0e6f0b82f</version_id>
+  <version_modified>20210423T201850Z</version_modified>
+  <xml_checksum>57318DBA</xml_checksum>
+  <class_name>InspectAndEditParametricSchedules</class_name>
+  <display_name>Inspect and Edit Parametric Schedules</display_name>
+  <description>This model will create arguments out of additional property inputs for parametric schedules in the model. You can use this just to inspect, or you can alter the inputs. It will not make parametric inputs for schedules that are not already setup as parametric. If you want to generate parametric schedules you can first run the Shift Hours of Operation Schedule with default 0 argument values for change in hours of operation.</description>
+  <modeler_description>This can be used in apply measure now, or can be used in a parametric workflow to load in any custom user profiles or floor/ceiling values.</modeler_description>
+  <arguments>
+    <argument>
+      <name>apply_parametric_sch</name>
+      <display_name>Apply Parametric Schedules to the Model</display_name>
+      <description>When this is true the parametric schedules will be regenerated based on modified formulas, ceiling and floor values, and current horus of operation for building.</description>
+      <type>Boolean</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>true</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Whole Building.Whole Building Schedules</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Model Articulation</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Calibration</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Retrofit EE</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>.gitkeep</filename>
+      <filetype>gitkeep</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>00000000</checksum>
+    </file>
+    <file>
+      <filename>example_parametric_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>A0C68C28</checksum>
+    </file>
+    <file>
+      <filename>apply_measures_now.png</filename>
+      <filetype>png</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>2D9A8051</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>F073FF6D</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>A551610E</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
+    </file>
+    <file>
+      <filename>inspect_and_edit_parametric_schedules_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>70619B79</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>3.1.0</identifier>
+        <min_compatible>3.1.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>6C4E596B</checksum>
+    </file>
+  </files>
+</measure>