openstudio-common-measures 0.3.0 → 0.3.1

data/lib/measures/AddDaylightSensors/measure.xml

@@ -1,233 +0,0 @@
-<measure>
-  <schema_version>3.0</schema_version>
-  <name>add_daylight_sensors</name>
-  <uid>62babdc7-c81e-4dfd-96e8-af1628a55167</uid>
-  <version_id>5c889c90-31e5-40e9-835e-bb3230ad6fb8</version_id>
-  <version_modified>20200229T024319Z</version_modified>
-  <xml_checksum>0AC58119</xml_checksum>
-  <class_name>AddDaylightSensors</class_name>
-  <display_name>Add Daylight Sensor at the Center of Spaces with a Specified Space Type Assigned</display_name>
-  <description>This measure will add daylighting controls to spaces that that have space types assigned with names containing the string in the argument. You can also add a cost per space for sensors added to the model.</description>
-  <modeler_description>Make an array of the spaces that meet the criteria. Locate the sensor x and y values by averaging the min and max X and Y values from floor surfaces in the space. If a space already has a daylighting control, do not add a new one and leave the original in place. Warn the user if the space isn't assigned to a thermal zone, or if the space doesn't have any translucent surfaces. Note that the cost is added to the space not the sensor. If the sensor is removed at a later date, the cost will remain.</modeler_description>
-  <arguments>
-    <argument>
-      <name>space_type</name>
-      <display_name>Add Daylight Sensors to Spaces of This Space Type</display_name>
-      <type>Choice</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-    </argument>
-    <argument>
-      <name>setpoint</name>
-      <display_name>Daylighting Setpoint</display_name>
-      <type>Double</type>
-      <units>fc</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>45</default_value>
-    </argument>
-    <argument>
-      <name>control_type</name>
-      <display_name>Daylighting Control Type</display_name>
-      <type>Choice</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>Continuous/Off</default_value>
-      <choices>
-        <choice>
-          <value>None</value>
-          <display_name>None</display_name>
-        </choice>
-        <choice>
-          <value>Continuous</value>
-          <display_name>Continuous</display_name>
-        </choice>
-        <choice>
-          <value>Stepped</value>
-          <display_name>Stepped</display_name>
-        </choice>
-        <choice>
-          <value>Continuous/Off</value>
-          <display_name>Continuous/Off</display_name>
-        </choice>
-      </choices>
-    </argument>
-    <argument>
-      <name>min_power_fraction</name>
-      <display_name>Daylighting Minimum Input Power Fraction</display_name>
-      <description>min = 0 max = 0.6</description>
-      <type>Double</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>0.3</default_value>
-    </argument>
-    <argument>
-      <name>min_light_fraction</name>
-      <display_name>Daylighting Minimum Light Output Fraction</display_name>
-      <description>min = 0 max = 0.6</description>
-      <type>Double</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>0.2</default_value>
-    </argument>
-    <argument>
-      <name>fraction_zone_controlled</name>
-      <display_name>Fraction of zone controlled by daylight sensors</display_name>
-      <type>Double</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>1</default_value>
-    </argument>
-    <argument>
-      <name>height</name>
-      <display_name>Sensor Height</display_name>
-      <type>Double</type>
-      <units>inches</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>30</default_value>
-    </argument>
-    <argument>
-      <name>material_cost</name>
-      <display_name>Material and Installation Costs per Space for Daylight Sensor</display_name>
-      <type>Double</type>
-      <units>$</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>0</default_value>
-    </argument>
-    <argument>
-      <name>demolition_cost</name>
-      <display_name>Demolition Costs per Space for Daylight Sensor</display_name>
-      <type>Double</type>
-      <units>$</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>0</default_value>
-    </argument>
-    <argument>
-      <name>years_until_costs_start</name>
-      <display_name>Years Until Costs Start</display_name>
-      <type>Integer</type>
-      <units>whole years</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>0</default_value>
-    </argument>
-    <argument>
-      <name>demo_cost_initial_const</name>
-      <display_name>Demolition Costs Occur During Initial Construction</display_name>
-      <type>Boolean</type>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>false</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>
-    <argument>
-      <name>expected_life</name>
-      <display_name>Expected Life</display_name>
-      <type>Integer</type>
-      <units>whole years</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>20</default_value>
-    </argument>
-    <argument>
-      <name>om_cost</name>
-      <display_name>O &amp; M Costs per Space for Daylight Sensor</display_name>
-      <type>Double</type>
-      <units>$</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>0</default_value>
-    </argument>
-    <argument>
-      <name>om_frequency</name>
-      <display_name>O &amp; M Frequency</display_name>
-      <type>Integer</type>
-      <units>whole years</units>
-      <required>true</required>
-      <model_dependent>false</model_dependent>
-      <default_value>1</default_value>
-    </argument>
-  </arguments>
-  <outputs/>
-  <provenances/>
-  <tags>
-    <tag>Electric Lighting.Electric Lighting Controls</tag>
-  </tags>
-  <attributes>
-    <attribute>
-      <name>Measure Type</name>
-      <value>ModelMeasure</value>
-      <datatype>string</datatype>
-    </attribute>
-    <attribute>
-      <name>Measure Function</name>
-      <value>Measure</value>
-      <datatype>string</datatype>
-    </attribute>
-    <attribute>
-      <name>Requires EnergyPlus Results</name>
-      <value>false</value>
-      <datatype>boolean</datatype>
-    </attribute>
-    <attribute>
-      <name>Uses SketchUp API</name>
-      <value>false</value>
-      <datatype>boolean</datatype>
-    </attribute>
-  </attributes>
-  <files>
-    <file>
-      <filename>ModelForDaylightSensors.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>34D67AAA</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>F3117543</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</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>46FDF582</checksum>
-    </file>
-    <file>
-      <filename>AddDaylightSensors_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>5C6D0627</checksum>
-    </file>
-  </files>
-</measure>

data/lib/measures/EnableDemandControlledVentilation/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/EnableDemandControlledVentilation/README.md

@@ -1,32 +0,0 @@
-
-
-###### (Automatically generated documentation)
-
-# Enable Demand Controlled Ventilation
-
-## Description
-
-
-## Modeler Description
-
-
-## Measure Type
-ModelMeasure
-
-## Taxonomy
-
-
-## Arguments
-
-
-### DCV Type
-
-**Name:** dcv_type,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-
-
-

data/lib/measures/EnableDemandControlledVentilation/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/EnableDemandControlledVentilation/measure.rb

@@ -1,154 +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.
-# *******************************************************************************
-
-# see the URL below for information on how to write OpenStudio measures
-# http://openstudio.nrel.gov/openstudio-measure-writing-guide
-
-# see the URL below for information on using life cycle cost objects in OpenStudio
-# http://openstudio.nrel.gov/openstudio-life-cycle-examples
-
-# see the URL below for access to C++ documentation on model objects (click on "model" in the main window to view model objects)
-# http://openstudio.nrel.gov/sites/openstudio.nrel.gov/files/nv_data/cpp_documentation_it/model/html/namespaces.html
-
-# start the measure
-class EnableDemandControlledVentilation < 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 Demand Controlled Ventilation'
-  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 << 'EnableDCV'
-    choices << 'DisableDCV'
-    choices << 'NoChange'
-    dcv_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('dcv_type', choices, true)
-    dcv_type.setDisplayName('DCV Type')
-    args << dcv_type
-
-    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
-    dcv_type = runner.getStringArgumentValue('dcv_type', user_arguments)
-
-    # Note if dcv_type == NoChange
-    # and register as N/A
-    if dcv_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 = []
-
-    # 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.empty?
-          hVACComponent = hVACComponent.get
-
-          # get ControllerOutdoorAir
-          controller_oa = hVACComponent.getControllerOutdoorAir
-
-          # get ControllerMechanicalVentilation
-          controller_mv = controller_oa.controllerMechanicalVentilation
-
-          if dcv_type == 'EnableDCV'
-            # check if demand control is enabled, if not, then enable it
-            if controller_mv.demandControlledVentilation == true
-              runner.registerInfo("#{air_loop.name} already has DCV enabled.")
-            else
-              controller_mv.setDemandControlledVentilation(true)
-              runner.registerInfo("Enabling DCV for #{air_loop.name}.")
-              air_loops_changed << air_loop
-            end
-          elsif dcv_type == 'DisableDCV'
-            # check if demand control is disabled, if not, then disabled it
-            if controller_mv.demandControlledVentilation == false
-              runner.registerInfo("#{air_loop.name} already has DCV disabled.")
-            else
-              controller_mv.setDemandControlledVentilation(false)
-              runner.registerInfo("Disabling DCV for #{air_loop.name}.")
-              air_loops_changed << air_loop
-            end
-          end
-
-        end
-      end
-    end
-
-    # Report N/A if none of the air loops were changed
-    if air_loops_changed.empty?
-      runner.registerAsNotApplicable('No air loops had DCV enabled or disabled.')
-      return true
-    end
-
-    # Report final condition of model
-    runner.registerFinalCondition("#{air_loops_changed.size} air loops now have demand controlled ventilation enabled.")
-
-    return true
-  end
-end
-
-# this allows the measure to be use by the application
-EnableDemandControlledVentilation.new.registerWithApplication