openstudio-common-measures 0.3.0 → 0.3.1

data/lib/measures/EnableDemandControlledVentilation/measure.xml

@@ -1,99 +0,0 @@
-<measure>
-  <schema_version>3.0</schema_version>
-  <name>enable_demand_controlled_ventilation</name>
-  <uid>3ff4b412-8689-4b11-a588-935c621dc97d</uid>
-  <version_id>bde5f0d5-ecf6-4425-936c-0a216cdc35d4</version_id>
-  <version_modified>20200229T024316Z</version_modified>
-  <xml_checksum>ECE70A70</xml_checksum>
-  <class_name>EnableDemandControlledVentilation</class_name>
-  <display_name>Enable Demand Controlled Ventilation</display_name>
-  <description>The facility currently does not have a demand controlled ventilation system or CO2 sensors in the air delivery system. Outside air is introduced and conditioned at a fixed rate based on the maximum design. Since the building occupancy fluctuates and is often less than the maximum design occupancy, it is being over-ventilated and consuming more energy than necessary. The building CO2 level is closely related to the occupancy. The typical outside CO2 level is relatively low concentration, around 400 to 500 ppm, and is used to dilute the higher indoor CO2 levels.&#xd;Demand controlled ventilation could be implemented by deploying CO2 sensors located in each AHU return air duct and in densely occupied spaces, such as conference rooms. Implementation of this ECM will require:&#xd;-Rebalance the open/closed outside air dampers to a lower minimum ventilation rate.&#xd;-Program demand ventilation controls into each AHU, controlling modulating dampers in mixed air AHUs and VFDs in outside air units. Ventilation will be generally controlled from return air sensors, but will be increased as needed based on densely occupied space sensors.&#xd;-Commission the project.</description>
-  <modeler_description>This measure enable demand controlled ventilation on all or a single air loops in the building. The measure will loop through the selected systems, go into the "control" tab for the air system and toggles the "Demand Controlled Ventilation" button to the "on" position.&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;
-If the HVAC system does not have an air side system, or if the "Demand Controlled Ventilation" button is already in the "on" position, then the runner sends an info message to the user that the model was not changed.&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;
-The cost arguments are user arguments that start with a default of $0.</modeler_description>
-  <arguments>
-    <argument>
-      <name>dcv_type</name>
-      <display_name>DCV Type</display_name>
-      <type>Choice</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <choices>
-        <choice>
-          <value>EnableDCV</value>
-          <display_name>EnableDCV</display_name>
-        </choice>
-        <choice>
-          <value>DisableDCV</value>
-          <display_name>DisableDCV</display_name>
-        </choice>
-        <choice>
-          <value>NoChange</value>
-          <display_name>NoChange</display_name>
-        </choice>
-      </choices>
-    </argument>
-  </arguments>
-  <outputs/>
-  <provenances/>
-  <tags>
-    <tag>HVAC.Ventilation</tag>
-  </tags>
-  <attributes>
-    <attribute>
-      <name>Measure Type</name>
-      <value>ModelMeasure</value>
-      <datatype>string</datatype>
-    </attribute>
-    <attribute>
-      <name>Uses SketchUp API</name>
-      <value>false</value>
-      <datatype>boolean</datatype>
-    </attribute>
-  </attributes>
-  <files>
-    <file>
-      <filename>0320_ModelWithHVAC_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>049F3417</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>F6CB5CF3</checksum>
-    </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>2.0.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>EE5A157C</checksum>
-    </file>
-    <file>
-      <filename>EnableDemandControlledVentilation_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>913FEC40</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
-    </file>
-  </files>
-</measure>

data/lib/measures/EnableEconomizerControl/LICENSE.md

@@ -1,27 +0,0 @@
-OpenStudio(R), Copyright (c) 2008-2020, 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 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.

data/lib/measures/EnableEconomizerControl/README.md

@@ -1,48 +0,0 @@
-
-
-###### (Automatically generated documentation)
-
-# Enable Economizer Control
-
-## Description
-
-
-## Modeler Description
-
-
-## Measure Type
-ModelMeasure
-
-## Taxonomy
-
-
-## Arguments
-
-
-### Economizer Control Type
-
-**Name:** economizer_type,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Economizer Maximum Limit Dry-Bulb Temperature (F).
-
-**Name:** econoMaxDryBulbTemp,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Economizer Minimum Limit Dry-Bulb Temperature (F).
-
-**Name:** econoMinDryBulbTemp,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-
-
-

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

@@ -1,42 +0,0 @@
-<%#= 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 %>
-###### (Automatically generated documentation)
-
-# <%= 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] %>
-<% 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/EnableEconomizerControl/measure.rb

@@ -1,172 +0,0 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, 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.
-# *******************************************************************************
-
-# start the measure
-class EnableEconomizerControl < OpenStudio::Measure::ModelMeasure
-  # define the name that a user will see, this method may be deprecated as
-  # the display name in PAT comes from the name field in measure.xml
-  def name
-    return 'Enable Economizer Control'
-  end
-
-  # define the arguments that the user will input
-  def arguments(model)
-    args = OpenStudio::Measure::OSArgumentVector.new
-
-    # make choice argument economizer control type
-    choices = OpenStudio::StringVector.new
-    choices << 'FixedDryBulb'
-    choices << 'NoEconomizer'
-    choices << 'NoChange'
-    economizer_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('economizer_type', choices, true)
-    economizer_type.setDisplayName('Economizer Control Type')
-    args << economizer_type
-
-    # make an argument for econoMaxDryBulbTemp
-    econoMaxDryBulbTemp = OpenStudio::Measure::OSArgument.makeDoubleArgument('econoMaxDryBulbTemp', true)
-    econoMaxDryBulbTemp.setDisplayName('Economizer Maximum Limit Dry-Bulb Temperature (F).')
-    econoMaxDryBulbTemp.setDefaultValue(69.0)
-    args << econoMaxDryBulbTemp
-
-    # make an argument for econoMinDryBulbTemp
-    econoMinDryBulbTemp = OpenStudio::Measure::OSArgument.makeDoubleArgument('econoMinDryBulbTemp', true)
-    econoMinDryBulbTemp.setDisplayName('Economizer Minimum Limit Dry-Bulb Temperature (F).')
-    econoMinDryBulbTemp.setDefaultValue(-148.0)
-    args << econoMinDryBulbTemp
-
-    return args
-  end
-
-  # define what happens when the measure is cop
-  def run(model, runner, user_arguments)
-    super(model, runner, user_arguments)
-
-    # use the built-in error checking
-    if !runner.validateUserArguments(arguments(model), user_arguments)
-      return false
-    end
-
-    # assign the user inputs to variables
-    economizer_type = runner.getStringArgumentValue('economizer_type', user_arguments)
-    econoMaxDryBulbTemp = runner.getDoubleArgumentValue('econoMaxDryBulbTemp', user_arguments)
-    econoMinDryBulbTemp = runner.getDoubleArgumentValue('econoMinDryBulbTemp', user_arguments)
-
-    # Note if economizer_type == NoChange
-    # and register as N/A
-    if economizer_type == 'NoChange'
-      runner.registerAsNotApplicable('N/A - User requested No Change in economizer operation.')
-      return true
-    end
-
-    # short def to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001). The definition be called through this measure
-    def neat_numbers(number, roundto = 2) # round to 0 or 2)
-      if roundto == 2
-        number = format '%.2f', number
-      else
-        number = number.round
-      end
-      # regex to add commas
-      number.to_s.reverse.gsub(/([0-9]{3}(?=([0-9])))/, '\\1,').reverse
-    end
-
-    # info for initial condition
-    air_loops_changed = []
-    loops_with_outdoor_air = false
-
-    # loop through air loops
-    model.getAirLoopHVACs.each do |air_loop|
-      # find AirLoopHVACOutdoorAirSystem on loop
-      air_loop.supplyComponents.each do |supply_component|
-        hVACComponent = supply_component.to_AirLoopHVACOutdoorAirSystem
-        if hVACComponent.is_initialized
-          hVACComponent = hVACComponent.get
-
-          # set flag that at least one air loop has outdoor air objects
-          loops_with_outdoor_air = true
-
-          # get ControllerOutdoorAir
-          controller_oa = hVACComponent.getControllerOutdoorAir
-
-          # get ControllerMechanicalVentilation
-          controller_mv = controller_oa.controllerMechanicalVentilation # not using this
-
-          if controller_oa.getEconomizerControlType == economizer_type
-            # report info about air loop
-            runner.registerInfo("#{air_loop.name} already has the requested economizer type of #{economizer_type}.")
-          else
-            # store starting economizer type
-            starting_econo_control_type = controller_oa.getEconomizerControlType
-
-            # set economizer to the requested control type
-            controller_oa.setEconomizerControlType(economizer_type)
-
-            # report info about air loop
-            runner.registerInfo("Changing Economizer Control Type on #{air_loop.name} from #{starting_econo_control_type} to #{controller_oa.getEconomizerControlType} and adjusting temperature and enthalpy limits per measure arguments.")
-
-            air_loops_changed << air_loop
-
-          end
-
-          # set maximum limit drybulb temperature
-          controller_oa.setEconomizerMaximumLimitDryBulbTemperature(OpenStudio.convert(econoMaxDryBulbTemp, 'F', 'C').get)
-
-          # set minimum limit drybulb temperature
-          controller_oa.setEconomizerMinimumLimitDryBulbTemperature(OpenStudio.convert(econoMinDryBulbTemp, 'F', 'C').get)
-
-        end
-      end
-    end
-
-    # Report N/A if none of the air loops had OA systems
-    if loops_with_outdoor_air == false
-      runner.registerAsNotApplicable('The affected loop(s) do not have any outdoor air objects.')
-      return true
-    end
-
-    # Report N/A if none of the air loops were changed
-    if air_loops_changed.empty?
-      runner.registerAsNotApplicable('No air loops had economizers added or removed.')
-      return true
-    end
-
-    # Report the final condition of model
-    runner.registerFinalCondition("#{air_loops_changed.size} air loops now have economizers.")
-
-    return true
-  end
-end
-
-# this allows the measure to be used by the application
-EnableEconomizerControl.new.registerWithApplication

data/lib/measures/EnableEconomizerControl/measure.xml

@@ -1,124 +0,0 @@
-<measure>
-  <schema_version>3.0</schema_version>
-  <name>enable_economizer_control</name>
-  <uid>f8cc920d-8ae3-411a-922f-e6fed3223c4d</uid>
-  <version_id>d45560a8-abbf-4fa3-bf5f-ff0e93faaeaa</version_id>
-  <version_modified>20200229T024317Z</version_modified>
-  <xml_checksum>ECE70A70</xml_checksum>
-  <class_name>EnableEconomizerControl</class_name>
-  <display_name>Enable Economizer Control</display_name>
-  <description>There is currently not a functioning air side economizer enabled in the building. Air side economizers use cold outside air to either assist the mechanical cooling system, or if the air is cold enough, provide all of the cooling for a facility.&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;
-In order for an air side economizer to function properly, all of the outside air damper actuators need to have modulating capabilities. In addition to that, new control sequences need to be written into the building automation control system to enable the air-side economizer when outside air temperatures are below 60?F-65?F and the interior space temperatures are calling for cooling.&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;
-The building would realize the following operational benefits by utilizing an air-side economizer:&#xd;&#xd;&#xd;&#xd;&#xd;
-    -Reduction in cooling system energy use&#xd;&#xd;&#xd;&#xd;&#xd;
-    -Reduction in mechanical cooling system run time&#xd;&#xd;&#xd;&#xd;&#xd;
-    -Possible improvement in indoor air quality&#xd;&#xd;&#xd;&#xd;&#xd;
-  </description>
-  <modeler_description>This measure will enable economizer control for one or all of the air loops in the building. The choice list will have the following choices: No Economizer, Fixed Dry Bulb, Fixed Enthalpy, Differential Dry Bulb, Differential Enthalpy, Fixed Dew Point and Dry Bulb, Differential Dew Point and Dry Bulb, and Electronic Enthalpy. The default choice for each system will be the initial system condition. The measure will also have optional user argument fields for Economizer Maximum Limit Dry-Bulb Temperature, Economizer Maximum Limit Enthalpy, Economizer Maximum Limit Dewpoint Temperature, Economizer Minimum Limit Dry-Bulb Temperature. These user arguments get applied to every system in the project.&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;
-If the HVAC system does not have an OS:AirLoopHVAC:OutdoorAirSystem, then the runner sends an info message to the user that the model was not changed.&#xd;&#xd;&#xd;&#xd;&#xd;
-&#xd;&#xd;&#xd;&#xd;&#xd;
-The cost arguments are user arguments that start with a default of $0.&#xd;&#xd;&#xd;&#xd;&#xd;
-  </modeler_description>
-  <arguments>
-    <argument>
-      <name>economizer_type</name>
-      <display_name>Economizer Control Type</display_name>
-      <type>Choice</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <choices>
-        <choice>
-          <value>FixedDryBulb</value>
-          <display_name>FixedDryBulb</display_name>
-        </choice>
-        <choice>
-          <value>NoEconomizer</value>
-          <display_name>NoEconomizer</display_name>
-        </choice>
-        <choice>
-          <value>NoChange</value>
-          <display_name>NoChange</display_name>
-        </choice>
-      </choices>
-    </argument>
-    <argument>
-      <name>econoMaxDryBulbTemp</name>
-      <display_name>Economizer Maximum Limit Dry-Bulb Temperature (F).</display_name>
-      <type>Double</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>69</default_value>
-    </argument>
-    <argument>
-      <name>econoMinDryBulbTemp</name>
-      <display_name>Economizer Minimum Limit Dry-Bulb Temperature (F).</display_name>
-      <type>Double</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>-148</default_value>
-    </argument>
-  </arguments>
-  <outputs/>
-  <provenances/>
-  <tags>
-    <tag>HVAC.Ventilation</tag>
-  </tags>
-  <attributes>
-    <attribute>
-      <name>Measure Type</name>
-      <value>ModelMeasure</value>
-      <datatype>string</datatype>
-    </attribute>
-    <attribute>
-      <name>Uses SketchUp API</name>
-      <value>false</value>
-      <datatype>boolean</datatype>
-    </attribute>
-  </attributes>
-  <files>
-    <file>
-      <filename>0320_ModelWithHVAC_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>4A5352A1</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>CF61C43C</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
-    </file>
-    <file>
-      <filename>measure_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>A2090624</checksum>
-    </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>2.0.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>605C310C</checksum>
-    </file>
-  </files>
-</measure>