Appx g/merge master 09192023

.github/pull_request_template.md

@@ -0,0 +1,31 @@
+Pull request overview
+---------------------
+
+<!--- DESCRIBE PURPOSE OF THIS PULL REQUEST -->
+
+ - Fixes #ISSUENUMBERHERE (IF THIS IS A DEFECT)
+
+### Pull Request Author
+
+<!--- Add to this list or remove from it as applicable.  This is a simple templated set of guidelines. -->
+
+ - [ ] Method changes or additions
+ - [ ] Data changes or additions
+ - [ ] Added tests for added methods
+ - [ ] If methods have been deprecated, update rest of code to use the new methods
+ - [ ] Documented new methods using [yard syntax](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md)
+ - [ ] Resolved yard documentation errors for new code (ran `bundle exec rake doc`)
+ - [ ] Resolved rubocop syntax errors for new code (ran `bundle exec rake rubocop`)
+ - [ ] All new and existing tests passes
+ - [ ] If the code adds new `require` statements, ensure these are in core ruby or add to the gemspec
+
+### Review Checklist
+
+This will not be exhaustively relevant to every PR.
+ - [ ] Perform a code review on GitHub
+ - [ ] All related changes have been implemented: method additions, changes, tests
+ - [ ] Check rubocop errors
+ - [ ] Check yard doc errors
+ - [ ] If fixing a defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
+ - [ ] If a new feature, test the new feature and try creative ways to break it
+ - [ ] CI status: all green or justified

.yardopts

@@ -16,13 +16,16 @@ lib/openstudio-standards/prototypes/**/*.rb
 lib/openstudio-standards/utilities/**/*.rb
 lib/openstudio-standards/weather/**/*.rb
 lib/openstudio-standards/refs/references.rb
+lib/openstudio-standards/schedules/**/*.rb
+lib/openstudio-standards/geometry/**/*.rb
+lib/openstudio-standards/create_typical/**/*.rb
+
 -
 docs/Home.md
 docs/UserQuickStartGuide.md
 docs/Features.md
 docs/DeveloperInformation.md
 docs/RepositoryStructure.md
 docs/CodeArchitecture.md
-docs/AddingAStandard.md
 License.txt
 LGPL-2.1

Rakefile

@@ -38,7 +38,6 @@ namespace :test do
     t.verbose = false
   end
 
-
   # These tests only available in the CI environment
   if ENV['CI'] == 'true'
 

data/standards/manage_OpenStudio_Standards.rb

@@ -202,7 +202,7 @@ def standard_directory_name_from_template(template)
 end
 
 # checks whether your authorization credentials are set up to access the spreadsheets
-# @return [Bool] returns true if api is working, false if not
+# @return [Boolean] returns true if api is working, false if not
 def check_google_drive_configuration
   require 'google_drive'
   client_config_path = File.join(Dir.home, '.credentials', "client_secret.json")

lib/openstudio-standards.rb

@@ -5,8 +5,22 @@
 module OpenstudioStandards
   require 'json' # Used to load standards JSON files
 
-  # HVAC sizing
-  require_relative 'openstudio-standards/hvac_sizing/Siz.Model'
+  # Load Modules
+
+  # Geometry Module
+  require_relative 'openstudio-standards/geometry/create'
+  require_relative 'openstudio-standards/geometry/modify'
+  require_relative 'openstudio-standards/geometry/information'
+
+  # Schedules Module
+  require_relative 'openstudio-standards/schedules/create'
+  require_relative 'openstudio-standards/schedules/modify'
+  require_relative 'openstudio-standards/schedules/information'
+
+  # CreateTypical Module
+  require_relative 'openstudio-standards/create_typical/enumerations'
+  require_relative 'openstudio-standards/create_typical/space_type_ratios'
+  require_relative 'openstudio-standards/create_typical/create_typical'
 
   # Weather data
   require_relative 'openstudio-standards/weather/Weather.Model'

lib/openstudio-standards/btap/analysis.rb

@@ -93,7 +93,7 @@
 #
 #       #This method will do an analysis of the opaque surface conductance sensitivity and returns a string model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model [OpenStudio::Model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param choice [String] description
 #       #@return [modelArray<String>]
 #       def self.opaque_surface_conductance_sensitivity_analysis(model,choice )
@@ -191,7 +191,7 @@
 #
 #       #This method performs a wall sensitivity analysis and returns a string model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model [OpenStudio::Model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param folder_name [String]
 #       #@param values<Fixnum>
 #       #@return [modelArray<String>]
@@ -213,7 +213,7 @@
 #
 #       #This method performs a roof sensitivity analysis and returns a string model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_in [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model_in [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param folder_name [String]
 #       #@param values<Fixnum>
 #       #@return [modelArray<String>]
@@ -249,7 +249,7 @@
 #
 #       #This method performs a glazing solar transmittance sensitivity analysis and returns a model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_in [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model_in [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param folder_name [String]
 #       #@param values<Fixnum>
 #       #@return [modelArray<String>]
@@ -270,7 +270,7 @@
 #
 #       #This method performs an rvalue sensitivity analysis and returns a model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_in [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model_in [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param folder_name [String]
 #       #@param values<Fixnum>
 #       #@return [modelArray<String>]
@@ -291,7 +291,7 @@
 #
 #       #This method performs a full sensitivity analysis on the wall, roof, solar-trans,window,and ground surfaces.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model [OpenStudio::Model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param parent_folder [String]
 #       def self.full_sensitivity_analysis(model, parent_folder)
 #         self.wall_rvalue_sensitivity_model_analysis(model, (parent_folder + "/wall-r"))
@@ -304,7 +304,7 @@
 #
 #       #This method performs a full analysis (elimination and Sensitivity).
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model [OpenStudio::Model::Model] A model object   {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param folder [String]
 #       def self.full_analysis(model, folder)
 #         FileUtils.rm_rf(folder)
@@ -318,7 +318,7 @@
 #
 #       #This method performs an elimination analysis ( OA, H&C setpoints,infiltration,occupancy,lighting,plug_loads,gas_equipment, hotwater, steam, other) and returns a model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_in [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+#       #@param model_in [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
 #       #@param folder_name [String]
 #       #@return [modelArray<String>]
 #       def self.full_elimination_analysis(model_in, folder_name)

lib/openstudio-standards/btap/bridging.rb

@@ -1578,7 +1578,7 @@ def alter_buffers(model = nil)
     # @param model [OpenStudio::Model::Model] a model
     # @param buffers [Array] identifiers of modified buffer spaces in model
     #
-    # @return [Bool] true if successful
+    # @return [Boolean] true if successful
     def purge_buffer_schedules(model = nil, buffers = [])
       scheds = []
       lgs    = @feedback[:logs]
@@ -1663,7 +1663,7 @@ def minU(model = nil, stypes = :walls)
     # @param model [OpenStudio::Model::Model] a model
     # @param argh [Hash] BTAP/TBD argument hash
     #
-    # @return [Bool] true if valid (check @feedback logs if false)
+    # @return [Boolean] true if valid (check @feedback logs if false)
     def populate(model = nil, argh = {})
       cl     = OpenStudio::Model::Model
       args   = { option: "(non thermal bridging)" }    # for initial TBD dry run
@@ -1855,7 +1855,7 @@ def inputs(perform = :hp, quality = :good)
     ##
     # Generate BTAP/TBD tallies
     #
-    # @return [Bool] true if BTAP/TBD tally is successful
+    # @return [Boolean] true if BTAP/TBD tally is successful
     def gen_tallies
       edges  = {}
       return false unless @model.key?(:io)
@@ -1887,7 +1887,7 @@ def gen_tallies
     ##
     # Generate BTAP/TBD post-processing feedback.
     #
-    # @return [Bool] true if valid BTAP/TBD model
+    # @return [Boolean] true if valid BTAP/TBD model
     def gen_feedback
       lgs = @feedback[:logs]
       return false unless @model.key?(:complies) # all model constructions

lib/openstudio-standards/btap/btap.model.rb

@@ -472,7 +472,7 @@
 #
 #   #This method will set the infiltration magnitude.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param self [OpenStudio::model::Model] A model object
+#   #@param self [OpenStudio::Model::Model] A model object
 #   #@param setDesignFlowRate [Float]
 #   #@param setFlowperSpaceFloorArea [Float]
 #   #@param setFlowperExteriorSurfaceArea [Float]
@@ -509,7 +509,7 @@
 #
 #   #This method will scale people loads schedule.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param a_coef [Float]
 #   #@param b_coef [Float]
 #   #@param c_coef [Float]
@@ -528,7 +528,7 @@
 #
 #   #This method will scale lighting loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_lighting_loads(factor)
 #     self.getLightss.sort.each do |item|
@@ -538,7 +538,7 @@
 #
 #   #This method will scale lighting loads schedule.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param a_coef [Float]
 #   #@param b_coef [Float]
 #   #@param c_coef [Float]
@@ -557,7 +557,7 @@
 #
 #   #This method will scale electrical loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_electrical_loads(model, factor)
 #     self.getElectricEquipments.sort.each do |item|
@@ -567,7 +567,7 @@
 #
 #   #This method will scale electrical loads schedule.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param a_coef [Float]
 #   #@param b_coef [Float]
 #   #@param c_coef [Float]
@@ -585,7 +585,7 @@
 #
 #   #This method will scale Outdoor Air loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_oa_loads(factor)
 #     self.getDesignSpecificationOutdoorAirs.sort.each do |oa_def|
@@ -598,7 +598,7 @@
 #
 #   #This method will scale infiltration loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_inflitration_loads(factor)
 #     self.getSpaceInfiltrationDesignFlowRates.sort.each do |infiltration_load|
@@ -612,7 +612,7 @@
 #   # Elimination Methods
 #   #This method removes people loads from the model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_people_loads()
 #     self.getPeoples.sort.each {|people| people.remove}
 #     self.getPeopleDefinitions.sort.each {|people| people.remove}
@@ -621,7 +621,7 @@
 #
 #   #This method removes light loads from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_lighting_loads()
 #     self.getLightss.sort.each {|item| item.remove}
 #     self.getLightsDefinitions.sort.each {|item| item.remove}
@@ -630,7 +630,7 @@
 #
 #   #This method removes elec loads from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_electric_loads()
 #     self.getElectricEquipments.sort.each {|item| item.remove}
 #     self.getElectricEquipmentDefinitions.sort.each {|item| item.remove}
@@ -639,23 +639,23 @@
 #
 #   #This method removes all design specification OA from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_design_specification_outdoor_air()
 #     self.getDesignSpecificationOutdoorAirs.sort.each {|item| item.remove}
 #     return self
 #   end
 #
 #   #This method removes infiltration from model..
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_space_infiltration_design_flow_rates()
 #     self.getSpaceInfiltrationDesignFlowRates.sort.each {|item| item.remove}
 #     return self
 #   end
 #
 #   #This method removes all space loads from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_loads()
 #     conductance = 0.200
 #

lib/openstudio-standards/btap/btap.rb

@@ -186,7 +186,7 @@ def initialize()
   module SimulationSettings
     #This sets the simulation period for the model. All arguments are integers.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+    #@param model [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
     #@param start_month [Integer] a list of output variables that you wish to report from the simulation.
     #@param start_day [Integer] a list of output variables that you wish to report from the simulation.
     #@param end_month [Integer] a list of output variables that you wish to report from the simulation.
@@ -208,7 +208,7 @@ module Reports
     #This method clears all the output variables to make simulations run faster or to
     #start fresh.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+    #@param model [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
     #@return [OpenStudio::Model::Model] the OpenStudio model object (self reference).
     def self.clear_output_variables(model)
       #remove existing outputs
@@ -220,7 +220,7 @@ def self.clear_output_variables(model)
 
     #This turns all output on. Warning: Long runtimes will result.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param frequency [Fixnum]
     #@return [OpenStudio::Model::Model] a copy of the OpenStudio model object (self reference).
     def self.all_output_variables(model,frequency)
@@ -231,7 +231,7 @@ def self.all_output_variables(model,frequency)
     #This method returns a vector of the results that are available in the current
     #model.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@return [Array<String>] a list of all the possible output variables.
     def self.get_possible_output_variables( model )
       #Run simulation
@@ -256,7 +256,7 @@ def self.get_possible_output_variables( model )
 
     #This method sets up some predetermined output variables. May take a while to run with these settings.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param frequency [Fixnum]
     #@param output_variable_array [Array<String>] a list of output variables that you wish to report from the simulation.
     #@return [OpenStudio::Model::Model] the OpenStudio model object (self reference).
@@ -276,7 +276,7 @@ module Site
     #This method sets the weather file for the model.
     #It takes a simple string, remember to escape the slashes..(i.e. // not / )
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param  epw_path [String] a simple string of the epw file path, remember to escape the slashes..(i.e. // not / )
     def self.set_weather_file(model, epw_path)
       BTAP::Environment::WeatherFile.new(epw_path).set_weather_file(model)
@@ -289,7 +289,7 @@ module Common
     #This model checks to see if the obj_array passed is
     #the object we require, or if a string is given to search for a object of that strings name.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param obj_array <Object>
     #@param object_type [Object]
     def self.validate_array(model,obj_array,object_type)