dragonfly-energy 1.35.20__tar.gz → 1.35.67__tar.gz

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dragonfly-energy
-Version: 1.35.20
+Version: 1.35.67
 Summary: Dragonfly extension for energy simulation.
 Home-page: https://github.com/ladybug-tools/dragonfly-energy
 Author: Ladybug Tools
@@ -18,8 +18,8 @@ Classifier: Programming Language :: Python :: Implementation :: IronPython
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dragonfly-core==1.70.3
-Requires-Dist: honeybee-energy==1.116.81
+Requires-Dist: dragonfly-core==1.74.21
+Requires-Dist: honeybee-energy==1.116.102
 Provides-Extra: standards
 Requires-Dist: honeybee-energy-standards==2.2.6; extra == "standards"
 Provides-Extra: openstudio

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy/cli/simulate.py

@@ -24,60 +24,92 @@ def simulate():
 
 
 @simulate.command('model')
-@click.argument('model-json', type=click.Path(
-    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
-@click.argument('epw-file', type=click.Path(
-    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'model-json',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.argument(
+    'epw-file',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
+)
 @click.option(
     '--sim-par-json', '-sp', help='Full path to a honeybee energy '
     'SimulationParameter JSON that describes all of the settings for '
     'the simulation.', default=None, show_default=True,
-    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True))
-@click.option('--obj-per-model', '-o', help='Text to describe how the input Model '
-              'should be divided across the output Models. Choose from: District, '
-              'Building, Story.', type=str, default="Building", show_default=True)
-@click.option('--multiplier/--full-geometry', ' /-fg', help='Flag to note if the '
-              'multipliers on each Building story will be passed along to the '
-              'generated Honeybee Room objects or if full geometry objects should be '
-              'written for each story in the building.', default=True, show_default=True)
-@click.option('--plenum/--no-plenum', '-p/-np', help='Flag to indicate whether '
-              'ceiling/floor plenum depths assigned to Room2Ds should generate '
-              'distinct 3D Rooms in the translation.', default=True, show_default=True)
-@click.option('--no-cap/--cap', ' /-c', help='Flag to indicate whether context shade '
-              'buildings should be capped with a top face.',
-              default=True, show_default=True)
-@click.option('--shade-dist', '-sd', help='An optional number to note the distance '
-              'beyond which other buildings shade should not be exported into a given '
-              'Model. If None, all other buildings will be included as context shade in '
-              'each and every Model. Set to 0 to exclude all neighboring buildings '
-              'from the resulting models.', type=float, default=None, show_default=True)
-@click.option('--no-ceil-adjacency/--ceil-adjacency', ' /-a', help='Flag to indicate '
-              'whether adjacencies should be solved between interior stories when '
-              'Room2Ds perfectly match one another in their floor plate. This ensures '
-              'that Surface boundary conditions are used instead of Adiabatic ones. '
-              'Note that this input has no effect when the object-per-model is Story.',
-              default=True, show_default=True)
-@click.option('--measures', '-m', help='Full path to a folder containing an OSW JSON '
-              'be used as the base for the execution of the OpenStudio CLI. While this '
-              'OSW can contain paths to measures that exist anywhere on the machine, '
-              'the best practice is to copy the measures into this measures '
-              'folder and use relative paths within the OSW. '
-              'This makes it easier to move the inputs for this command from one '
-              'machine to another.', default=None, show_default=True,
-              type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
-@click.option('--folder', '-f', help='Folder on this computer, into which the IDF '
-              'and result files will be written. If None, the files will be output '
-              'to the honeybee default simulation folder and placed in a project '
-              'folder with the same name as the model json.',
-              default=None, show_default=True,
-              type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
-@click.option('--log-file', '-log', help='Optional log file to output a dictionary '
-              'with the paths of the generated files under the following keys: '
-              'osm, idf, sql. By default the list will be printed out to stdout',
-              type=click.File('w'), default='-', show_default=True)
-def simulate_model(model_json, epw_file, sim_par_json, obj_per_model, multiplier,
-                   plenum, no_cap, shade_dist, no_ceil_adjacency,
-                   measures, folder, log_file):
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--obj-per-model', '-o', help='Text to describe how the input Model '
+    'should be divided across the output Models. Choose from: District, '
+    'Building, Story.', type=str, default="Building", show_default=True
+)
+@click.option(
+    '--multiplier/--full-geometry', ' /-fg', help='Flag to note if the '
+    'multipliers on each Building story will be passed along to the '
+    'generated Honeybee Room objects or if full geometry objects should be '
+    'written for each story in the building.', default=True, show_default=True
+)
+@click.option(
+    '--plenum/--no-plenum', '-p/-np', help='Flag to indicate whether '
+    'ceiling/floor plenum depths assigned to Room2Ds should generate '
+    'distinct 3D Rooms in the translation.', default=True, show_default=True
+)
+@click.option(
+    '--no-cap/--cap', ' /-c', help='Flag to indicate whether context shade '
+    'buildings should be capped with a top face.', default=True, show_default=True
+)
+@click.option(
+    '--shade-dist', '-sd', help='An optional number to note the distance '
+    'beyond which other buildings shade should not be exported into a given '
+    'Model. If None, all other buildings will be included as context shade in '
+    'each and every Model. Set to 0 to exclude all neighboring buildings '
+    'from the resulting models.', type=float, default=None, show_default=True
+)
+@click.option(
+    '--no-ceil-adjacency/--ceil-adjacency', ' /-a', help='Flag to indicate '
+    'whether adjacencies should be solved between interior stories when '
+    'Room2Ds perfectly match one another in their floor plate. This ensures '
+    'that Surface boundary conditions are used instead of Adiabatic ones. '
+    'Note that this input has no effect when the object-per-model is Story.',
+    default=True, show_default=True
+)
+@click.option(
+    '--merge-method', '-m', help='Text to describe how the Room2Ds should '
+    'be merged into individual Rooms during the translation. Specifying a '
+    'value here can be an effective way to reduce the number of Room '
+    'volumes in the resulting Model and, ultimately, yield a faster simulation '
+    'time with less results to manage. Choose from: None, Zones, PlenumZones, '
+    'Stories, PlenumStories.', type=str, default='None', show_default=True
+)
+@click.option(
+    '--measures', '-m', help='Full path to a folder containing an OSW JSON '
+    'be used as the base for the execution of the OpenStudio CLI. While this '
+    'OSW can contain paths to measures that exist anywhere on the machine, '
+    'the best practice is to copy the measures into this measures '
+    'folder and use relative paths within the OSW. '
+    'This makes it easier to move the inputs for this command from one '
+    'machine to another.', default=None, show_default=True,
+    type=click.Path(file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--folder', '-f', help='Folder on this computer, into which the IDF '
+    'and result files will be written. If None, the files will be output '
+    'to the honeybee default simulation folder and placed in a project '
+    'folder with the same name as the model json.',
+    default=None, show_default=True,
+    type=click.Path(file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--log-file', '-log', help='Optional log file to output a dictionary '
+    'with the paths of the generated files under the following keys: '
+    'osm, idf, sql. By default the list will be printed out to stdout',
+    type=click.File('w'), default='-', show_default=True
+)
+def simulate_model(
+    model_json, epw_file, sim_par_json, obj_per_model, multiplier,
+    plenum, no_cap, shade_dist, no_ceil_adjacency, merge_method,
+    measures, folder, log_file
+):
     """Simulate a Dragonfly Model JSON file in EnergyPlus.
 
     \b
@@ -160,7 +192,10 @@ def simulate_model(model_json, epw_file, sim_par_json, obj_per_model, multiplier
         cap = not no_cap
         ceil_adjacency = not no_ceil_adjacency
         hb_models = model.to_honeybee(
-            obj_per_model, shade_dist, multiplier, no_plenum, cap, ceil_adjacency)
+            obj_per_model, shade_dist, use_multiplier=multiplier,
+            exclude_plenums=no_plenum, cap=cap,
+            solve_ceiling_adjacencies=ceil_adjacency, merge_method=merge_method
+        )
 
         # write out the honeybee JSONs
         osms = []

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy/cli/translate.py

@@ -54,6 +54,12 @@ def translate():
               'that Surface boundary conditions are used instead of Adiabatic ones. '
               'Note that this input has no effect when the object-per-model is Story.',
               default=True, show_default=True)
+@click.option('--merge-method', '-m', help='Text to describe how the Room2Ds should '
+              'be merged into individual Rooms during the translation. Specifying a '
+              'value here can be an effective way to reduce the number of Room '
+              'volumes in the resulting Model and, ultimately, yield a faster simulation '
+              'time with less results to manage. Choose from: None, Zones, PlenumZones, '
+              'Stories, PlenumStories.', type=str, default='None', show_default=True)
 @click.option('--folder', '-f', help='Deprecated input that is no longer used.',
               default=None, show_default=True,
               type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
@@ -87,8 +93,10 @@ def translate():
               'By default this will be printed out to stdout',
               type=click.File('w'), default='-', show_default=True)
 def model_to_osm_cli(
-        model_file, sim_par_json, epw_file, multiplier, plenum, no_ceil_adjacency,
-        folder, osm_file, idf_file, geometry_ids, resource_ids, log_file):
+    model_file, sim_par_json, epw_file,
+    multiplier, plenum, no_ceil_adjacency, merge_method,
+    folder, osm_file, idf_file, geometry_ids, resource_ids, log_file
+):
     """Translate a Dragonfly Model to an OpenStudio Model.
 
     \b
@@ -103,8 +111,10 @@ def model_to_osm_cli(
         geo_names = not geometry_ids
         res_names = not resource_ids
         model_to_osm(
-            model_file, sim_par_json, epw_file, full_geometry, no_plenum, ceil_adjacency,
-            folder, osm_file, idf_file, geo_names, res_names, log_file)
+            model_file, sim_par_json, epw_file,
+            full_geometry, no_plenum, ceil_adjacency, merge_method,
+            folder, osm_file, idf_file, geo_names, res_names, log_file
+        )
     except Exception as e:
         _logger.exception('Model translation failed.\n{}'.format(e))
         sys.exit(1)
@@ -114,7 +124,7 @@ def model_to_osm_cli(
 
 def model_to_osm(
     model_file, sim_par_json=None, epw_file=None,
-    full_geometry=False, no_plenum=False, ceil_adjacency=False,
+    full_geometry=False, no_plenum=False, ceil_adjacency=False, merge_method='None',
     folder=None, osm_file=None, idf_file=None,
     geometry_names=False, resource_names=False, log_file=None,
     multiplier=True, plenum=True, no_ceil_adjacency=True,
@@ -145,6 +155,21 @@ def model_to_osm(
             in their floor plate. This ensures that Surface boundary conditions
             are used instead of Adiabatic ones. Note that this input has no
             effect when the object-per-model is Story. (Default: False).
+        merge_method: An optional text string to describe how the Room2Ds should
+            be merged into individual Rooms during the translation. Specifying a
+            value here can be an effective way to reduce the number of Room
+            volumes in the resulting Model and, ultimately, yield a faster simulation
+            time with less results to manage. Note that Room2Ds will only be merged if
+            they form a contiguous volume. Otherwise, there will be multiple Rooms per
+            zone or story, each with an integer added at the end of their
+            identifiers. Choose from the following options:
+
+            * None - No merging will occur
+            * Zones - Room2Ds in the same zone will be merged
+            * PlenumZones - Only plenums in the same zone will be merged
+            * Stories - Rooms in the same story will be merged
+            * PlenumStories - Only plenums in the same story will be merged
+
         folder: Deprecated input that is no longer used.
         osm_file: Optional path where the OSM will be copied after it is translated
             in the folder. If None, the file will not be copied.
@@ -238,7 +263,8 @@ def model_to_osm(
     hb_models = model.to_honeybee(
         object_per_model='District', use_multiplier=multiplier,
         exclude_plenums=no_plenum, solve_ceiling_adjacencies=ceil_adjacency,
-        enforce_adj=False)
+        merge_method=merge_method, enforce_adj=False
+    )
     hb_model = hb_models[0]
 
     # create the HBJSON for input to OpenStudio CLI
@@ -286,6 +312,12 @@ def model_to_osm(
               'that Surface boundary conditions are used instead of Adiabatic ones. '
               'Note that this input has no effect when the object-per-model is Story.',
               default=True, show_default=True)
+@click.option('--merge-method', '-m', help='Text to describe how the Room2Ds should '
+              'be merged into individual Rooms during the translation. Specifying a '
+              'value here can be an effective way to reduce the number of Room '
+              'volumes in the resulting Model and, ultimately, yield a faster simulation '
+              'time with less results to manage. Choose from: None, Zones, PlenumZones, '
+              'Stories, PlenumStories.', type=str, default='None', show_default=True)
 @click.option('--additional-str', '-a', help='Text string for additional lines that '
               'should be added to the IDF.', type=str, default='', show_default=True)
 @click.option('--compact-schedules/--csv-schedules', ' /-c', help='Flag to note '
@@ -320,7 +352,7 @@ def model_to_osm(
               'of the translation. By default this will be printed out to stdout',
               type=click.File('w'), default='-', show_default=True)
 def model_to_idf_cli(
-    model_file, sim_par_json, multiplier, plenum, no_ceil_adjacency,
+    model_file, sim_par_json, multiplier, plenum, no_ceil_adjacency, merge_method,
     additional_str, compact_schedules, hvac_to_ideal_air,
     geometry_ids, resource_ids, output_file
 ):
@@ -344,7 +376,7 @@ def model_to_idf_cli(
         res_names = not resource_ids
         model_to_idf(
             model_file, sim_par_json, full_geometry, no_plenum, ceil_adjacency,
-            additional_str, csv_schedules,
+            merge_method, additional_str, csv_schedules,
             hvac_check, geo_names, res_names, output_file)
     except Exception as e:
         _logger.exception('Model translation failed.\n{}\n'.format(e))
@@ -355,7 +387,7 @@ def model_to_idf_cli(
 
 def model_to_idf(
     model_file, sim_par_json=None,
-    full_geometry=False, no_plenum=False, ceil_adjacency=False,
+    full_geometry=False, no_plenum=False, ceil_adjacency=False, merge_method='None',
     additional_str='', csv_schedules=False, hvac_check=False,
     geometry_names=False, resource_names=False, output_file=None,
     multiplier=True, plenum=True, no_ceil_adjacency=True,
@@ -384,6 +416,21 @@ def model_to_idf(
             in their floor plate. This ensures that Surface boundary conditions
             are used instead of Adiabatic ones. Note that this input has no
             effect when the object-per-model is Story. (Default: False).
+        merge_method: An optional text string to describe how the Room2Ds should
+            be merged into individual Rooms during the translation. Specifying a
+            value here can be an effective way to reduce the number of Room
+            volumes in the resulting Model and, ultimately, yield a faster simulation
+            time with less results to manage. Note that Room2Ds will only be merged if
+            they form a contiguous volume. Otherwise, there will be multiple Rooms per
+            zone or story, each with an integer added at the end of their
+            identifiers. Choose from the following options:
+
+            * None - No merging will occur
+            * Zones - Room2Ds in the same zone will be merged
+            * PlenumZones - Only plenums in the same zone will be merged
+            * Stories - Rooms in the same story will be merged
+            * PlenumStories - Only plenums in the same story will be merged
+
         additional_str: Text string for additional lines that should be added
             to the IDF.
         csv_schedules: Boolean to note whether any ScheduleFixedIntervals in the
@@ -435,7 +482,8 @@ def model_to_idf(
     hb_models = model.to_honeybee(
         object_per_model='District', use_multiplier=multiplier,
         exclude_plenums=no_plenum, solve_ceiling_adjacencies=ceil_adjacency,
-        enforce_adj=False)
+        merge_method=merge_method, enforce_adj=False
+    )
     hb_model = hb_models[0]
 
     # reset the IDs to be derived from the display_names if requested
@@ -481,6 +529,12 @@ def model_to_idf(
               'that Surface boundary conditions are used instead of Adiabatic ones. '
               'Note that this input has no effect when the object-per-model is Story.',
               default=True, show_default=True)
+@click.option('--merge-method', '-m', help='Text to describe how the Room2Ds should '
+              'be merged into individual Rooms during the translation. Specifying a '
+              'value here can be an effective way to reduce the number of Room '
+              'volumes in the resulting Model and, ultimately, yield a faster simulation '
+              'time with less results to manage. Choose from: None, Zones, PlenumZones, '
+              'Stories, PlenumStories.', type=str, default='None', show_default=True)
 @click.option('--osw-folder', '-osw', help='Deprecated input that is no longer used.',
               default=None,
               type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
@@ -524,7 +578,7 @@ def model_to_idf(
               'of the translation. By default it printed out to stdout', default='-',
               type=click.Path(file_okay=True, dir_okay=False, resolve_path=True))
 def model_to_gbxml_cli(
-    model_file, multiplier, plenum, no_ceil_adjacency,
+    model_file, multiplier, plenum, no_ceil_adjacency, merge_method,
     osw_folder, default_subfaces, triangulate_non_planar, minimal,
     interior_face_type, ground_face_type, program_name, program_version, output_file
 ):
@@ -543,7 +597,7 @@ def model_to_gbxml_cli(
         permit_non_planar = not triangulate_non_planar
         complete_geometry = not minimal
         model_to_gbxml(
-            model_file, osw_folder, full_geometry, no_plenum, ceil_adjacency,
+            model_file, osw_folder, full_geometry, no_plenum, ceil_adjacency, merge_method,
             triangulate_subfaces, permit_non_planar, complete_geometry,
             interior_face_type, ground_face_type, program_name, program_version,
             output_file)
@@ -556,7 +610,7 @@ def model_to_gbxml_cli(
 
 def model_to_gbxml(
     model_file, osw_folder=None, full_geometry=False,
-    no_plenum=False, ceil_adjacency=False,
+    no_plenum=False, ceil_adjacency=False, merge_method='None',
     triangulate_subfaces=False, permit_non_planar=False, complete_geometry=False,
     interior_face_type='', ground_face_type='',
     program_name=None, program_version=None, output_file=None,
@@ -581,6 +635,21 @@ def model_to_gbxml(
             in their floor plate. This ensures that Surface boundary conditions
             are used instead of Adiabatic ones. Note that this input has no
             effect when the object-per-model is Story. (Default: False).
+        merge_method: An optional text string to describe how the Room2Ds should
+            be merged into individual Rooms during the translation. Specifying a
+            value here can be an effective way to reduce the number of Room
+            volumes in the resulting Model and, ultimately, yield a faster simulation
+            time with less results to manage. Note that Room2Ds will only be merged if
+            they form a contiguous volume. Otherwise, there will be multiple Rooms per
+            zone or story, each with an integer added at the end of their
+            identifiers. Choose from the following options:
+
+            * None - No merging will occur
+            * Zones - Room2Ds in the same zone will be merged
+            * PlenumZones - Only plenums in the same zone will be merged
+            * Stories - Rooms in the same story will be merged
+            * PlenumStories - Only plenums in the same story will be merged
+
         triangulate_subfaces: Boolean to note whether sub-faces (including
             Apertures and Doors) should be triangulated if they have more
             than 4 sides (True) or whether they should be left as they are (False).
@@ -632,7 +701,7 @@ def model_to_gbxml(
     hb_models = model.to_honeybee(
         object_per_model='District', use_multiplier=multiplier,
         exclude_plenums=no_plenum, solve_ceiling_adjacencies=ceil_adjacency,
-        enforce_adj=False)
+        merge_method=merge_method, enforce_adj=False)
     hb_model = hb_models[0]
 
     # translate the model to a gbXML string
@@ -664,6 +733,12 @@ def model_to_gbxml(
               'that Surface boundary conditions are used instead of Adiabatic ones. '
               'Note that this input has no effect when the object-per-model is Story.',
               default=True, show_default=True)
+@click.option('--merge-method', '-m', help='Text to describe how the Room2Ds should '
+              'be merged into individual Rooms during the translation. Specifying a '
+              'value here can be an effective way to reduce the number of Room '
+              'volumes in the resulting Model and, ultimately, yield a faster simulation '
+              'time with less results to manage. Choose from: None, Zones, PlenumZones, '
+              'Stories, PlenumStories.', type=str, default='None', show_default=True)
 @click.option('--single-window/--detailed-windows', ' /-dw', help='Flag to note '
               'whether all windows within walls should be converted to a single '
               'window with an area that matches the original geometry.',
@@ -702,7 +777,7 @@ def model_to_gbxml(
               'of the translation. By default it printed out to stdout.', default='-',
               type=click.Path(file_okay=True, dir_okay=False, resolve_path=True))
 def model_to_trace_gbxml_cli(
-    model_file, multiplier, plenum, no_ceil_adjacency,
+    model_file, multiplier, plenum, no_ceil_adjacency, merge_method,
     single_window, rect_sub_distance, frame_merge_distance,
     program_name, program_version, osw_folder, output_file
 ):
@@ -719,8 +794,8 @@ def model_to_trace_gbxml_cli(
         ceil_adjacency = not no_ceil_adjacency
         detailed_windows = not single_window
         model_to_trace_gbxml(
-            model_file, full_geometry, no_plenum, ceil_adjacency, detailed_windows,
-            rect_sub_distance, frame_merge_distance, osw_folder,
+            model_file, full_geometry, no_plenum, ceil_adjacency, merge_method,
+            detailed_windows, rect_sub_distance, frame_merge_distance, osw_folder,
             program_name, program_version, output_file)
     except Exception as e:
         _logger.exception('Model translation failed.\n{}'.format(e))
@@ -730,7 +805,8 @@ def model_to_trace_gbxml_cli(
 
 
 def model_to_trace_gbxml(
-    model_file, full_geometry=False, no_plenum=False, ceil_adjacency=False,
+    model_file, full_geometry=False,
+    no_plenum=False, ceil_adjacency=False, merge_method='None',
     detailed_windows=False, rect_sub_distance='0.15m', frame_merge_distance='0.2m',
     program_name=None, program_version=None, osw_folder=None, output_file=None,
     multiplier=True, plenum=True, no_ceil_adjacency=True, single_window=True
@@ -752,6 +828,21 @@ def model_to_trace_gbxml(
             in their floor plate. This ensures that Surface boundary conditions
             are used instead of Adiabatic ones. Note that this input has no
             effect when the object-per-model is Story. (Default: False).
+        merge_method: An optional text string to describe how the Room2Ds should
+            be merged into individual Rooms during the translation. Specifying a
+            value here can be an effective way to reduce the number of Room
+            volumes in the resulting Model and, ultimately, yield a faster simulation
+            time with less results to manage. Note that Room2Ds will only be merged if
+            they form a contiguous volume. Otherwise, there will be multiple Rooms per
+            zone or story, each with an integer added at the end of their
+            identifiers. Choose from the following options:
+
+            * None - No merging will occur
+            * Zones - Room2Ds in the same zone will be merged
+            * PlenumZones - Only plenums in the same zone will be merged
+            * Stories - Rooms in the same story will be merged
+            * PlenumStories - Only plenums in the same story will be merged
+
         detailed_windows: A boolean for whether all windows within walls should be
             left as they are (True) or converted to a single window with an area
             that matches the original geometry (False). (Default: False).
@@ -799,7 +890,7 @@ def model_to_trace_gbxml(
     hb_models = model.to_honeybee(
         object_per_model='District', use_multiplier=multiplier,
         exclude_plenums=no_plenum, solve_ceiling_adjacencies=ceil_adjacency,
-        enforce_adj=False)
+        merge_method=merge_method, enforce_adj=False)
     hb_model = hb_models[0]
 
     # translate the honeybee model to a TRACE-compatible gbXML string
@@ -831,6 +922,12 @@ def model_to_trace_gbxml(
               'that Surface boundary conditions are used instead of Adiabatic ones. '
               'Note that this input has no effect when the object-per-model is Story.',
               default=True, show_default=True)
+@click.option('--merge-method', '-m', help='Text to describe how the Room2Ds should '
+              'be merged into individual Rooms during the translation. Specifying a '
+              'value here can be an effective way to reduce the number of Room '
+              'volumes in the resulting Model and, ultimately, yield a faster simulation '
+              'time with less results to manage. Choose from: None, Zones, PlenumZones, '
+              'Stories, PlenumStories.', type=str, default='None', show_default=True)
 @click.option('--osw-folder', '-osw', help='Deprecated input that is no longer used.',
               default=None,
               type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
@@ -856,8 +953,8 @@ def model_to_trace_gbxml(
               'of the translation. By default it printed out to stdout', default='-',
               type=click.Path(file_okay=True, dir_okay=False, resolve_path=True))
 def model_to_sdd_cli(
-    model_file, multiplier, plenum, no_ceil_adjacency, osw_folder,
-    geometry_ids, resource_ids, output_file
+    model_file, multiplier, plenum, no_ceil_adjacency, merge_method,
+    osw_folder, geometry_ids, resource_ids, output_file
 ):
     """Translate a Dragonfly Model to a CBECC SDD file.
 
@@ -873,7 +970,7 @@ def model_to_sdd_cli(
         geo_names = not geometry_ids
         res_names = not resource_ids
         model_to_sdd(
-            model_file, full_geometry, no_plenum, ceil_adjacency,
+            model_file, full_geometry, no_plenum, ceil_adjacency, merge_method,
             osw_folder, geo_names, res_names, output_file)
     except Exception as e:
         _logger.exception('Model translation failed.\n{}'.format(e))
@@ -883,7 +980,8 @@ def model_to_sdd_cli(
 
 
 def model_to_sdd(
-    model_file, full_geometry=False, no_plenum=False, ceil_adjacency=False,
+    model_file, full_geometry=False,
+    no_plenum=False, ceil_adjacency=False, merge_method='None',
     osw_folder=None, geometry_names=False, resource_names=False, output_file=None,
     multiplier=True, plenum=True, no_ceil_adjacency=True,
     geometry_ids=True, resource_ids=True
@@ -905,6 +1003,21 @@ def model_to_sdd(
             in their floor plate. This ensures that Surface boundary conditions
             are used instead of Adiabatic ones. Note that this input has no
             effect when the object-per-model is Story. (Default: False).
+        merge_method: An optional text string to describe how the Room2Ds should
+            be merged into individual Rooms during the translation. Specifying a
+            value here can be an effective way to reduce the number of Room
+            volumes in the resulting Model and, ultimately, yield a faster simulation
+            time with less results to manage. Note that Room2Ds will only be merged if
+            they form a contiguous volume. Otherwise, there will be multiple Rooms per
+            zone or story, each with an integer added at the end of their
+            identifiers. Choose from the following options:
+
+            * None - No merging will occur
+            * Zones - Room2Ds in the same zone will be merged
+            * PlenumZones - Only plenums in the same zone will be merged
+            * Stories - Rooms in the same story will be merged
+            * PlenumStories - Only plenums in the same story will be merged
+
         osw_folder: Deprecated input that is no longer used.
         geometry_names: Boolean to note whether a cleaned version of all geometry
             display names should be used instead of identifiers when translating

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy/des/loop.py

@@ -798,7 +798,7 @@ class GHEThermalLoop(object):
         # add the fifth generation system parameters
         des_param = {
             'fifth_generation': {
-                'ghe_parameters': self.to_ghe_param_dict(tolerance),
+                'ghe_parameters': self.to_ghe_param_dict(),
                 'central_pump_parameters': pump_par,
                 'horizontal_piping_parameters': horiz_par,
                 'soil': soil_par
@@ -809,11 +809,6 @@ class GHEThermalLoop(object):
 
     def to_ghe_param_dict(self, tolerance=0.01):
         """Get the GroundHeatExchanger as it appears in a System Parameter dictionary.
-
-        Args:
-            tolerance: The minimum difference between the coordinate values of two
-                geometries at which they are considered co-located. (Default: 0.01,
-                suitable for objects in meters).
         """
         # compute the geometric constraints of the borehole fields
         geo_pars = []
@@ -825,9 +820,7 @@ class GHEThermalLoop(object):
                     'b_max_x': self.borehole_parameters.max_spacing,
                     'b_max_y': self.borehole_parameters.max_spacing,
                     'max_height': self.borehole_parameters.max_depth,
-                    'min_height': self.borehole_parameters.min_depth,
-                    'property_boundary': [],  # TODO: remove when GMT is better
-                    'no_go_boundaries': []  # TODO: remove when GMT is better
+                    'min_height': self.borehole_parameters.min_depth
                 }
             }
             geo_pars.append(geo_par)

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy/run.py

@@ -213,7 +213,9 @@ def base_honeybee_osw(
                         json.dump(geo_dict, fp, indent=4)
 
             # if the DES system is GSHP, specify any autocalculated ground temperatures
-            dead_band = 8  # minimum annual delta T of the ground GHEDesigner needs
+            msg_template = 'Autocalculated EPW ground temperature in this climate is ' \
+                '{}C, which is too {} for a {} EFT of {}C. {} EFT is being reset to {}.'
+            dead_band = 12  # minimum annual delta T of the ground GHEDesigner needs
             with open(sys_param_file, 'r') as spf:
                 sys_dict = json.load(spf)
             if 'district_system' in sys_dict:
@@ -230,11 +232,27 @@ def base_honeybee_osw(
                                 if 'min_eft' in design and \
                                         design['min_eft'] + dead_band > start_temp:
                                     # ground is too cold
-                                    start_temp = design['min_eft'] + dead_band
+                                    new_min_eft = round(start_temp - dead_band)
+                                    if new_min_eft < -6.67:  # just too cold
+                                        new_min_eft = -6.67
+                                    msg = msg_template.format(
+                                        start_temp, 'cold', 'min', design['min_eft'],
+                                        'Min', new_min_eft)
+                                    print(msg)
+                                    design['min_eft'] = new_min_eft
+                                    # set fluid to ensure it does not freeze
+                                    fluid = g5_par['ghe_parameters']['fluid']
+                                    fluid['fluid_name'] = 'PropyleneGlycol'
+                                    fluid['concentration_percent'] = 25
                                 elif 'max_eft' in design and \
                                         design['max_eft'] - dead_band < start_temp:
                                     # ground is too hot
-                                    start_temp = design['max_eft'] - dead_band
+                                    new_max_eft = round(start_temp + dead_band)
+                                    msg = msg_template.format(
+                                        start_temp, 'hot', 'max', design['max_eft'],
+                                        'Max', new_max_eft)
+                                    print(msg)
+                                    design['max_eft'] = new_max_eft
                             soil_par['undisturbed_temp'] = start_temp
                             with open(sys_param_file, 'w') as fp:
                                 json.dump(sys_dict, fp, indent=4)

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy/writer.py

@@ -15,7 +15,7 @@ from honeybee.model import Model as hb_model
 
 def model_to_urbanopt(
     model, location, point=Point2D(0, 0), shade_distance=None, use_multiplier=True,
-    exclude_plenums=False, solve_ceiling_adjacencies=False,
+    exclude_plenums=False, solve_ceiling_adjacencies=False, merge_method='None',
     des_loop=None, electrical_network=None, road_network=None, ground_pv=None,
     folder=None, tolerance=None
 ):
@@ -51,6 +51,22 @@ def model_to_urbanopt(
             another in their floor plate. This ensures that Surface boundary
             conditions are used instead of Adiabatic ones. Note that this input
             has no effect when the object_per_model is Story. (Default: False).
+        merge_method: An optional text string to describe how the Room2Ds should
+            be merged into individual Rooms during the translation. Specifying a
+            value here can be an effective way to reduce the number of Room
+            volumes in the resulting 3D Honeybee Model and, ultimately, yield
+            a faster simulation time in the destination engine with fewer results
+            to manage. Note that Room2Ds will only be merged if they form a
+            continuous volume. Otherwise, there will be multiple Rooms per
+            zone or story, each with an integer added at the end of their
+            identifiers. Choose from the following options:
+
+            * None - No merging of Room2Ds will occur
+            * Zones - Room2Ds in the same zone will be merged
+            * PlenumZones - Only plenums in the same zone will be merged
+            * Stories - Rooms in the same story will be merged
+            * PlenumStories - Only plenums in the same story will be merged
+
         des_loop: An optional District Energy System (DES) ThermalLoop that's
             associated with the dragonfly Model. (Default: None).
         electrical_network: An optional OpenDSS ElectricalNetwork that's associated
@@ -202,7 +218,9 @@ def model_to_urbanopt(
     hb_model_jsons = []
     hb_models = model.to_honeybee(
         'Building', shade_distance, use_multiplier, exclude_plenums,
-        solve_ceiling_adjacencies=solve_ceiling_adjacencies, tolerance=tolerance)
+        solve_ceiling_adjacencies=solve_ceiling_adjacencies, merge_method=merge_method,
+        tolerance=tolerance
+    )
     for bldg_model in hb_models:
         try:
             bldg_model.remove_degenerate_geometry(0.01)
@@ -353,6 +371,9 @@ def model_to_des(
             geojson_dict['project']['weather_filename'] = epw_f_name
 
     # if the DES system is GSHP, specify any autocalculated ground temperatures
+    msg_template = 'Autocalculated EPW ground temperature in this climate is ' \
+        '{}C, which is too {} for a {} EFT of {}C. {} EFT is being reset to {}.'
+    dead_band = 12  # minimum annual delta T of the ground GHEDesigner needs
     if 'district_system' in des_dict:
         if 'fifth_generation' in des_dict['district_system']:
             g5_par = des_dict['district_system']['fifth_generation']
@@ -360,8 +381,35 @@ def model_to_des(
                 soil_par = g5_par['soil']
                 if soil_par['undisturbed_temp'] == 'Autocalculate':
                     epw_obj = EPW(epw_file)
-                    soil_par['undisturbed_temp'] = \
-                        epw_obj.dry_bulb_temperature.average
+                    start_temp = epw_obj.dry_bulb_temperature.average
+                    if 'ghe_parameters' in g5_par and \
+                            'design' in g5_par['ghe_parameters']:
+                        design = g5_par['ghe_parameters']['design']
+                        if 'min_eft' in design and \
+                                design['min_eft'] + dead_band > start_temp:
+                            # ground is too cold
+                            new_min_eft = round(start_temp - dead_band)
+                            if new_min_eft < -6.67:  # just too cold
+                                new_min_eft = -6.67
+                            msg = msg_template.format(
+                                start_temp, 'cold', 'min', design['min_eft'],
+                                'Min', new_min_eft)
+                            print(msg)
+                            design['min_eft'] = new_min_eft
+                            # set fluid to ensure it does not freeze
+                            fluid = g5_par['ghe_parameters']['fluid']
+                            fluid['fluid_name'] = 'PropyleneGlycol'
+                            fluid['concentration_percent'] = 25
+                        elif 'max_eft' in design and \
+                                design['max_eft'] - dead_band < start_temp:
+                            # ground is too hot
+                            new_max_eft = round(start_temp + dead_band)
+                            msg = msg_template.format(
+                                start_temp, 'hot', 'max', design['max_eft'],
+                                'Max', new_max_eft)
+                            print(msg)
+                            design['max_eft'] = new_max_eft
+                    soil_par['undisturbed_temp'] = start_temp
 
     # write out the GeoJSON and system parameter files
     feature_geojson = os.path.join(folder, '{}.geojson'.format(model.identifier))

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dragonfly-energy
-Version: 1.35.20
+Version: 1.35.67
 Summary: Dragonfly extension for energy simulation.
 Home-page: https://github.com/ladybug-tools/dragonfly-energy
 Author: Ladybug Tools
@@ -18,8 +18,8 @@ Classifier: Programming Language :: Python :: Implementation :: IronPython
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: dragonfly-core==1.70.3
-Requires-Dist: honeybee-energy==1.116.81
+Requires-Dist: dragonfly-core==1.74.21
+Requires-Dist: honeybee-energy==1.116.102
 Provides-Extra: standards
 Requires-Dist: honeybee-energy-standards==2.2.6; extra == "standards"
 Provides-Extra: openstudio

{dragonfly_energy-1.35.20 → dragonfly_energy-1.35.67}/dragonfly_energy.egg-info/requires.txt

@@ -1,5 +1,5 @@
-dragonfly-core==1.70.3
-honeybee-energy==1.116.81
+dragonfly-core==1.74.21
+honeybee-energy==1.116.102
 
 [openstudio]
 honeybee-openstudio>=0.3.14

dragonfly_energy-1.35.67/requirements.txt

@@ -0,0 +1,2 @@
+dragonfly-core==1.74.21
+honeybee-energy==1.116.102

dragonfly_energy-1.35.20/requirements.txt

@@ -1,2 +0,0 @@
-dragonfly-core==1.70.3
-honeybee-energy==1.116.81