Merge pull request #1658 from NREL/fix/docs

Minor documentation fixes
NREL · Jan 12, 2024 · 24a9c23 · 24a9c23
2 parents f0be45c + 963f536
commit 24a9c23
Show file tree

Hide file tree

Showing 21 changed files with 46 additions and 29 deletions.
diff --git a/lib/openstudio-standards/constructions/information.rb b/lib/openstudio-standards/constructions/information.rb
@@ -1,7 +1,8 @@
-# Methods to create typical models
 module OpenstudioStandards
+  # The Constructions module provides methods create, modify, and get information about model Constructions
   module Constructions
     # @!group Information
+    # Methods to get information about Constructions
 
     # Returns the solar reflectance index of an exposed surface.
     # On a scale of 0 to 100, standard black is 0, and standard white is 100.

diff --git a/lib/openstudio-standards/constructions/materials/modify.rb b/lib/openstudio-standards/constructions/materials/modify.rb
@@ -1,8 +1,10 @@
-# Methods to modify material properties
 module OpenstudioStandards
+  # The Constructions module provides methods create, modify, and get information about model Constructions
   module Constructions
+    # The Materials module provides methods create, modify, and get information about Materials
     module Materials
       # @!group Modify
+      # Methods to modify Materials
 
       # change thermal resistance of opaque materials by increasing material thickness,
       # or setting thermal resistance directly for massless or airgap materials.

diff --git a/lib/openstudio-standards/constructions/modify.rb b/lib/openstudio-standards/constructions/modify.rb
@@ -1,7 +1,8 @@
-# Methods to modify construction properties
 module OpenstudioStandards
+  # The Constructions module provides methods create, modify, and get information about model Constructions
   module Constructions
     # @!group Modify
+    # Methods to modify Constructions
 
     # add new material layer to a construction
     #

diff --git a/lib/openstudio-standards/create_typical/create_typical.rb b/lib/openstudio-standards/create_typical/create_typical.rb
@@ -1,7 +1,8 @@
-# Methods to create typical models
 module OpenstudioStandards
+  # The CreateTypical module provides methods to create and modify an entire building energy model of a typical building
   module CreateTypical
     # @!group CreateTypical
+    # Methods to create typical models
 
     # create typical building from model
     # creates a complete energy model from model with defined geometry and standards space type assignments
@@ -277,7 +278,7 @@ def self.create_typical_building_from_model(model,
       # adjust F factor constructions to avoid simulation errors
       model.getFFactorGroundFloorConstructions.each do |cons|
         # Rfilm_in = 0.135, Rfilm_out = 0.03, Rcons = 0.15/1.95
-        if cons.area <= (0.135 + 0.03 + 0.15/1.95) * cons.perimeterExposed * cons.fFactor
+        if cons.area <= (0.135 + 0.03 + 0.15 / 1.95) * cons.perimeterExposed * cons.fFactor
           # set minimum Rfic to > 1e-3
           new_area = 0.233 * cons.perimeterExposed * cons.fFactor
           OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.CreateTypical', "F-factor fictitious resistance for #{cons.name.get} with Area=#{cons.area.round(2)}, Exposed Perimeter=#{cons.perimeterExposed.round(2)}, and F-factor=#{cons.fFactor.round(2)} will result in a negative value and a failed simulation. Construction area is adjusted to be #{new_area.round(2)}.")

diff --git a/lib/openstudio-standards/create_typical/enumerations.rb b/lib/openstudio-standards/create_typical/enumerations.rb
@@ -1,7 +1,8 @@
-# Methods to create available inputs for typical models
 module OpenstudioStandards
+  # The CreateTypical module provides methods to create and modify an entire building energy model of a typical building
   module CreateTypical
     # @!group CreateTypicalEnumerations
+    # Enumerations for CreateTypical
 
     # Get DOE building types
     #

diff --git a/lib/openstudio-standards/create_typical/space_type_blend.rb b/lib/openstudio-standards/create_typical/space_type_blend.rb
@@ -1,7 +1,8 @@
-# Methods to create typical models
 module OpenstudioStandards
+  # The CreateTypical module provides methods to create and modify an entire building energy model of a typical building
   module CreateTypical
     # @!group Space Type Blending
+    # Methods to blend space types together
 
     # get all loads for a space or space type and place in hash by type
     #
@@ -697,7 +698,7 @@ def self.blend_internal_loads(model, source_space_or_space_type, target_space_ty
         elsif load_inst.designFlowRateCalculationMethod == 'Flow/ExteriorWallArea'
           load_inst.setFlowperExteriorWallArea(load_inst.flowperExteriorWallArea.get * ext_wall_area_ratio)
         elsif load_inst.designFlowRateCalculationMethod == 'AirChanges/Hour'
-          load_inst.setAirChangesperHour (load_inst.airChangesperHour.get * volume_ratio)
+          load_inst.setAirChangesperHour(load_inst.airChangesperHour.get * volume_ratio)
         else
           OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.CreateTypical', "Unexpected value type for #{load_inst.name}")
           return false

diff --git a/lib/openstudio-standards/create_typical/space_type_ratios.rb b/lib/openstudio-standards/create_typical/space_type_ratios.rb
@@ -1,6 +1,8 @@
-# Methods to create available inputs for typical models
 module OpenstudioStandards
+  # The CreateTypical module provides methods to create and modify an entire building energy model of a typical building
   module CreateTypical
+    # A lookup for space type ratios for typical building types
+
     # create hash of space types and generic ratios of building floor area.
     # some building type and template combination are incompatible
     #

diff --git a/lib/openstudio-standards/daylighting/space.rb b/lib/openstudio-standards/daylighting/space.rb
@@ -1,5 +1,5 @@
-# Methods to add daylighting to a space
 module OpenstudioStandards
+  # The Daylighting module provides methods to add daylighting to a Space
   module Daylighting
     # @!group Space
 

diff --git a/lib/openstudio-standards/geometry/create.rb b/lib/openstudio-standards/geometry/create.rb
@@ -1,7 +1,8 @@
-# Methods to create geometry
 module OpenstudioStandards
+  # This Module provides methods to create, modify, and get information about model geometry
   module Geometry
     # @!group Create
+    # Methods to create geometry
 
     # method to create a point object at the center of a floor
     #

diff --git a/lib/openstudio-standards/geometry/create_bar.rb b/lib/openstudio-standards/geometry/create_bar.rb
@@ -1,7 +1,8 @@
-# Methods to create geometry
 module OpenstudioStandards
+  # This Module provides methods to create, modify, and get information about model geometry
   module Geometry
     # @!group CreateBar
+    # Methods to create bar geometry
 
     # Building Form Defaults from Table 4.2 in Achieving the 30% Goal: Energy and Cost Savings Analysis of ASHRAE Standard 90.1-2010
     # aspect ratio for NA replaced with floor area to perimeter ratio from prototype model
@@ -494,7 +495,7 @@ def self.create_bar(model, bar_hash)
 
           compare_hash = {}
           if !stories_flat.empty?
-            stories_flat.last.each { |k, v| compare_hash[k] = flat_hash[k] if flat_hash[k] != v }
+            stories_flat.last.each { |s, m| compare_hash[s] = flat_hash[s] if flat_hash[s] != m }
           end
           if (bar_hash[:story_multiplier_method] != 'None' && stories_flat.last == flat_hash) || (bar_hash[:story_multiplier_method] != 'None' && compare_hash.size == 1 && compare_hash.include?(:multiplier))
             stories_flat.last[:multiplier] += v[:story_min_multiplier]

diff --git a/lib/openstudio-standards/geometry/information.rb b/lib/openstudio-standards/geometry/information.rb
@@ -1,8 +1,8 @@
-# Methods to get information about model geometry
-# Many of these methods may be moved to core OpenStudio
 module OpenstudioStandards
+  # This Module provides methods to create, modify, and get information about model geometry
   module Geometry
     # @!group Information
+    # Methods to get information about model geometry
 
     # calculate aspect ratio from area and perimeter
     #

diff --git a/lib/openstudio-standards/geometry/modify.rb b/lib/openstudio-standards/geometry/modify.rb
@@ -1,7 +1,8 @@
-# Methods to modify geometry
 module OpenstudioStandards
+  # This Module provides methods to create, modify, and get information about model geometry
   module Geometry
     # @!group Modify
+    # Methods to modify geometry
 
     # lower z value of vertices with starting value above z_value_target to z_value_target
     #

diff --git a/lib/openstudio-standards/hvac/air_loop/information.rb b/lib/openstudio-standards/hvac/air_loop/information.rb
@@ -1,7 +1,8 @@
-# Method to apply a typical CBECS HVAC system to thermal zones
 module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
   module HVAC
     # @!group AirLoop:Information
+    # Methods to get information on AirLoop objects
 
     # Returns whether air loop HVAC is a direct evaporative system
     #

diff --git a/lib/openstudio-standards/hvac/cbecs_hvac.rb b/lib/openstudio-standards/hvac/cbecs_hvac.rb
@@ -1,7 +1,8 @@
-# Method to apply a typical CBECS HVAC system to thermal zones
 module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
   module HVAC
     # @!group CBECS HVAC
+    # Method to apply a typical CBECS HVAC system to thermal zones
 
     # Adds the HVAC system as derived from the combinations of CBECS 2012 MAINHT and MAINCL fields.
     # Mapping between combinations and HVAC systems per http://www.nrel.gov/docs/fy08osti/41956.pdf

diff --git a/lib/openstudio-standards/hvac/setpoint_managers/information.rb b/lib/openstudio-standards/hvac/setpoint_managers/information.rb
@@ -1,7 +1,8 @@
-# Method to apply a typical CBECS HVAC system to thermal zones
 module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
   module HVAC
     # @!group Setpoint Managers:Information
+    # Methods to get information about setpoint managers
 
     # Get the min and max setpoint values for a setpoint manager
     #

diff --git a/lib/openstudio-standards/schedules/create.rb b/lib/openstudio-standards/schedules/create.rb
@@ -1,7 +1,8 @@
-# Methods to create Schedule objects
 module OpenstudioStandards
+  # The Schedules module provides methods to create, modify, and get information about Schedule objects
   module Schedules
     # @!group Create
+    # Methods to create Schedule objects
 
     # create a ScheduleTypeLimits object for a schedule
     #

diff --git a/lib/openstudio-standards/schedules/information.rb b/lib/openstudio-standards/schedules/information.rb
@@ -1,8 +1,8 @@
-# Methods to get information from Schedule objects
-# Many of these methods may be moved to core OpenStudio
 module OpenstudioStandards
+  # The Schedules module provides methods to create, modify, and get information about Schedule objects
   module Schedules
     # @!group Information
+    # Methods to get information about Schedule objects
 
     # Returns the Schedule minimum and maximum values encountered during the run-period.
     # This method does not include summer and winter design day values.

diff --git a/lib/openstudio-standards/schedules/modify.rb b/lib/openstudio-standards/schedules/modify.rb
@@ -1,7 +1,8 @@
-# Methods to modify existing Schedule objects
 module OpenstudioStandards
+  # The Schedules module provides methods to create, modify, and get information about Schedule objects
   module Schedules
     # @!group Modify
+    # Methods to modify existing Schedule objects
 
     # Increase/decrease by percentage or static value
     #

diff --git a/lib/openstudio-standards/standards/deer/deer_2020/deer_2020.AirLoopHVAC.rb b/lib/openstudio-standards/standards/deer/deer_2020/deer_2020.AirLoopHVAC.rb
@@ -33,8 +33,8 @@ def air_loop_hvac_motorized_oa_damper_required?(air_loop_hvac, climate_zone)
     return motorized_oa_damper_required
   end
 
-  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
-  # @return [Array<Double>] [min_oa_without_economizer_cfm, min_oa_with_economizer_cfm]
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Array<Double>] [min_oa_without_economizer_cfm, min_oa_with_economizer_cfm]
   def air_loop_hvac_demand_control_ventilation_limits(air_loop_hvac)
     min_oa_without_economizer_cfm = 3000
     min_oa_with_economizer_cfm = 0

diff --git a/lib/openstudio-standards/weather/information.rb b/lib/openstudio-standards/weather/information.rb
@@ -1,5 +1,5 @@
-# Methods to create Schedule objects
 module OpenstudioStandards
+  # The Weather module provides methods to set and get information about the model weather file
   module Weather
     # @!group Information
 

diff --git a/openstudio-standards.gemspec b/openstudio-standards.gemspec
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'bundler', '~> 1.9'
   elsif RUBY_VERSION < '2.7'
     spec.add_development_dependency 'parallel_tests', '~> 3.0.0'
-    spec.add_development_dependency 'nokogiri', '<= 1.11.7' #updated to use more secure version
+    spec.add_development_dependency 'nokogiri', '<= 1.11.7' # updated to use more secure version
     spec.add_development_dependency 'bundler', '~> 2.1'
   else
     spec.add_development_dependency 'parallel_tests', '~> 3.7.0'
@@ -48,6 +48,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'roo', '2.7.1'
   spec.add_development_dependency 'openstudio-api-stubs'
   spec.add_runtime_dependency 'tbd', '~> 3'
-  #spec.add_development_dependency 'aws-sdk-s3'
-  #spec.add_development_dependency 'git-revision'
+  # spec.add_development_dependency 'aws-sdk-s3'
+  # spec.add_development_dependency 'git-revision'
 end