openstudio-analysis 1.0.1 → 1.0.6

data/spec/files/measures/ActualMeasureNoJson/measure.rb

@@ -1,80 +0,0 @@
-#start the measure
-class RotateBuilding < OpenStudio::Ruleset::ModelUserScript
-
-  #define the name that a user will see
-  def name
-    return "Rotate Building"
-  end
-
-  #define the arguments that the user will input
-  def arguments(model)
-    args = OpenStudio::Ruleset::OSArgumentVector.new
-
-    #make an argument for your name
-    relative_building_rotation = OpenStudio::Ruleset::OSArgument::makeDoubleArgument("relative_building_rotation",true)
-    relative_building_rotation.setDisplayName("Number of Degrees to Rotate Building (positive value is clockwise).")
-    relative_building_rotation.setDefaultValue(90.0)
-    args << relative_building_rotation
-
-    return args
-  end #end the arguments method
-
-  #define what happens when the measure is run
-  def run(model, runner, user_arguments)
-    super(model, runner, user_arguments)
-
-    #use the built-in error checking
-    if not runner.validateUserArguments(arguments(model), user_arguments)
-      return false
-    end
-
-    #assign the user inputs to variables
-    relative_building_rotation = runner.getDoubleArgumentValue("relative_building_rotation",user_arguments)
-
-    #check the relative_building_rotation for reasonableness
-    if relative_building_rotation > 360 or relative_building_rotation < -360
-      relative_building_rotation = relative_building_rotation -360.0*(relative_building_rotation/360.0).truncate
-      runner.registerWarning("Requested rotation was not between -360 and 360. Effective relative rotation is #{relative_building_rotation} degrees.")
-    end
-
-    #reporting initial condition of model
-    building = model.getBuilding
-    runner.registerValue("orientation_initial",building.northAxis)
-    runner.registerInitialCondition("The building's initial rotation was #{building.northAxis} degrees.")
-
-    #report as not applicable if effective relative rotation is 0
-    if relative_building_rotation == 0
-      runner.registerAsNotApplicable("The requested rotation was 0 degrees. The model was not altered.")
-    else
-      #rotate the building
-      final_building_angle = building.setNorthAxis(building.northAxis + relative_building_rotation)
-      runner.registerInfo("The building has been rotated by #{relative_building_rotation} degrees.")
-    end
-
-    #check for site shading
-    model_contains_site_shading = false
-    shading_surface_groups = model.getShadingSurfaceGroups
-    shading_surface_groups.each do |shading_surface_group|
-      if shading_surface_group.shadingSurfaceType == "Site"
-        model_contains_site_shading = true
-      end
-    end
-
-    #issue warning if site shading surfaces exist
-    if model_contains_site_shading
-      runner.registerWarning("The model contains one or more site shading groups. They were not rotated with the building.")
-    end
-
-    #reporting final condition of model
-    runner.registerValue("orientation_final",building.northAxis)
-    runner.registerFinalCondition("The building's final rotation is #{building.northAxis} degrees.")
-
-    return true
-
-  end #end the run method
-
-
-end #end the measure
-
-#this allows the measure to be used by the application
-RotateBuilding.new.registerWithApplication

data/spec/files/measures/ActualMeasureNoJson/measure.xml

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<measure xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://bcl.nrel.gov/xsd/measures/version/1.0.xsd"><name>Rotate Building Relative to Current Orientation</name><uid>a5be6c96-4ecc-47fa-8d32-f4216ebc2e7d</uid><version_id>aeb20d61-b773-4d20-a2ef-fe948cdc2858</version_id><description>Rotate your building relative to its current orientation. This will not rotate site shading objects.</description><modeler_description>Get the North Axis field for the  OS:Building object and adjusted it based on the user specified value. If the starting value is 20 degrees and the user value is 5 degrees, then the resulting value is 25 degrees.</modeler_description><tags><tag>Envelope.Form</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>RotateBuilding_TestModel_01.osm</filename><filetype>osm</filetype><usage_type>test</usage_type><checksum>E5C7E0B6</checksum></file><file><filename>RotateBuilding_Test.rb</filename><filetype>rb</filetype><usage_type>test</usage_type><checksum>D9410036</checksum></file><file><version><software_program>OpenStudio</software_program><identifier>1.3.0</identifier></version><filename>measure.rb</filename><filetype>rb</filetype><usage_type>script</usage_type><checksum>FEC15373</checksum></file></files></measure>

data/spec/files/measures/ExampleMeasure/measure.json

@@ -1,3 +0,0 @@
-{
-    "name": "Not a real JSON file"
-}

data/spec/files/measures/ExampleMeasure/measure.rb

@@ -1,5 +0,0 @@
-class ExampleMeasure < OpenStudio::Ruleset::ModelUserScript
-  # not a real measure
-end # end the measure
-
-IncreaseInsulationRValueForRoofs.new.registerWithApplication

data/spec/files/measures/ExampleMeasure/measure.xml

@@ -1 +0,0 @@
-<name>Not a real XML file</name>

data/spec/files/measures/IncreaseInsulationRValueForRoofs/measure.json

@@ -1,36 +0,0 @@
-{
-  "classname": "IncreaseInsulationRValueForRoofs",
-  "path": "./measures/IncreaseInsulationRValueForRoofs",
-  "name": "Set R-value of Insulation for Roofs to a Specific Value",
-  "measure_type": "RubyMeasure",
-  "arguments": [
-    {
-      "local_variable": "r_value",
-      "variable_type": "Double",
-      "name": "r_value",
-      "display_name": "Insulation R-value (ft^2*h*R/Btu).",
-      "default_value": 30.0
-    },
-    {
-      "local_variable": "material_cost_increase_ip",
-      "variable_type": "Double",
-      "name": "material_cost_increase_ip",
-      "display_name": "Increase in Material and Installation Costs for Construction per Area Used ($/ft^2).",
-      "default_value": 0.0
-    },
-    {
-      "local_variable": "one_time_retrofit_cost_ip",
-      "variable_type": "Double",
-      "name": "one_time_retrofit_cost_ip",
-      "display_name": "One Time Retrofit Cost to Add Insulation to Construction ($/ft^2).",
-      "default_value": 0.0
-    },
-    {
-      "local_variable": "years_until_retrofit_cost",
-      "variable_type": "Integer",
-      "name": "years_until_retrofit_cost",
-      "display_name": "Year to Incur One Time Retrofit Cost (whole years).",
-      "default_value": 0
-    }
-  ]
-}

data/spec/files/measures/IncreaseInsulationRValueForRoofs/measure.rb

@@ -1,22 +0,0 @@
-# start the measure
-class IncreaseInsulationRValueForRoofs < OpenStudio::Ruleset::ModelUserScript
-  # define the name that a user will see
-  def name
-    'Increase R-value of Insulation for Roofs to a Specific Value'
-  end
-
-  # define the arguments that the user will input
-  def arguments(_model)
-    args = OpenStudio::Ruleset::OSArgumentVector.new
-  end # end the arguments method
-
-  # define what happens when the measure is run
-  def run(model, runner, user_arguments)
-    super(model, runner, user_arguments)
-
-    true
-  end # end the run method
-end # end the measure
-
-# this allows the measure to be used by the application
-IncreaseInsulationRValueForRoofs.new.registerWithApplication

data/spec/files/measures/IncreaseInsulationRValueForRoofs/measure.xml

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<measure xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://bcl.nrel.gov/xsd/measures/version/1.0.xsd"><name>Set R-value of Insulation for Roofs to a Specific Value</name><uid>c6b78646-be8e-425b-af79-fdbbcd0d58d5</uid><version_id>8c8bd127-d07b-4ae3-ab5f-c15af5dedef2</version_id><description>Set the R-Value of roof insulation to a specified value.  Higher R-Values provide better insulation, lowering heat loss and heat gain through the roof.</description><modeler_description>Set the R-Value (ft^2*h*R/Btu) of the insulation material layer in all roofs in the model to a specified value.  Find constructions used for roofs, make copies of these and assign them to the appropriate construction sets or surfaces. Identify which layer of the construction is the insulation layer. This could be a Material, No Mass Material, or Air Gap Material. If the Insulation layer is &quot;Material? the thickness will be changed to attain the desired R-Value. If the insulation layer is &quot;No Mass Material? or &quot;Air Gap Material? the Thermal Resistance will be directly entered.  If the construction doesn't appear to have an insulation layer, it will not be altered. Surfaces with &quot;Adiabatic&quot; boundary conditions are not specifically assumed to be interior or exterior. As a result constructions used on &quot;Adiabatic&quot; surfaces will not be altered. Constructions used on attic floors will not be altered.&#13;&#13;&#13;&#13;&#13;&#13;
-&#13;&#13;&#13;&#13;&#13;&#13;
-The resulting construction will retain the cost data from the source construction, however material and installation cost can be increased which will affect replacement cost if it happens during the analysis period. Additionally a one-time cost can be added to reflect any retrofit costs that occur at some point prior to replacement.&#13;&#13;&#13;&#13;&#13;&#13;
-  </modeler_description><tags><tag>Envelope.Opaque</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>EnvelopeAndLoadTestModel_01.osm</filename><filetype>osm</filetype><usage_type>test</usage_type><checksum>938A1BB0</checksum></file><file><filename>ReverseTranslatedModel.osm</filename><filetype>osm</filetype><usage_type>test</usage_type><checksum>20C95654</checksum></file><file><filename>IncreaseInsulationRValueForRoofs_Test.rb</filename><filetype>rb</filetype><usage_type>test</usage_type><checksum>FA410C73</checksum></file><file><version><software_program>OpenStudio</software_program><identifier>0.11.5</identifier></version><filename>measure.rb</filename><filetype>rb</filetype><usage_type>script</usage_type><checksum>E720BF68</checksum></file></files></measure>

data/spec/files/measures/ReduceLightingLoadsByPercentage/measure.json

@@ -1,3 +0,0 @@
-{
-    "name": "Not a real JSON file"
-}

data/spec/files/measures/ReduceLightingLoadsByPercentage/measure.rb

@@ -1,5 +0,0 @@
-class ExampleMeasure < OpenStudio::Ruleset::ModelUserScript
-  # not a real measure
-end # end the measure
-
-IncreaseInsulationRValueForRoofs.new.registerWithApplication

data/spec/files/measures/ReduceLightingLoadsByPercentage/measure.xml

@@ -1 +0,0 @@
-<name>Not a real XML file</name>

data/spec/files/measures/SetThermostatSchedules/measure.json

@@ -1,63 +0,0 @@
-{
-  "classname": "SetThermostatSchedules",
-  "name": "set_thermostat_schedules",
-  "display_name": "Set Thermostat Schedules",
-  "measure_type": "RubyMeasure",
-  "arguments": [
-    {
-      "local_variable": "zones",
-      "variable_type": "Choice",
-      "name": "zones",
-      "display_name": "Choose Thermal Zones to change thermostat schedules on",
-      "units": null,
-      "description": null,
-      "default_value": "*All Thermal Zones*",
-      "choices": [
-        "*All Thermal Zones*"
-      ]
-    },
-    {
-      "local_variable": "cooling_sch",
-      "variable_type": "Choice",
-      "name": "cooling_sch",
-      "display_name": "Choose Cooling Schedule",
-      "units": null,
-      "description": null,
-      "default_value": "*No Change*",
-      "choices": [
-        "",
-        "*No Change*"
-      ]
-    },
-    {
-      "local_variable": "heating_sch",
-      "variable_type": "Choice",
-      "name": "heating_sch",
-      "display_name": "Choose Heating Schedule",
-      "units": null,
-      "description": null,
-      "default_value": "*No Change*",
-      "choices": [
-        "",
-        "*No Change*"
-      ]
-    },
-    {
-      "local_variable": "material_cost",
-      "variable_type": "Double",
-      "name": "material_cost",
-      "display_name": "Material and Installation Costs per Thermal Zone",
-      "units": "$/thermal zone",
-      "description": null,
-      "default_value": 0.0
-    }
-  ],
-  "name_xml": "Set Thermostat Schedules",
-  "uid": "d241d623-d596-4b26-9b67-fe390be1e839",
-  "version_id": "699b90d0-1b73-4208-869a-c6987afda0da",
-  "modeler_description": "Sets zone thermostat schedules to schedules in the same file. If a zone does not have a thermostat this measure will add one.",
-  "description": "Sets zone thermostat schedules to schedules in the same file. If a zone does not have a thermostat this measure will add one",
-  "tags": [
-    "HVAC.HVAC Controls"
-  ]
-}

data/spec/files/measures/SetThermostatSchedules/measure.rb

@@ -1,254 +0,0 @@
-#see the URL below for information on how to write OpenStuido measures
-# http://openstudio.nrel.gov/openstudio-measure-writing-guide
-
-#start the measure
-class SetThermostatSchedules < OpenStudio::Ruleset::ModelUserScript
-  
-  #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 "Set Thermostat Schedules"
-  end
-  
-  #define the arguments that the user will input
-  def arguments(model)
-    args = OpenStudio::Ruleset::OSArgumentVector.new
-    
-    #populate choice argument for thermal zones in the model
-    zone_handles = OpenStudio::StringVector.new
-    zone_display_names = OpenStudio::StringVector.new
-
-    #putting zone names into hash
-    zone_hash = {}
-    model.getThermalZones.each do |zone|
-      zone_hash[zone.name.to_s] = zone
-    end
-
-    #looping through sorted hash of zones
-    zone_hash.sort.map do |zone_name, zone|
-      if zone.thermostatSetpointDualSetpoint.is_initialized
-        zone_handles << zone.handle.to_s
-        zone_display_names << zone_name
-      end
-    end
-
-    #add building to string vector with zones
-    building = model.getBuilding
-    zone_handles << building.handle.to_s
-    zone_display_names << "*All Thermal Zones*"
-    
-    #make an argument for zones
-    zones = OpenStudio::Ruleset::OSArgument::makeChoiceArgument("zones", zone_handles, zone_display_names, true)
-    zones.setDisplayName("Choose Thermal Zones to change thermostat schedules on.")
-    zones.setDefaultValue("*All Thermal Zones*") #if no zone is chosen this will run on all zones
-    args << zones
-
-    #populate choice argument for schedules in the model
-    sch_handles = OpenStudio::StringVector.new
-    sch_display_names = OpenStudio::StringVector.new
-
-    #putting schedule names into hash
-    sch_hash = {}
-    model.getSchedules.each do |sch|
-      sch_hash[sch.name.to_s] = sch
-    end
-
-    #looping through sorted hash of schedules
-    sch_hash.sort.map do |sch_name, sch|
-      if not sch.scheduleTypeLimits.empty?
-        unitType = sch.scheduleTypeLimits.get.unitType
-        #puts "#{sch.name}, #{unitType}"
-        if unitType == "Temperature"
-          sch_handles << sch.handle.to_s
-          sch_display_names << sch_name
-        end
-      end
-    end
-
-    #add empty handle to string vector with schedules
-    sch_handles << OpenStudio::toUUID("").to_s
-    sch_display_names << "*No Change*"
-    
-    #make an argument for cooling schedule
-    cooling_sch = OpenStudio::Ruleset::OSArgument::makeChoiceArgument("cooling_sch", sch_handles, sch_display_names, true)
-    cooling_sch.setDisplayName("Choose Cooling Schedule.")
-    cooling_sch.setDefaultValue("*No Change*") #if no change is chosen then cooling schedules will not be changed
-    args << cooling_sch    
-
-    #make an argument for heating schedule
-    heating_sch = OpenStudio::Ruleset::OSArgument::makeChoiceArgument("heating_sch", sch_handles, sch_display_names, true)
-    heating_sch.setDisplayName("Choose Heating Schedule.")
-    heating_sch.setDefaultValue("*No Change*") #if no change is chosen then heating schedules will not be changed
-    args << heating_sch
-    
-    #make an argument for material and installation cost
-    material_cost = OpenStudio::Ruleset::OSArgument::makeDoubleArgument("material_cost",true)
-    material_cost.setDisplayName("Material and Installation Costs per Thermal Zone ($/thermal zone).")
-    material_cost.setDefaultValue(0.0)
-    args << material_cost
-    
-    return args
-  end #end the arguments method
-
-  #define what happens when the measure is run
-  def run(model, runner, user_arguments)
-    super(model, runner, user_arguments)
-    
-    #use the built-in error checking 
-    if not runner.validateUserArguments(arguments(model), user_arguments)
-      return false
-    end
-
-    #assign the user inputs to variables
-    zones = runner.getOptionalWorkspaceObjectChoiceValue("zones",user_arguments,model) #model is passed in because of argument type
-    cooling_sch = runner.getOptionalWorkspaceObjectChoiceValue("cooling_sch",user_arguments,model) #model is passed in because of argument type
-    heating_sch = runner.getOptionalWorkspaceObjectChoiceValue("heating_sch",user_arguments,model) #model is passed in because of argument type
-    material_cost = runner.getDoubleArgumentValue("material_cost",user_arguments)
-    
-    #check the zone selection for reasonableness
-    apply_to_all_zones = false
-    selected_zone = nil
-    if zones.empty?
-      handle = runner.getStringArgumentValue("zones",user_arguments)
-      if handle.empty?
-        runner.registerError("No thermal zone was chosen.")
-        return false
-      else
-        runner.registerError("The selected thermal zone with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
-        return false
-      end
-    else
-      if not zones.get.to_ThermalZone.empty?
-        selected_zone = zones.get.to_ThermalZone.get
-      elsif not zones.get.to_Building.empty?
-        apply_to_all_zones = true
-      else
-        runner.registerError("Script Error - argument not showing up as thermal zone.")
-        return false
-      end
-    end  #end of if zones.empty?
-    
-    #depending on user input, add selected zones to an array
-    selected_zones = [] 
-    if apply_to_all_zones == true
-      selected_zones = model.getThermalZones
-    else
-      selected_zones << selected_zone
-    end
-
-    #check the cooling_sch for reasonableness
-    if cooling_sch.empty?
-      handle = runner.getStringArgumentValue("cooling_sch",user_arguments)
-      if handle == OpenStudio::toUUID("").to_s
-        # no change
-        cooling_sch = nil
-      else
-        runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
-        return false
-      end
-    else
-      if not cooling_sch.get.to_Schedule.empty?
-        cooling_sch = cooling_sch.get.to_Schedule.get
-      else
-        runner.registerError("Script Error - argument not showing up as schedule.")
-        return false
-      end
-    end  #end of if cooling_sch.empty?
-
-    #check the heating_sch for reasonableness
-    if heating_sch.empty?
-      handle = runner.getStringArgumentValue("heating_sch",user_arguments)
-      if handle == OpenStudio::toUUID("").to_s
-        # no change
-        heating_sch = nil
-      else
-        runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
-        return false
-      end
-    else
-      if not heating_sch.get.to_Schedule.empty?
-        heating_sch = heating_sch.get.to_Schedule.get
-      else
-        runner.registerError("Script Error - argument not showing up as schedule.")
-        return false
-      end
-    end  #end of if heating_sch.empty?
-      
-    number_zones_modified = 0
-    total_cost = 0
-    if heating_sch or cooling_sch
-    
-      selected_zones.each do |zone|
-        
-        thermostatSetpointDualSetpoint = zone.thermostatSetpointDualSetpoint
-        if thermostatSetpointDualSetpoint.empty?
-          runner.registerInfo("Creating thermostat for thermal zone '#{zone.name}'.")
-          
-          thermostatSetpointDualSetpoint = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
-          zone.setThermostatSetpointDualSetpoint(thermostatSetpointDualSetpoint)
-        else
-          thermostatSetpointDualSetpoint = thermostatSetpointDualSetpoint.get
-          
-          # make sure this thermostat is unique to this zone
-          if thermostatSetpointDualSetpoint.getSources("OS_ThermalZone".to_IddObjectType).size > 1
-            # if not create a new copy
-            runner.registerInfo("Copying thermostat for thermal zone '#{zone.name}'.")
-            
-            oldThermostat = thermostatSetpointDualSetpoint
-            thermostatSetpointDualSetpoint = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
-            if not oldThermostat.heatingSetpointTemperatureSchedule.empty?
-              thermostatSetpointDualSetpoint.setHeatingSetpointTemperatureSchedule(oldThermostat.heatingSetpointTemperatureSchedule.get)
-            end
-            if not oldThermostat.coolingSetpointTemperatureSchedule.empty?
-              thermostatSetpointDualSetpoint.setCoolingSetpointTemperatureSchedule(oldThermostat.coolingSetpointTemperatureSchedule.get)
-            end
-            zone.setThermostatSetpointDualSetpoint(thermostatSetpointDualSetpoint)
-          end
-        end
-        
-        if heating_sch
-          if not thermostatSetpointDualSetpoint.setHeatingSetpointTemperatureSchedule(heating_sch)
-            runner.registerError("Script Error - cannot set heating schedule for thermal zone '#{zone.name}'.")
-            return false
-          end
-        end
-        
-        if cooling_sch
-          if not thermostatSetpointDualSetpoint.setCoolingSetpointTemperatureSchedule(cooling_sch)
-            runner.registerError("Script Error - cannot set cooling schedule for thermal zone '#{zone.name}'.")
-            return false
-          end
-        end
-        
-        if material_cost.abs != 0
-          total_cost += material_cost
-          OpenStudio::Model::LifeCycleCost::createLifeCycleCost("LCC_Mat - #{zone.name} Thermostats", zone, material_cost, "CostPerEach", "Construction")
-        end
-        
-        number_zones_modified += 1
-      end
-    end
-    
-    runner.registerFinalCondition("Replaced thermostats for #{number_zones_modified} thermal zones, capital cost #{total_cost}")                   
-
-    if number_zones_modified == 0
-      runner.registerAsNotApplicable("No thermostats altered")
-    end
-    
-    return true
- 
-  end #end the run method
-
-end #end the measure
-
-#this allows the measure to be use by the application
-SetThermostatSchedules.new.registerWithApplication
-
-
-
-
-
-
-
-
-