fix(cli): Update CLI to use the new plenum defaults

Author: chriswmackey

dragonfly_display/cli/__init__.py

@@ -35,9 +35,9 @@ def display():
     '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(
-    '--no-plenum/--plenum', ' /-p', help='Flag to indicate whether '
-    'ceiling/floor plenums should be auto-generated for the Rooms.',
-    default=True, show_default=True)
+    '--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-ceil-adjacency/--ceil-adjacency', ' /-a', help='Flag to indicate '
     'whether adjacencies should be solved between interior stories when '
@@ -118,7 +118,7 @@ def display():
     'file contents. By default, it will be printed out to stdout.',
     type=click.File('w'), default='-', show_default=True)
 def model_to_vis_set_cli(
-        model_file, multiplier, no_plenum, no_ceil_adjacency,
+        model_file, multiplier, plenum, no_ceil_adjacency,
         color_by, wireframe, mesh, show_color_by,
         room_attr, face_attr, color_attr, grid_display_mode, show_grid,
         output_format, output_file):
@@ -134,7 +134,7 @@ def model_to_vis_set_cli(
     try:
         # process all of the CLI input so that it can be passed to the function
         full_geometry = not multiplier
-        add_plenum = not no_plenum
+        no_plenum = not plenum
         ceil_adjacency = not no_ceil_adjacency
         exclude_wireframe = not wireframe
         faces = not mesh
@@ -145,7 +145,7 @@ def model_to_vis_set_cli(
         hide_grid = not show_grid
 
         # pass the input to the function in order to convert the model
-        model_to_vis_set(model_file, full_geometry, add_plenum, ceil_adjacency, color_by,
+        model_to_vis_set(model_file, full_geometry, no_plenum, ceil_adjacency, color_by,
                          exclude_wireframe, faces, hide_color_by,
                          room_attrs, face_attrs, text_labels, grid_display_mode,
                          hide_grid, output_format, output_file)
@@ -157,11 +157,11 @@ def model_to_vis_set_cli(
 
 
 def model_to_vis_set(
-    model_file, full_geometry=False, plenum=False, ceil_adjacency=False,
+    model_file, full_geometry=False, no_plenum=False, ceil_adjacency=False,
     color_by='type', exclude_wireframe=False, faces=False, hide_color_by=False,
     room_attr=(), face_attr=(), text_attr=False, grid_display_mode='Default',
     hide_grid=False, output_format='vsf', output_file=None,
-    multiplier=True, no_plenum=True, no_ceil_adjacency=True, wireframe=True, mesh=True,
+    multiplier=True, plenum=True, no_ceil_adjacency=True, wireframe=True, mesh=True,
     show_color_by=True, color_attr=True, show_grid=True
 ):
     """Translate a Dragonfly Model file (.dfjson) to a VisualizationSet file (.vsf).
@@ -174,8 +174,9 @@ def model_to_vis_set(
         full_geometry: Boolean to note if the multipliers on each Story should
             be passed along to the generated Honeybee Room objects or if full
             geometry objects should be written for each story in the building.
-        plenum: Boolean to indicate whether ceiling/floor plenums should
-            be auto-generated for the Rooms. (Default: False).
+        no_plenum: Boolean to indicate whether ceiling/floor plenum depths
+            assigned to Room2Ds should generate distinct 3D Rooms in the
+            translation. (Default: False).
         ceil_adjacency: Boolean to indicate whether adjacencies should be solved
             between interior stories when Room2D floor and ceiling geometries
             are coplanar. This ensures that Surface boundary conditions are used
@@ -259,7 +260,7 @@ def model_to_vis_set(
     # create the VisualizationSet
     multiplier = not full_geometry
     vis_set = model_obj.to_vis_set(
-        multiplier, plenum, ceil_adjacency, color_by=color_by,
+        multiplier, no_plenum, ceil_adjacency, color_by=color_by,
         include_wireframe=wireframe, use_mesh=mesh, hide_color_by=hide_color_by,
         room_attrs=room_attributes, face_attrs=face_attributes,
         grid_display_mode=grid_display_mode, hide_grid=hide_grid)
@@ -279,9 +280,9 @@ def model_to_vis_set(
     '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(
-    '--no-plenum/--plenum', ' /-p', help='Flag to indicate whether '
-    'ceiling/floor plenums should be auto-generated for the Rooms.',
-    default=True, show_default=True)
+    '--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-ceil-adjacency/--ceil-adjacency', ' /-a', help='Flag to indicate '
     'whether adjacencies should be solved between interior stories when '
@@ -308,7 +309,7 @@ def model_to_vis_set(
     'file contents. By default, it will be printed out to stdout',
     type=click.File('w'), default='-', show_default=True)
 def model_comparison_to_vis_set_cli(
-        base_model_file, incoming_model_file, multiplier, no_plenum, no_ceil_adjacency,
+        base_model_file, incoming_model_file, multiplier, plenum, no_ceil_adjacency,
         base_color, incoming_color, output_format, output_file):
     """Translate two Dragonfly Models to be compared to a VisualizationSet.
 
@@ -327,12 +328,12 @@ def model_comparison_to_vis_set_cli(
     try:
         # process all of the CLI input so that it can be passed to the function
         full_geometry = not multiplier
-        add_plenum = not no_plenum
+        no_plenum = not plenum
         ceil_adjacency = not no_ceil_adjacency
 
         # pass the input to the function in order to convert the model
         model_comparison_to_vis_set(
-            base_model_file, incoming_model_file, full_geometry, add_plenum,
+            base_model_file, incoming_model_file, full_geometry, no_plenum,
             ceil_adjacency, base_color, incoming_color, output_format, output_file)
     except Exception as e:
         _logger.exception('Failed to translate Model to VisualizationSet.\n{}'.format(e))
@@ -342,9 +343,10 @@ def model_comparison_to_vis_set_cli(
 
 
 def model_comparison_to_vis_set(
-    base_model_file, incoming_model_file, full_geometry=False, plenum=False,
+    base_model_file, incoming_model_file, full_geometry=False, no_plenum=False,
     ceil_adjacency=False, base_color='#74eded', incoming_color='#ed7474',
     output_format='vsf', output_file=None,
+    multiplier=True, plenum=True, no_ceil_adjacency=True
 ):
     """Translate two Honeybee Models to be compared to a VisualizationSet.
 
@@ -361,8 +363,9 @@ def model_comparison_to_vis_set(
         full_geometry: Boolean to note if the multipliers on each Story should
             be passed along to the generated Honeybee Room objects or if full
             geometry objects should be written for each story in the building.
-        plenum: Boolean to indicate whether ceiling/floor plenums should
-            be auto-generated for the Rooms. (Default: False).
+        no_plenum: Boolean to indicate whether ceiling/floor plenum depths
+            assigned to Room2Ds should generate distinct 3D Rooms in the
+            translation. (Default: False).
         ceil_adjacency: Boolean to indicate whether adjacencies should be solved
             between interior stories when Room2D floor and ceiling geometries
             are coplanar. This ensures that Surface boundary conditions are used
@@ -394,7 +397,8 @@ def model_comparison_to_vis_set(
     # create the VisualizationSet
     multiplier = not full_geometry
     vis_set = base_model.to_vis_set_comparison(
-        incoming_model, multiplier, plenum, ceil_adjacency, base_color, incoming_color)
+        incoming_model, multiplier, no_plenum, ceil_adjacency,
+        base_color, incoming_color)
 
     # output the VisualizationSet through the CLI
     return _output_vis_set_to_format(vis_set, output_format, output_file)

dragonfly_display/model.py

@@ -5,7 +5,8 @@
 
 
 def model_to_vis_set(
-        model, use_multiplier=True, add_plenum=False, solve_ceiling_adjacencies=False,
+        model, use_multiplier=True, exclude_plenums=False,
+        solve_ceiling_adjacencies=False,
         color_by='type', include_wireframe=True, use_mesh=True,
         hide_color_by=False, room_attrs=None, face_attrs=None,
         grid_display_mode='Default', hide_grid=False):
@@ -19,8 +20,11 @@ def model_to_vis_set(
             will be multiplied. If False, full geometry objects will be written
             for each and every floor in the building that are represented through
             multipliers and all resulting multipliers will be 1. (Default: True).
-        add_plenum: Boolean to indicate whether ceiling/floor plenums should
-            be auto-generated for the Rooms. (Default: False).
+        exclude_plenums: Boolean to indicate whether ceiling/floor plenum depths
+            assigned to Room2Ds should be ignored during translation. This
+            results in each Room2D translating to a single Honeybee Room at
+            the full floor_to_ceiling_height instead of a base Room with (a)
+            plenum Room(s). (Default: False).
         solve_ceiling_adjacencies: Boolean to note whether adjacencies should be
             solved between interior stories when Room2D floor and ceiling
             geometries are coplanar. This ensures that Surface boundary
@@ -73,7 +77,7 @@ def model_to_vis_set(
     """
     # create the Honeybee Model from the Dragonfly one
     hb_model = model.to_honeybee(
-        'District', use_multiplier=use_multiplier, add_plenum=add_plenum,
+        'District', use_multiplier=use_multiplier, exclude_plenums=exclude_plenums,
         solve_ceiling_adjacencies=solve_ceiling_adjacencies,
         enforce_adj=False, enforce_solid=True)[0]
     # convert the Honeybee Model to a VisualizationSet
@@ -83,7 +87,7 @@ def model_to_vis_set(
 
 
 def model_comparison_to_vis_set(
-        base_model, incoming_model, use_multiplier=True, add_plenum=False,
+        base_model, incoming_model, use_multiplier=True, exclude_plenums=False,
         solve_ceiling_adjacencies=False, base_color=None, incoming_color=None):
     """Translate two Dragonfly Models to be compared to a VisualizationSet.
 
@@ -99,8 +103,11 @@ def model_comparison_to_vis_set(
             will be multiplied. If False, full geometry objects will be written
             for each and every floor in the building that are represented through
             multipliers and all resulting multipliers will be 1. (Default: True).
-        add_plenum: Boolean to indicate whether ceiling/floor plenums should
-            be auto-generated for the Rooms. (Default: False).
+        exclude_plenums: Boolean to indicate whether ceiling/floor plenum depths
+            assigned to Room2Ds should be ignored during translation. This
+            results in each Room2D translating to a single Honeybee Room at
+            the full floor_to_ceiling_height instead of a base Room with (a)
+            plenum Room(s). (Default: False).
         solve_ceiling_adjacencies: Boolean to note whether adjacencies should be
             solved between interior stories when Room2D floor and ceiling
             geometries are coplanar. This ensures that Surface boundary
@@ -113,11 +120,11 @@ def model_comparison_to_vis_set(
     """
     # create the Honeybee Models from the Dragonfly ones
     base_model = base_model.to_honeybee(
-        'District', use_multiplier=use_multiplier, add_plenum=add_plenum,
+        'District', use_multiplier=use_multiplier, exclude_plenums=exclude_plenums,
         solve_ceiling_adjacencies=solve_ceiling_adjacencies,
         enforce_adj=False, enforce_solid=True)[0]
     incoming_model = incoming_model.to_honeybee(
-        'District', use_multiplier=use_multiplier, add_plenum=add_plenum,
+        'District', use_multiplier=use_multiplier, exclude_plenums=exclude_plenums,
         solve_ceiling_adjacencies=solve_ceiling_adjacencies,
         enforce_adj=False, enforce_solid=True)[0]
     # convert the Honeybee Model to a VisualizationSet

requirements.txt

@@ -1,2 +1,2 @@
-honeybee-display>=0.5.1
-dragonfly-core>=1.57.4
+honeybee-display>=0.5.3
+dragonfly-core>=1.59.1

tests/cli_test.py

@@ -73,4 +73,3 @@ def test_model_comparison_to_vis_set():
 
     assert isinstance(vtkjs_str, str)
     assert len(vtkjs_str) > 1000
-