openstudio-geb 0.6.0 → 0.7.0

data/lib/measures/add_chilled_water_storage_tank/README.md

@@ -8,7 +8,7 @@
 This measure adds a chilled water storage tank to a chilled water loop for the purpose of thermal energy storage.
 
 ## Modeler Description
-This measure adds a chilled water storage tank and links it to an existing chilled water loop. User can specify the operating season, charge period, discharge period, setpoint temperature and volume of the chilled water tank. If the volume is not provided, a sizing simulation will be run to autosize the tank.
+This measure adds a chilled water storage tank and links it to an existing chilled water loop.
 
 ## Measure Type
 ModelMeasure
@@ -18,103 +18,143 @@ ModelMeasure
 
 ## Arguments
 
-### Tank volume
-Thermal storage chilled water tank volume in m3
+
+### Thermal storage chilled water tank volume in m3
+
 **Name:** tank_vol,
 **Type:** Double,
-**Units:** m3,
+**Units:** ,
 **Required:** false,
 **Model Dependent:** false
 
-### Energy storage objective
-Select from 'Full Storage' and 'Partial Storage'
+### Select Energy Storage Objective:
+
 **Name:** objective,
 **Type:** Choice,
 **Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Chilled water loop
-Select a chilled water loop in the model to connect the tank
+### Select Primary Loop:
+Error: No Cooling Loop Found
 **Name:** selected_primary_loop_name,
 **Type:** Choice,
 **Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+### Primary Loop (charging) Setpoint Temperature degree C:
+
+**Name:** primary_loop_sp,
+**Type:** Double,
+**Units:** ,
 **Required:** true,
-**Model Dependent:** true
+**Model Dependent:** false
+
+### Secondary Loop (discharging) Setpoint Temperature degree C:
+
+**Name:** secondary_loop_sp,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Chilled Water Tank Setpoint Temperature degree C:
 
-### Setpoint temperature
-Chilled water tank setpoint temperature in degree C
 **Name:** tank_charge_sp,
 **Type:** Double,
-**Units:** degree C,
+**Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Loop design delta T
-Loop design temperature difference in degree C; Use 'Use Existing Loop Value' to use the current loop setting
+### Loop Design Temperature Difference degree C:
+Enter numeric value to adjust selected loop settings.
 **Name:** primary_delta_t,
 **Type:** String,
-**Units:** degree C,
+**Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Secondary loop design delta T
-Secondary loop design temperature difference in degree C
+### Secondary Loop Design Temperature Difference degree C
+
 **Name:** secondary_delta_t,
 **Type:** Double,
-**Units:** degree C,
+**Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Available season
-Seasonal Availability of Chilled Water Storage in MM/DD-MM/DD format
-**Name:** thermal_storage_season,
+### Start Date for thermal storage
+In MM-DD format
+**Name:** thermal_storage_startdate,
 **Type:** String,
 **Units:** ,
-**Required:** true,
+**Required:** false,
+**Model Dependent:** false
+
+### End Date for thermal storage
+In MM-DD format
+**Name:** thermal_storage_enddate,
+**Type:** String,
+**Units:** ,
+**Required:** false,
 **Model Dependent:** false
 
-### Discharge start time
-Starting Time for Chilled Water Tank Discharge in HR:mm (24 hour format)
+### Enter Starting Time for Chilled Water Tank Discharge:
+Use 24 hour format (HR:MM)
 **Name:** discharge_start,
 **Type:** String,
 **Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Discharge end time
-Ending Time for Chilled Water Tank Discharge in HR:mm (24 hour format)
+### Enter End Time for Chilled Water Tank Discharge:
+Use 24 hour format (HR:MM)
 **Name:** discharge_end,
 **Type:** String,
 **Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-
-### Charge start time
-Starting Time for Chilled Water Tank Charge in HR:mm (24 hour format)
+### Enter Starting Time for Chilled Water Tank charge:
+Use 24 hour format (HR:MM)
 **Name:** charge_start,
 **Type:** String,
 **Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Charge end time
-Ending Time for Chilled Water Tank Charge in HR:mm (24 hour format)
+### Enter End Time for Chilled Water Tank charge:
+Use 24 hour format (HR:MM)
 **Name:** charge_end,
 **Type:** String,
 **Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
-### Work on weekends?
-Allow Chilled Water Tank Work on Weekends?
+### Allow Chilled Water Tank Work on Weekends
+
 **Name:** wknds,
 **Type:** Boolean,
 **Units:** ,
 **Required:** true,
 **Model Dependent:** false
 
+### Output path for tank sizing run (if tank volume is not provided)
+
+**Name:** run_output_path,
+**Type:** Path,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+### epw file path for tank sizing run (if tank volume is not provided)
+
+**Name:** epw_path,
+**Type:** Path,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
 
 
 

data/lib/measures/add_chilled_water_storage_tank/measure.rb

@@ -559,6 +559,9 @@ class AddChilledWaterStorageTank < OpenStudio::Measure::ModelMeasure
     sim_control.setRunSimulationforSizingPeriods(false)
     sim_control.setRunSimulationforWeatherFileRunPeriods(true)
 
+    # TODO: add IF condition when there is existing secondary loop, just need to add new tank, no need to add pump
+    # TODO: test with large office building
+
     sec_loop = OpenStudio::Model::PlantLoop.new(model)
     sec_loop.setName("Chilled Water Secondary Loop")
     selected_primary_loop.setName("Chilled Water Primary Loop")
@@ -640,6 +643,8 @@ class AddChilledWaterStorageTank < OpenStudio::Measure::ModelMeasure
       end
     end
 
+    # TODO: clone pump from either supply or demand side to secondary loop, update the primary loop pump pressure drop (check online)
+    # TODO: test with medium office
     # move pump from demand component if any to secondary loop
     selected_primary_loop.demandComponents.each do |comp|
       if comp.to_PumpConstantSpeed.is_initialized

data/lib/measures/add_chilled_water_storage_tank/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>add_chilled_water_storage_tank</name>
   <uid>8aafeff8-7798-43ab-8075-9cfe59a611b8</uid>
-  <version_id>762ec571-fcf5-4617-a95a-5aaa2951f61d</version_id>
-  <version_modified>20230719T172112Z</version_modified>
+  <version_id>534953f6-ef6c-4921-92fb-d4396994351e</version_id>
+  <version_modified>2025-06-30T21:09:49Z</version_modified>
   <xml_checksum>6394841D</xml_checksum>
   <class_name>AddChilledWaterStorageTank</class_name>
   <display_name>Add Chilled Water Storage Tank</display_name>
@@ -223,6 +223,18 @@
     </attribute>
   </attributes>
   <files>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>BFFB1AA6</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>107C2731</checksum>
+    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
@@ -235,12 +247,6 @@
       <usage_type>doc</usage_type>
       <checksum>00000000</checksum>
     </file>
-    <file>
-      <filename>example_model.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>53D14E69</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -250,13 +256,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>EFE2DEC1</checksum>
+      <checksum>8E1839DF</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>BFFB1AA6</checksum>
+      <filename>CZ06RV2.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>52282D70</checksum>
     </file>
     <file>
       <filename>add_chilled_water_storage_tank_test.rb</filename>
@@ -265,16 +271,10 @@
       <checksum>AC813F36</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>107C2731</checksum>
-    </file>
-    <file>
-      <filename>CZ06RV2.epw</filename>
-      <filetype>epw</filetype>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
       <usage_type>test</usage_type>
-      <checksum>52282D70</checksum>
+      <checksum>53D14E69</checksum>
     </file>
     <file>
       <filename>restaurant.osm</filename>