dragonfly-doe2 0.12.10__py3-none-any.whl → 0.12.11__py3-none-any.whl

dragonfly_doe2/cli/translate.py

@@ -37,6 +37,13 @@ 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(
     '--sim-par-json', '-sp', help='Full path to a honeybee-doe2 SimulationPar '
     'JSON that describes all of the settings for the simulation. If unspecified, '
@@ -67,8 +74,9 @@ def translate():
     'of the translation. By default this will be printed out to stdout.',
     type=click.File('w'), default='-', show_default=True)
 def model_to_inp_cli(
-    model_file, multiplier, plenum, ceil_adjacency, sim_par_json, hvac_mapping,
-    include_interior_walls, include_interior_ceilings, equest_version, output_file
+    model_file, multiplier, plenum, ceil_adjacency, merge_method,
+    sim_par_json, hvac_mapping, include_interior_walls, include_interior_ceilings,
+    equest_version, output_file
 ):
     """Translate a Dragonfly Model file to a Radiance string.
 
@@ -85,9 +93,8 @@ def model_to_inp_cli(
         exclude_interior_walls = not include_interior_walls
         exclude_interior_ceilings = not include_interior_ceilings
         model_to_inp(
-            model_file, full_geometry, no_plenum, no_ceil_adjacency,
-            sim_par_json, hvac_mapping,
-            exclude_interior_walls, exclude_interior_ceilings,
+            model_file, full_geometry, no_plenum, no_ceil_adjacency, merge_method,
+            sim_par_json, hvac_mapping, exclude_interior_walls, exclude_interior_ceilings,
             equest_version, output_file)
     except Exception as e:
         _logger.exception('Model translation failed.\n{}\n'.format(e))
@@ -98,8 +105,9 @@ def model_to_inp_cli(
 
 def model_to_inp(
     model_file, full_geometry=False, no_plenum=False, no_ceil_adjacency=False,
-    sim_par_json=None, hvac_mapping='Story', exclude_interior_walls=False,
-    exclude_interior_ceilings=False, equest_version=None, output_file=None,
+    merge_method='None', sim_par_json=None, hvac_mapping='Story',
+    exclude_interior_walls=False, exclude_interior_ceilings=False,
+    equest_version=None, output_file=None,
     multiplier=True, plenum=True, ceil_adjacency=True,
     include_interior_walls=True, include_interior_ceilings=True
 ):
@@ -119,6 +127,20 @@ def model_to_inp(
             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
         simulation_par: A honeybee-doe2 SimulationPar object to specify how the
             DOE-2 simulation should be run. If None, default simulation
             parameters will be generated, which will run the simulation for the
@@ -159,8 +181,10 @@ def model_to_inp(
     multiplier = not full_geometry
     ceil_adjacency = not no_ceil_adjacency
     inp_str = writer_model_to_inp(
-        model, multiplier, no_plenum, ceil_adjacency, sim_par, hvac_mapping,
-        exclude_interior_walls, exclude_interior_ceilings, equest_version)
+        model, multiplier, no_plenum, ceil_adjacency, merge_method,
+        sim_par, hvac_mapping, exclude_interior_walls, exclude_interior_ceilings,
+        equest_version
+    )
 
     # write out the INP file
     return process_content_to_output(inp_str, output_file)

dragonfly_doe2/writer.py

@@ -7,7 +7,7 @@ from honeybee_doe2.writer import model_to_inp as hb_model_to_inp
 
 def model_to_inp(
     model, use_multiplier=True, exclude_plenums=False, solve_ceiling_adjacencies=True,
-    simulation_par=None, hvac_mapping='Story',
+    merge_method='None', simulation_par=None, hvac_mapping='Story',
     exclude_interior_walls=False, exclude_interior_ceilings=False, equest_version=None
 ):
     """Generate an INP string from a Dragonfly Model.
@@ -30,6 +30,21 @@ def model_to_inp(
             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. (Default: True).
+        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 across their solved adjacencies. 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
+
         simulation_par: A honeybee-doe2 SimulationPar object to specify how the
             DOE-2 simulation should be run. If None, default simulation
             parameters will be generated, which will run the simulation for the
@@ -103,8 +118,9 @@ def model_to_inp(
     # convert the Dragonfly Model to Honeybee
     hb_model = model.to_honeybee(
         'District', use_multiplier=use_multiplier, exclude_plenums=exclude_plenums,
-        solve_ceiling_adjacencies=solve_ceiling_adjacencies,
-        enforce_adj=False, enforce_solid=True)[0]
+        solve_ceiling_adjacencies=solve_ceiling_adjacencies, merge_method=merge_method,
+        enforce_adj=False, enforce_solid=True
+    )[0]
 
     # assign the space polygon geometry to the Honeybee Rooms from Dragonfly
     df_flr_geos = {}  # dictionary to hold the DOE-2 space polygon geometry

{dragonfly_doe2-0.12.10.dist-info → dragonfly_doe2-0.12.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dragonfly-doe2
-Version: 0.12.10
+Version: 0.12.11
 Summary: Dragonfly extension for the DOE-2 energy simulation engine.
 Home-page: https://github.com/ladybug-tools/dragonfly-doe2
 Author: Ladybug Tools

{dragonfly_doe2-0.12.10.dist-info → dragonfly_doe2-0.12.11.dist-info}/RECORD

@@ -1,15 +1,15 @@
 dragonfly_doe2/__init__.py,sha256=Fg3aP_2h6-UD4bqHbFJ3tMbA_ZED5uDGjDedY4XJp8g,40
 dragonfly_doe2/__main__.py,sha256=3FrW6CO-CPoGSXn73hLWCejb0d-qnit6ga_565z49uY,75
 dragonfly_doe2/_extend_dragonfly.py,sha256=_3XebNYHxG__7wxLOtW-aqPV-OIkplvVXgnBEDgrcS0,996
-dragonfly_doe2/writer.py,sha256=Yfs9fEEhX8WrDqhy4nIxeOwMPDKHvu3RoeInz94pGO8,6224
+dragonfly_doe2/writer.py,sha256=m7dlAUrVFwHWpKISWLEzNkDkd9g6XtnO4KJSFnw1IPY,7271
 dragonfly_doe2/cli/__init__.py,sha256=OwTHSsOOEoJjbw5CqPig8Yo7jk1f6m53OFnhuZgPthE,391
-dragonfly_doe2/cli/translate.py,sha256=gVpMSL074B6YPOe26cD0njGL_durS9lugrenbLoZiUw,7989
+dragonfly_doe2/cli/translate.py,sha256=Brx8p-9tUzrbdNFj_B398EmVQdFIENC-w2qROhkaWx8,9486
 dragonfly_doe2/properties/__init__.py,sha256=0JiyMYGeRlPLcxh1PSr6eJzDGgfrbMivcO9dS1h7wEU,33
 dragonfly_doe2/properties/model.py,sha256=Ho9xSkbhBIoHxJSNnmuTxvMD-I3FiVEzDuTx5hs3D5M,14467
 dragonfly_doe2/properties/room2d.py,sha256=ghKKhcX2TSgPUAdcQk-PPHo_5AilSmTiLElxb8--dkE,12773
-dragonfly_doe2-0.12.10.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-dragonfly_doe2-0.12.10.dist-info/METADATA,sha256=LPmsVABnwN_zHen6ocNZaz5VUJwvZMq9g1puJxM7vEs,3103
-dragonfly_doe2-0.12.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dragonfly_doe2-0.12.10.dist-info/entry_points.txt,sha256=oBzZOsc8Bs40iHKtuyWGrz_nfLZu1-6cHrBej05ZqrY,59
-dragonfly_doe2-0.12.10.dist-info/top_level.txt,sha256=6CLCvUyl1H2vrbXmeA0ND_znFz4a2oOclc7NMBZxR6c,15
-dragonfly_doe2-0.12.10.dist-info/RECORD,,
+dragonfly_doe2-0.12.11.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+dragonfly_doe2-0.12.11.dist-info/METADATA,sha256=JvVo_5_PGFZ4caESOv1yZZe9rBF-KVUFBEEtImzoCqk,3103
+dragonfly_doe2-0.12.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dragonfly_doe2-0.12.11.dist-info/entry_points.txt,sha256=oBzZOsc8Bs40iHKtuyWGrz_nfLZu1-6cHrBej05ZqrY,59
+dragonfly_doe2-0.12.11.dist-info/top_level.txt,sha256=6CLCvUyl1H2vrbXmeA0ND_znFz4a2oOclc7NMBZxR6c,15
+dragonfly_doe2-0.12.11.dist-info/RECORD,,