openstudio-common-measures 0.9.0 → 0.11.0

data/lib/measures/ServerDirectoryCleanup/README.md

@@ -5,10 +5,10 @@
 # Server Directory Cleanup
 
 ## Description
-
+Clean up files in the run directory
 
 ## Modeler Description
-
+You can select which files to remove by the file types (eg: sql) as well as the sizing run directories
 
 ## Measure Type
 ReportingMeasure
@@ -19,7 +19,7 @@ ReportingMeasure
 ## Arguments
 
 
-### Remove sql files from run directory
+### Remove 'sql' files from run directory
 
 **Name:** sql,
 **Type:** Boolean,
@@ -27,7 +27,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove eso files from run directory
+### Remove 'eso' files from run directory
 
 **Name:** eso,
 **Type:** Boolean,
@@ -35,7 +35,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove audit files from run directory
+### Remove 'audit' files from run directory
 
 **Name:** audit,
 **Type:** Boolean,
@@ -43,7 +43,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove osm files from run directory
+### Remove 'osm' files from run directory
 
 **Name:** osm,
 **Type:** Boolean,
@@ -51,7 +51,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove idf files from run directory
+### Remove 'idf' files from run directory
 
 **Name:** idf,
 **Type:** Boolean,
@@ -59,7 +59,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove bnd files from run directory
+### Remove 'bnd' files from run directory
 
 **Name:** bnd,
 **Type:** Boolean,
@@ -67,7 +67,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove eio files from run directory
+### Remove 'eio' files from run directory
 
 **Name:** eio,
 **Type:** Boolean,
@@ -75,7 +75,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove shd files from run directory
+### Remove 'shd' files from run directory
 
 **Name:** shd,
 **Type:** Boolean,
@@ -83,7 +83,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove mdd files from run directory
+### Remove 'mdd' files from run directory
 
 **Name:** mdd,
 **Type:** Boolean,
@@ -91,7 +91,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove rdd files from run directory
+### Remove 'rdd' files from run directory
 
 **Name:** rdd,
 **Type:** Boolean,
@@ -99,7 +99,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove csv files from run directory
+### Remove 'csv' files from run directory
 
 **Name:** csv,
 **Type:** Boolean,
@@ -107,7 +107,7 @@ ReportingMeasure
 **Required:** true,
 **Model Dependent:** false
 
-### Remove Sizing Run Directories files from run directory
+### Remove 'Sizing Run Directories' files from run directory
 
 **Name:** Sizing Run Directories,
 **Type:** Boolean,

data/lib/measures/ServerDirectoryCleanup/measure.rb

@@ -1,4 +1,3 @@
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
 # See also https://openstudio.net/license
@@ -12,8 +11,16 @@ class ServerDirectoryCleanup < OpenStudio::Measure::ReportingMeasure
     'Server Directory Cleanup'
   end
 
+  def description
+    'Clean up files in the run directory'
+  end
+
+  def modeler_description
+    'You can select which files to remove by the file types (eg: sql) as well as the sizing run directories'
+  end
+
   # file types that can be removed
-  def file_types
+  def self.file_types
     # key is arg name value is string for run method
     file_types = {}
     file_types['sql'] = '*.sql'
@@ -33,15 +40,15 @@ class ServerDirectoryCleanup < OpenStudio::Measure::ReportingMeasure
   end
 
   # define the arguments that the user will input
-  def arguments(model = nil)
+  def arguments(_model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # loop through file types and make arguments
-    file_types.each do |k, v|
-      temp_var = OpenStudio::Measure::OSArgument.makeBoolArgument(k, true)
-      temp_var.setDisplayName("Remove #{k} files from run directory")
-      temp_var.setDefaultValue(true)
-      args << temp_var
+    ServerDirectoryCleanup.file_types.each do |file_type, _|
+      arg = OpenStudio::Measure::OSArgument.makeBoolArgument(file_type, true)
+      arg.setDisplayName("Remove '#{file_type}' files from run directory")
+      arg.setDefaultValue(true)
+      args << arg
     end
 
     args
@@ -57,22 +64,19 @@ class ServerDirectoryCleanup < OpenStudio::Measure::ReportingMeasure
     end
 
     # assign the user inputs to variables
-    args = {}
-    file_types.each do |k, v|
-      args[k] = runner.getBoolArgumentValue(k, user_arguments)
-    end
-
+    args = ServerDirectoryCleanup.file_types.map { |k, _| [k, runner.getBoolArgumentValue(k, user_arguments)] }.to_h
     initial_string = 'The following files were in the local run directory prior to the execution of this measure: '
     Dir.entries('./../').each do |f|
       initial_string << "#{f}, "
     end
-    initial_string = initial_string[0..(initial_string.length - 3)] + '.'
+    initial_string = "#{initial_string[0..(initial_string.length - 3)]}."
     runner.registerInitialCondition(initial_string)
 
     # TODO: - code to remove sizing runs is not functional yet
     # delete run directories
-    file_types.each do |k, v|
+    ServerDirectoryCleanup.file_types.each do |k, v|
       next if !args[k]
+
       if v == 'Sizing Run Directories'
 
         Dir.glob('./../**/output').select { |e| File.directory? e }.each do |f|
@@ -99,12 +103,12 @@ class ServerDirectoryCleanup < OpenStudio::Measure::ReportingMeasure
     Dir.entries('./..').each do |f|
       final_string << "#{f}, "
     end
-    final_string = final_string[0..(final_string.length - 3)] + '.'
+    final_string = "#{final_string[0..(final_string.length - 3)]}."
     runner.registerFinalCondition(final_string)
 
     true
-  end # end the run method
-end # end the measure
+  end
+end
 
 # this allows the measure to be use by the application
 ServerDirectoryCleanup.new.registerWithApplication

data/lib/measures/ServerDirectoryCleanup/measure.xml

@@ -1,19 +1,19 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>server_directory_cleanup</name>
   <uid>ec7d04ad-0b7b-495b-825a-e1b6d28d1d3f</uid>
-  <version_id>d77ddec0-1542-42cf-be4e-42203351027b</version_id>
-  <version_modified>20221115T223556Z</version_modified>
+  <version_id>b7ac12e3-448d-4bc8-8e61-f07b99ac5829</version_id>
+  <version_modified>2024-11-16T23:54:12Z</version_modified>
   <xml_checksum>5BFE84C4</xml_checksum>
   <class_name>ServerDirectoryCleanup</class_name>
   <display_name>Server Directory Cleanup</display_name>
-  <description>Removes a significant portion of the saved results from each run, helping to alleviate memory problems.</description>
-  <modeler_description>Use during large server runs, when individual sequel files and the like will not be needed.</modeler_description>
+  <description>Clean up files in the run directory</description>
+  <modeler_description>You can select which files to remove by the file types (eg: sql) as well as the sizing run directories</modeler_description>
   <arguments>
     <argument>
       <name>sql</name>
-      <display_name>Remove sql files from run directory</display_name>
+      <display_name>Remove 'sql' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -31,7 +31,7 @@
     </argument>
     <argument>
       <name>eso</name>
-      <display_name>Remove eso files from run directory</display_name>
+      <display_name>Remove 'eso' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -49,7 +49,7 @@
     </argument>
     <argument>
       <name>audit</name>
-      <display_name>Remove audit files from run directory</display_name>
+      <display_name>Remove 'audit' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -67,7 +67,7 @@
     </argument>
     <argument>
       <name>osm</name>
-      <display_name>Remove osm files from run directory</display_name>
+      <display_name>Remove 'osm' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -85,7 +85,7 @@
     </argument>
     <argument>
       <name>idf</name>
-      <display_name>Remove idf files from run directory</display_name>
+      <display_name>Remove 'idf' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -103,7 +103,7 @@
     </argument>
     <argument>
       <name>bnd</name>
-      <display_name>Remove bnd files from run directory</display_name>
+      <display_name>Remove 'bnd' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -121,7 +121,7 @@
     </argument>
     <argument>
       <name>eio</name>
-      <display_name>Remove eio files from run directory</display_name>
+      <display_name>Remove 'eio' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -139,7 +139,7 @@
     </argument>
     <argument>
       <name>shd</name>
-      <display_name>Remove shd files from run directory</display_name>
+      <display_name>Remove 'shd' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -157,7 +157,7 @@
     </argument>
     <argument>
       <name>mdd</name>
-      <display_name>Remove mdd files from run directory</display_name>
+      <display_name>Remove 'mdd' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -175,7 +175,7 @@
     </argument>
     <argument>
       <name>rdd</name>
-      <display_name>Remove rdd files from run directory</display_name>
+      <display_name>Remove 'rdd' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -193,7 +193,7 @@
     </argument>
     <argument>
       <name>csv</name>
-      <display_name>Remove csv files from run directory</display_name>
+      <display_name>Remove 'csv' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -211,7 +211,7 @@
     </argument>
     <argument>
       <name>Sizing Run Directories</name>
-      <display_name>Remove Sizing Run Directories files from run directory</display_name>
+      <display_name>Remove 'Sizing Run Directories' files from run directory</display_name>
       <type>Boolean</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
@@ -247,16 +247,16 @@
   </attributes>
   <files>
     <file>
-      <filename>example_model.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>39B6E26C</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>8696A072</checksum>
     </file>
     <file>
-      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
-      <filetype>epw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>BDF687C1</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>743071F5</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -264,24 +264,6 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>4910D396</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
-    </file>
-    <file>
-      <filename>ServerDirectoryCleanup_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>687ADAF4</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -291,7 +273,25 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>CE714E8E</checksum>
+      <checksum>BBAA09F4</checksum>
+    </file>
+    <file>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BDF687C1</checksum>
+    </file>
+    <file>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>39B6E26C</checksum>
+    </file>
+    <file>
+      <filename>server_directory_cleanup_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>AA55141E</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/SetCOPforSingleSpeedDXCoolingUnits/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/lib/measures/SetCOPforSingleSpeedDXCoolingUnits/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>set_co_pfor_single_speed_dx_cooling_units</name>
   <uid>a4a7297e-8314-4df7-86b5-bec18cdd0a3a</uid>
-  <version_id>669cf3e7-6b07-4bb3-8b03-8d3d7110de08</version_id>
-  <version_modified>20221115T223607Z</version_modified>
+  <version_id>d38c238c-5423-4378-9736-c655b16827c3</version_id>
+  <version_modified>2024-11-16T23:54:17Z</version_modified>
   <xml_checksum>9E2537CD</xml_checksum>
   <class_name>SetCOPforSingleSpeedDXCoolingUnits</class_name>
   <display_name>Set COP for Single Speed DX Cooling Units</display_name>
@@ -17,10 +17,10 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>{3d9c6cf3-bccd-4c66-a172-ac03910e8b07}</default_value>
+      <default_value>{37b886b6-96ce-4c96-931d-092eadc8869e}</default_value>
       <choices>
         <choice>
-          <value>{3d9c6cf3-bccd-4c66-a172-ac03910e8b07}</value>
+          <value>{37b886b6-96ce-4c96-931d-092eadc8869e}</value>
           <display_name>*All Air Loops*</display_name>
         </choice>
       </choices>
@@ -137,16 +137,10 @@
   </attributes>
   <files>
     <file>
-      <filename>0320_ModelWithHVAC_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>049F3417</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>8696A072</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -154,6 +148,12 @@
       <usage_type>readme</usage_type>
       <checksum>61EB7DEE</checksum>
     </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -163,19 +163,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>92FBD7CE</checksum>
+      <checksum>BE5CE2B0</checksum>
     </file>
     <file>
-      <filename>SetCOPforSingleSpeedDXCoolingUnits_Test.rb</filename>
-      <filetype>rb</filetype>
+      <filename>0320_ModelWithHVAC_01.osm</filename>
+      <filetype>osm</filetype>
       <usage_type>test</usage_type>
-      <checksum>22001715</checksum>
+      <checksum>049F3417</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <filename>SetCOPforSingleSpeedDXCoolingUnits_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>F0149C98</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/SetCOPforTwoSpeedDXCoolingUnits/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/lib/measures/SetCOPforTwoSpeedDXCoolingUnits/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>set_co_pfor_two_speed_dx_cooling_units</name>
   <uid>f5a8d60a-e60f-4097-99c3-28bfda3f29a3</uid>
-  <version_id>7090eefa-f84e-412f-b323-ee1f88528f8e</version_id>
-  <version_modified>20221115T223549Z</version_modified>
+  <version_id>dac7b077-cec1-48db-91fc-c0160d474863</version_id>
+  <version_modified>2024-11-16T23:54:10Z</version_modified>
   <xml_checksum>9E2537CD</xml_checksum>
   <class_name>SetCOPforTwoSpeedDXCoolingUnits</class_name>
   <display_name>Set COP for Two Speed DX Cooling Units</display_name>
@@ -17,10 +17,10 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>{daec4601-1d85-44cd-9668-28f8270106f9}</default_value>
+      <default_value>{b7ef4e70-f3b3-422c-a026-f81c42069a40}</default_value>
       <choices>
         <choice>
-          <value>{daec4601-1d85-44cd-9668-28f8270106f9}</value>
+          <value>{b7ef4e70-f3b3-422c-a026-f81c42069a40}</value>
           <display_name>*All Air Loops*</display_name>
         </choice>
       </choices>
@@ -145,16 +145,10 @@
   </attributes>
   <files>
     <file>
-      <filename>0320_ModelWithHVAC_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>049F3417</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>8696A072</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -162,6 +156,12 @@
       <usage_type>readme</usage_type>
       <checksum>185458E4</checksum>
     </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -171,19 +171,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>1BB8ACA4</checksum>
+      <checksum>0B24B1FF</checksum>
     </file>
     <file>
-      <filename>SetCOPforTwoSpeedDXCoolingUnits_Test.rb</filename>
-      <filetype>rb</filetype>
+      <filename>0320_ModelWithHVAC_01.osm</filename>
+      <filetype>osm</filetype>
       <usage_type>test</usage_type>
-      <checksum>3518F4D2</checksum>
+      <checksum>049F3417</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <filename>SetCOPforTwoSpeedDXCoolingUnits_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>6642FD63</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/SetEnergyPlusInfiltrationFlowRatePerFloorArea/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: