urbanopt-cli 0.5.1 → 0.6.2

data/example_files/mappers/Floorspace.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # 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.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# 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 “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, 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.
+
 # 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.
@@ -28,7 +38,7 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 # *********************************************************************************
 
-require 'urbanopt/scenario'
+require 'urbanopt/reporting'
 require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
 require 'openstudio/ee_measures'

data/example_files/mappers/HighEfficiency.rb

@@ -1,21 +1,31 @@
-#*********************************************************************************
-# URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # 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.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# 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 “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, 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.
+
 # 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.
@@ -26,11 +36,13 @@
 # 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.
-#*********************************************************************************
+# *********************************************************************************
 
 require 'urbanopt/reporting'
 require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
+require 'openstudio/ee_measures'
+require 'openstudio/calibration'
 
 require_relative 'Baseline'
 

data/example_files/mappers/HighEfficiencyCreateBar.rb

@@ -1,22 +1,31 @@
-
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # 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.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# 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 “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, 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.
+
 # 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.
@@ -29,9 +38,11 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 # *********************************************************************************
 
-require 'urbanopt/scenario'
+require 'urbanopt/reporting'
 require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
+require 'openstudio/ee_measures'
+require 'openstudio/calibration'
 
 require_relative 'CreateBar'
 

data/example_files/mappers/HighEfficiencyFloorspace.rb

@@ -1,22 +1,31 @@
-
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # 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.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# 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 “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, 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.
+
 # 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.
@@ -29,9 +38,11 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 # *********************************************************************************
 
-require 'urbanopt/scenario'
+require 'urbanopt/reporting'
 require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
+require 'openstudio/ee_measures'
+require 'openstudio/calibration'
 
 require_relative 'Floorspace'
 

data/example_files/mappers/ThermalStorage.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
-#
+
 # Redistribution and use in source and binary forms, with or without modification,
 # are permitted provided that the following conditions are met:
-#
+
 # Redistributions of source code must retain the above copyright notice, this list
 # of conditions and the following disclaimer.
-#
+
 # 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.
-#
+
 # Neither the name of the copyright holder nor the names of its contributors may be
 # used to endorse or promote products derived from this software without specific
 # prior written permission.
-#
+
+# 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 “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, 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.
+
 # 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.

data/example_files/measures/BuildResidentialModel/measure.rb

@@ -2,15 +2,16 @@
 # http://nrel.github.io/OpenStudio-user-documentation/measures/measure_writing_guide/
 
 require 'openstudio'
-
-# require gem for merge measures
-# was able to harvest measure paths from primary osw for meta osw. Remove this once confirm that works
-#require 'openstudio-model-articulation'
-#require 'measures/merge_spaces_from_external_file/measure.rb'
-
-resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), 'resources'))
-meta_measure_file = File.join(resources_dir, 'meta_measure.rb')
-require File.join(File.dirname(meta_measure_file), File.basename(meta_measure_file, File.extname(meta_measure_file)))
+if File.exist? File.absolute_path(File.join(File.dirname(__FILE__), '../../lib/resources/hpxml-measures/HPXMLtoOpenStudio/resources')) # Hack to run ResStock on AWS
+  resources_path = File.absolute_path(File.join(File.dirname(__FILE__), '../../lib/resources/hpxml-measures/HPXMLtoOpenStudio/resources'))
+elsif File.exist? File.absolute_path(File.join(File.dirname(__FILE__), '../../resources/hpxml-measures/HPXMLtoOpenStudio/resources')) # Hack to run ResStock unit tests locally
+  resources_path = File.absolute_path(File.join(File.dirname(__FILE__), '../../resources/hpxml-measures/HPXMLtoOpenStudio/resources'))
+elsif File.exist? File.join(OpenStudio::BCLMeasure::userMeasuresDir.to_s, 'HPXMLtoOpenStudio/resources') # Hack to run measures in the OS App since applied measures are copied off into a temporary directory
+  resources_path = File.join(OpenStudio::BCLMeasure::userMeasuresDir.to_s, 'HPXMLtoOpenStudio/resources')
+else
+  resources_path = File.absolute_path(File.join(File.dirname(__FILE__), '../HPXMLtoOpenStudio/resources'))
+end
+require File.join(resources_path, 'meta_measure')
 
 # start the measure
 class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
@@ -31,12 +32,27 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
 
   # define the arguments that the user will input
   def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    arg = OpenStudio::Ruleset::OSArgument.makeIntegerArgument('feature_id', true)
+    arg.setDisplayName('Feature ID')
+    arg.setDescription('The feature ID passed from Baseline.rb.')
+    args << arg
+
+    schedules_variation_choices = OpenStudio::StringVector.new
+    schedules_variation_choices << 'building'
+    schedules_variation_choices << 'unit'
+
+    arg = OpenStudio::Ruleset::OSArgument.makeChoiceArgument('schedules_variation', schedules_variation_choices, true)
+    arg.setDisplayName('Schedules: Variation')
+    arg.setDescription('How the schedules vary.')
+    args << arg
+
     measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../../resources/hpxml-measures'))
     measure_subdir = 'BuildResidentialHPXML'
     full_measure_path = File.join(measures_dir, measure_subdir, 'measure.rb')
     measure = get_measure_instance(full_measure_path)
 
-    args = OpenStudio::Measure::OSArgumentVector.new
     measure.arguments(model).each do |arg|
       next if ['hpxml_path'].include? arg.name
       args << arg
@@ -55,12 +71,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
     end
 
     # assign the user inputs to variables
-    measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../../resources/hpxml-measures'))
-    measure_subdir = 'BuildResidentialHPXML'
-    full_measure_path = File.join(measures_dir, measure_subdir, 'measure.rb')
-    check_file_exists(full_measure_path, runner)
-    measure = get_measure_instance(full_measure_path)
-    args = measure.get_argument_values(runner, user_arguments)
+    args = get_argument_values(runner, arguments(model), user_arguments)
 
     # optionals: get or remove
     args.keys.each do |arg|
@@ -74,77 +85,80 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
       end
     end
 
-    # apply whole building create geometry measures
-    measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../../measures'))
-    check_dir_exists(measures_dir, runner)
-
-    if args[:geometry_unit_type] == 'single-family detached'
-      measure_subdir = 'ResidentialGeometryCreateSingleFamilyDetached'
-    elsif args[:geometry_unit_type] == 'single-family attached'
-      measure_subdir = 'ResidentialGeometryCreateSingleFamilyAttached'
-    elsif args[:geometry_unit_type] == 'apartment unit'
-      measure_subdir = 'ResidentialGeometryCreateMultifamily'
-    end
-
-    full_measure_path = File.join(measures_dir, measure_subdir, 'measure.rb')
-    check_file_exists(full_measure_path, runner)
-    measure = get_measure_instance(full_measure_path)
-
-    measure_args = {}
-    whole_building_model = OpenStudio::Model::Model.new
-    get_measure_args_default_values(whole_building_model, measure_args, measure)
-
-    measures = {}
-    measures[measure_subdir] = []
-    if ['ResidentialGeometryCreateSingleFamilyAttached', 'ResidentialGeometryCreateMultifamily'].include? measure_subdir
-      measure_args[:unit_ffa] = args[:geometry_cfa]
-      measure_args[:num_floors] = args[:geometry_num_floors_above_grade]
-      measure_args[:num_units] = args[:geometry_num_units]
-    end
-    measure_args = Hash[measure_args.collect{ |k, v| [k.to_s, v] }]
-    measures[measure_subdir] << measure_args
-
-    if not apply_measures(measures_dir, measures, runner, whole_building_model, nil, nil, true)
-      return false
-    end
-
     # get file/dir paths
-    resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), 'resources'))
+    resources_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../../resources'))
+    meta_measure_file = File.join(resources_dir, 'meta_measure.rb')
+    require File.join(File.dirname(meta_measure_file), File.basename(meta_measure_file, File.extname(meta_measure_file)))
     workflow_json = File.join(resources_dir, 'measure-info.json')
 
     # apply HPXML measures
-    measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../../resources/hpxml-measures'))
+    measures_dir = File.join(resources_dir, 'hpxml-measures')
     check_dir_exists(measures_dir, runner)
 
-    whole_building_model.getBuildingUnits.each_with_index do |unit, num_unit|
+    # these will get added back in by unit_model
+    model.getBuilding.remove
+    model.getShadowCalculation.remove
+    model.getSimulationControl.remove
+    model.getSite.remove
+    model.getTimestep.remove
+
+    units = get_unit_positions(runner, args)
+    if units.empty?
+      return false
+    end
+
+    units.each_with_index do |unit, unit_num|
       unit_model = OpenStudio::Model::Model.new
 
+      hpxml_path = File.expand_path("../#{unit['name']}.xml")
+
       # BuildResidentialHPXML
       measure_subdir = 'BuildResidentialHPXML'
+      full_measure_path = File.join(measures_dir, measure_subdir, 'measure.rb')
+      check_file_exists(full_measure_path, runner)
 
       # fill the measure args hash with default values
-      measure_args = args
+      measure_args = args.clone
+      measure_args.delete('feature_id')
+      measure_args.delete('schedules_variation')
 
       measures = {}
       measures[measure_subdir] = []
-      measure_args[:hpxml_path] = File.expand_path('../out.xml')
+
+      # hpxml path
+      measure_args['hpxml_path'] = hpxml_path
+
+      # software program
       begin
-        measure_args[:software_program_used] = File.basename(File.absolute_path(File.join(File.dirname(__FILE__), '../../..')))
+        measure_args['software_program_used'] = File.basename(File.absolute_path(File.join(File.dirname(__FILE__), '../../..')))
       rescue
       end
       begin
         version_rb File.absolute_path(File.join(File.dirname(__FILE__), '../../../lib/uo_cli/version.rb'))
         require version_rb
-        measure_args[:software_program_version] = URBANopt::CLI::VERSION
+        measure_args['software_program_version'] = URBANopt::CLI::VERSION
       rescue
       end
-      if unit.additionalProperties.getFeatureAsString('GeometryLevel').is_initialized
-        measure_args[:geometry_level] = unit.additionalProperties.getFeatureAsString('GeometryLevel').get
+
+      # schedules
+      measure_args['schedules_random_seed'] = args['feature_id'] * (unit_num + 1) # variation across units, but deterministic
+      if args['schedules_variation'] == 'building' && unit_num != 0 # variation by building, use already generated schedules
+        measure_args['schedules_type'] = 'user-specified'
+        measure_args['schedules_path'] = File.expand_path('../unit 1_schedules.csv')
+        measure_args.delete('schedules_random_seed')
+      end
+
+      # geometry
+      if unit.keys.include?('geometry_level')
+        measure_args['geometry_level'] = unit['geometry_level']
       end
-      if unit.additionalProperties.getFeatureAsString('GeometryHorizontalLocation').is_initialized
-        measure_args[:geometry_horizontal_location] = unit.additionalProperties.getFeatureAsString('GeometryHorizontalLocation').get
+      if unit.keys.include?('geometry_horizontal_location')
+        measure_args['geometry_horizontal_location'] = unit['geometry_horizontal_location']
       end
-      measure_args = Hash[measure_args.collect{ |k, v| [k.to_s, v] }]
+      if unit.keys.include?('geometry_orientation')
+        measure_args['geometry_orientation'] = unit['geometry_orientation']
+      end
+
       measures[measure_subdir] << measure_args
 
       # HPXMLtoOpenStudio
@@ -156,123 +170,224 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
       measure_args = {}
 
       measures[measure_subdir] = []
-      measure_args[:hpxml_path] = File.expand_path('../out.xml')
-      measure_args[:output_dir] = File.expand_path('..')
-      measure_args[:debug] = true
-      measure_args = Hash[measure_args.collect{ |k, v| [k.to_s, v] }]
+      measure_args['hpxml_path'] = hpxml_path
+      measure_args['output_dir'] = File.expand_path('..')
+      measure_args['debug'] = true
       measures[measure_subdir] << measure_args
 
-      if not apply_measures(measures_dir, measures, runner, unit_model, workflow_json, 'out.osw', true)
+      if not apply_child_measures(measures_dir, measures, runner, unit_model, workflow_json, "#{unit['name']}.osw", true)
         return false
       end
 
-      case args[:geometry_unit_type]
+      # store metadata for default feature reports measure
+      standards_number_of_above_ground_stories = Integer(args['geometry_num_floors_above_grade'])
+      standards_number_of_stories = Integer(args['geometry_num_floors_above_grade'])
+      number_of_conditioned_stories = Integer(args['geometry_num_floors_above_grade'])
+      if ['UnconditionedBasement', 'ConditionedBasement'].include?(args['geometry_foundation_type'])
+        standards_number_of_stories += 1
+        if ['ConditionedBasement'].include?(args['geometry_foundation_type'])
+          number_of_conditioned_stories += 1
+        end
+      end
+
+      standards_number_of_living_units = 1
+      if args.keys.include?('geometry_building_num_units')
+        standards_number_of_living_units = Integer(args['geometry_building_num_units'])
+      end
+
+      case args['geometry_unit_type']
       when 'single-family detached'
         building_type = 'Single-Family Detached'
       when 'single-family attached'
         building_type = 'Single-Family Attached'
-      when 'multifamily'
+      when 'apartment unit'
         building_type = 'Multifamily'
       end
 
       unit_model.getSpaceTypes.each do |space_type|
         next unless space_type.standardsSpaceType.is_initialized
+        next if space_type.standardsSpaceType.get != 'living space'
         space_type.setStandardsBuildingType(building_type)
       end
 
-      unit_dir = File.expand_path("../unit #{num_unit+1}")
-      Dir.mkdir(unit_dir)
-      FileUtils.cp(File.expand_path('../out.xml'), unit_dir) # this is the raw hpxml file
-      FileUtils.cp(File.expand_path('../out.osw'), unit_dir) # this has hpxml measure arguments in it      
-      FileUtils.cp(File.expand_path('../in.osm'), unit_dir) # this is osm translated from hpxml
+      unit_model.getBuilding.setStandardsBuildingType('Residential')
+      unit_model.getBuilding.setStandardsNumberOfAboveGroundStories(standards_number_of_above_ground_stories)
+      unit_model.getBuilding.setStandardsNumberOfStories(standards_number_of_stories)
+      unit_model.getBuilding.setNominalFloortoFloorHeight(Float(args['geometry_wall_height']))
+      unit_model.getBuilding.setStandardsNumberOfLivingUnits(standards_number_of_living_units)
+      unit_model.getBuilding.additionalProperties.setFeature('NumberOfConditionedStories', number_of_conditioned_stories)
 
-      if whole_building_model.getBuildingUnits.length == 1
-        model.getBuilding.remove
-        model.getShadowCalculation.remove
-        model.getSimulationControl.remove
-        model.getSite.remove
-        model.getTimestep.remove
+      if unit_num == 0 # for the first building unit, add everything
 
         model.addObjects(unit_model.objects, true)
-        next
-      end
 
-      # create building unit object to assign to spaces
-      building_unit = OpenStudio::Model::BuildingUnit.new(unit_model)
-      building_unit.setName("building_unit_#{num_unit}")
+      else # for single-family attached and multifamily, add "almost" everything
 
-      # save modified copy of model for use with merge
-      unit_model.getSpaces.sort.each do |space|
-        space.setYOrigin(60 * (num_unit-1)) # meters
-        space.setBuildingUnit(building_unit)
-      end
+        # shift the unit so it's not right on top of the previous one
+        unit_model.getSpaces.sort.each do |space|
+          space.setYOrigin(100.0 * unit_num) # meters
+        end
 
-      # prefix all objects with name using unit number. May be cleaner if source models are setup with unique names
-      unit_model.objects.each do |model_object|
-        next if model_object.name.nil?
-        model_object.setName("unit_#{num_unit} #{model_object.name.to_s}")
-      end
+        # prefix all objects with name using unit number. May be cleaner if source models are setup with unique names
+        prefix_all_unit_model_objects(unit_model, unit)
+
+        # we already have the following unique objects from the first building unit
+        unit_model.getConvergenceLimits.remove
+        unit_model.getOutputDiagnostics.remove
+        unit_model.getRunPeriodControlDaylightSavingTime.remove
+        unit_model.getShadowCalculation.remove
+        unit_model.getSimulationControl.remove
+        unit_model.getSiteGroundTemperatureDeep.remove
+        unit_model.getSiteGroundTemperatureShallow.remove
+        unit_model.getSite.remove
+        unit_model.getInsideSurfaceConvectionAlgorithm.remove
+        unit_model.getOutsideSurfaceConvectionAlgorithm.remove
+        unit_model.getTimestep.remove
+        unit_model.getFoundationKivaSettings.remove
+        unit_model_objects = []
+        unit_model.objects.each do |obj|
+          unit_model_objects << obj unless obj.to_Building.is_initialized # if we remove this, we lose all thermal zones
+        end
 
-      moodified_unit_path = File.join(unit_dir, 'modified_unit.osm')
-      unit_model.save(moodified_unit_path, true)
+        model.addObjects(unit_model_objects, true)
 
-      # run merge merge_spaces_from_external_file to add this unit to original model
-      merge_measures_dir = nil
-      osw_measure_paths = runner.workflow.measurePaths
-      osw_measure_paths.each do |orig_measure_path|
-        next if not orig_measure_path.to_s.include?('gems/openstudio-model-articulation')
-        merge_measures_dir = orig_measure_path.to_s
-        break
       end
-      merge_measure_subdir = 'merge_spaces_from_external_file'
-      merge_measures = {}
-      merge_measure_args = {}
-      merge_measures[merge_measure_subdir] = []
-      merge_measure_args[:external_model_name] = moodified_unit_path
-      merge_measure_args[:merge_geometry] = true
-      merge_measure_args[:merge_loads] = true
-      merge_measure_args[:merge_attribute_names] = true
-      merge_measure_args[:add_spaces] = true
-      merge_measure_args[:remove_spaces] = false
-      merge_measure_args[:merge_schedules] = true
-      merge_measure_args[:compact_to_ruleset] = false
-      merge_measure_args[:merge_zones] = true
-      merge_measure_args[:merge_air_loops] = true
-      merge_measure_args[:merge_plant_loops] = true
-      merge_measure_args[:merge_swh] = true
-      merge_measure_args = Hash[merge_measure_args.collect{ |k, v| [k.to_s, v] }]
-      merge_measures[merge_measure_subdir] << merge_measure_args
-
-      # for this instance pass in original model and not unit_model. unit_model path witll be an argument
-      if not apply_measures(merge_measures_dir, merge_measures, runner, model, workflow_json, 'out.osw', true)
-        return false
-      end
-
     end
 
-    # TODO: add surface intersection and matching (is don't in measure now but would be better to do once at end, make bool to skip in merge measure)
+    # save the "re-composed" model with all building units to file
+    building_path = File.expand_path(File.join('..', 'whole_building.osm'))
+    model.save(building_path, true)
 
     return true
   end
 
+  def get_unit_positions(runner, args)
+    units = []
+    if args['geometry_unit_type'] == 'single-family detached'
+      units << {'name' => 'unit 1'}
+    elsif args['geometry_unit_type'] == 'single-family attached'
+      (1..args['geometry_building_num_units']).to_a.each do |unit_num|
+        if unit_num == 1
+          units << {'name' => "unit #{unit_num}", 'geometry_horizontal_location' => 'Left'}
+        elsif unit_num == args['geometry_building_num_units']
+          units << {'name' => "unit #{unit_num}", 'geometry_horizontal_location' => 'Right'}
+        else
+          units << {'name' => "unit #{unit_num}", 'geometry_horizontal_location' => 'Middle'}
+        end
+      end
+    elsif args['geometry_unit_type'] == 'apartment unit'
+      if args['geometry_corridor_position'] == 'Double Exterior'
+
+        num_units_per_floor = (Float(args['geometry_building_num_units']) / Float(args['geometry_num_floors_above_grade'])).ceil
+        if num_units_per_floor == 1
+          runner.registerError("num_units_per_floor='#{num_units_per_floor}' not supported.")
+          return units
+        end
+
+        floor = 1
+        position = 1
+        (1..args['geometry_building_num_units']).to_a.each do |unit_num|
+
+          geometry_orientation = 180.0
+          if position.even?
+            geometry_orientation = 0.0
+          end
+
+          geometry_horizontal_location = 'Middle'
+          if position == 1
+            geometry_horizontal_location = 'Left'
+          elsif position == 2
+            geometry_horizontal_location = 'Right'
+          elsif position == num_units_per_floor and num_units_per_floor.even?
+            geometry_horizontal_location = 'Left'
+          elsif position == num_units_per_floor and num_units_per_floor.odd?
+            geometry_horizontal_location = 'Right'
+          elsif position + 1 == num_units_per_floor and num_units_per_floor.even?
+            geometry_horizontal_location = 'Right'
+          elsif position + 1 == num_units_per_floor and num_units_per_floor.odd?
+            geometry_horizontal_location = 'Left'
+          end
+
+          if floor == 1
+            geometry_level = 'Bottom'
+          elsif floor == args['geometry_num_floors_above_grade']
+            geometry_level = 'Top'
+          else
+            geometry_level = 'Middle'
+          end
+
+          if unit_num % num_units_per_floor == 0
+            floor += 1
+            position = 0
+          end
+          position += 1
+
+          units << {'name' => "unit #{unit_num}", 'geometry_horizontal_location' => geometry_horizontal_location, 'geometry_level' => geometry_level, 'geometry_orientation' => geometry_orientation}
+        end
+      else
+        runner.registerError("geometry_corridor_position='#{args['geometry_corridor_position']}' not supported.")
+        return units
+      end
+    end
+    return units
+  end
+
   def get_measure_args_default_values(model, args, measure)
     measure.arguments(model).each do |arg|
       next unless arg.hasDefaultValue
 
       case arg.type.valueName.downcase
-      when "boolean"
+      when 'boolean'
         args[arg.name] = arg.defaultValueAsBool
-      when "double"
+      when 'double'
         args[arg.name] = arg.defaultValueAsDouble
-      when "integer"
+      when 'integer'
         args[arg.name] = arg.defaultValueAsInteger
-      when "string"
+      when 'string'
         args[arg.name] = arg.defaultValueAsString
-      when "choice"
+      when 'choice'
         args[arg.name] = arg.defaultValueAsString
       end
     end
   end
+
+  def prefix_all_unit_model_objects(unit_model, unit)
+    ems_map = {}
+    unit_model.getEnergyManagementSystemSensors.each do |sensor|
+      ems_map["#{sensor.name}"] = "#{unit['name'].gsub(' ', '_')}_#{sensor.name}"
+      sensor.setKeyName("#{unit['name']} #{sensor.keyName}") unless sensor.keyName.empty?
+    end
+    unit_model.getEnergyManagementSystemActuators.each do |actuator|
+      ems_map["#{actuator.name}"] = "#{unit['name'].gsub(' ', '_')}_#{actuator.name}"
+    end
+    unit_model.getEnergyManagementSystemOutputVariables.each do |output_variable|
+      ems_map["#{output_variable.emsVariableName}"] = "#{unit['name'].gsub(' ', '_')}_#{output_variable.emsVariableName}"
+      output_variable.setEMSVariableName("#{unit['name'].gsub(' ', '_')}_#{output_variable.emsVariableName}")
+    end
+
+    # variables in program lines don't get updated automatically
+    unit_model.getEnergyManagementSystemPrograms.each do |program|
+      new_lines = []
+      program.lines.each_with_index do |line, i|
+        ems_map.each do |old_name, new_name|
+          line = line.gsub(" #{old_name}", " #{new_name}") if line.include?(" #{old_name}")
+          line = line.gsub("(#{old_name} ", "(#{new_name} ") if line.include?("(#{old_name} ")
+          line = line.gsub(" #{old_name})", " #{new_name})") if line.include?(" #{old_name})")
+          line = line.gsub("-#{old_name})", "-#{new_name})") if line.include?("-#{old_name})")
+          line = line.gsub("+#{old_name})", "+#{new_name})") if line.include?("+#{old_name})")
+          line = line.gsub("*#{old_name})", "*#{new_name})") if line.include?("*#{old_name})")
+        end
+        new_lines << line
+      end
+      program.setLines(new_lines)
+    end
+
+    unit_model.objects.each do |model_object|
+      next if model_object.name.nil?
+
+      model_object.setName("#{unit['name']} #{model_object.name.to_s}")
+    end
+  end
 end
 
 # register the measure to be used by the application