dragonfly-display 0.3.7__py3-none-any.whl

dragonfly_display/__init__.py

@@ -0,0 +1,2 @@
+"""dragonfly-display library."""
+import dragonfly_display._extend_dragonfly

dragonfly_display/__main__.py

@@ -0,0 +1,4 @@
+from dragonfly_display.cli import display
+
+if __name__ == '__main__':
+    display()

dragonfly_display/_extend_dragonfly.py

@@ -0,0 +1,10 @@
+# coding=utf-8
+# import the core dragonfly modules
+from dragonfly.model import Model
+
+# import the extension functions
+from .model import model_to_vis_set, model_comparison_to_vis_set
+
+# inject the methods onto the classes
+Model.to_vis_set = model_to_vis_set
+Model.to_vis_set_comparison = model_comparison_to_vis_set

dragonfly_display/cli/__init__.py

@@ -0,0 +1,537 @@
+"""dragonfly-display commands."""
+import click
+import sys
+import os
+import logging
+import json
+import base64
+import pickle
+import tempfile
+import uuid
+
+from ladybug.color import Color
+from honeybee_display.attr import FaceAttribute, RoomAttribute
+
+from dragonfly.model import Model
+from dragonfly.cli import main
+
+
+_logger = logging.getLogger(__name__)
+
+
+# command group for all display extension commands.
+@click.group(help='dragonfly display commands.')
+@click.version_option()
+def display():
+    pass
+
+
+@display.command('model-to-vis')
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--multiplier/--full-geometry', ' /-fg', help='Flag to note if the '
+    'multipliers on each Building 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.', 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-ceil-adjacency/--ceil-adjacency', ' /-a', help='Flag 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 instead of Adiabatic ones.',
+    default=True, show_default=True)
+@click.option(
+    '--merge-method', 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 3D Honeybee Model and, ultimately, yield '
+    'a faster simulation time in the destination engine with fewer results '
+    'to manage. Choose from: None, Zones, PlenumZones, Stories, PlenumStories.',
+    type=str, default='None', show_default=True)
+@click.option(
+    '--color-by', '-c', help='Text for the property that dictates the colors of '
+    'the Model geometry. Choose from: type, boundary_condition, none. '
+    'If none, only a wireframe of the Model will be generated (assuming the '
+    '--exclude-wireframe option is not used). None is useful when the primary '
+    'purpose of  the visualization is to display results in relation to the Model '
+    'geometry or display some room_attr or face_attr as an AnalysisGeometry '
+    'or Text labels.', type=str, default='type', show_default=True)
+@click.option(
+    '--wireframe/--exclude-wireframe', ' /-xw', help='Flag to note whether a '
+    'ContextGeometry dedicated to the Model Wireframe (in DisplayLineSegment3D) should '
+    'be included in the output VisualizationSet.', default=True, show_default=True)
+@click.option(
+    '--mesh/--faces', help='Flag to note whether the colored model geometries should '
+    'be represented with DisplayMesh3D objects instead of DisplayFace3D objects. '
+    'Meshes can usually be rendered  faster and they scale well for large models '
+    'but all geometry is triangulated (meaning that their wireframe in certain '
+    'platforms might not appear ideal).', default=True, show_default=True)
+@click.option(
+    '--show-color-by/--hide-color-by', ' /-hcb', help='Flag to note whether the '
+    'color-by geometry should be hidden or shown by default. Hiding the color-by '
+    'geometry is useful when the primary purpose of the visualization is to display '
+    'grid-data or room/face attributes but it is still desirable to have the option '
+    'to turn on the geometry.', default=True, show_default=True)
+@click.option(
+    '--room-attr', '-r', help='An optional text string of an attribute that the Model '
+    'Rooms have, which will be used to construct a visualization of this attribute '
+    'in the resulting VisualizationSet. Multiple instances of this option can be passed '
+    'and a separate VisualizationData will be added to the AnalysisGeometry that '
+    'represents the attribute in the resulting VisualizationSet (or a separate '
+    'ContextGeometry layer if --text-attr is True). Room attributes '
+    'input here can have . that separates the nested attributes from '
+    'one another. For example, properties.energy.program_type.',
+    type=click.STRING, multiple=True, default=None, show_default=True)
+@click.option(
+    '--face-attr', '-f', help='An optional text string of an attribute that the Model '
+    'Faces have, which will be used to construct a visualization of this attribute in '
+    'the resulting VisualizationSet. Multiple instances of this option can be passed and'
+    ' a separate VisualizationData will be added to the AnalysisGeometry that '
+    'represents the attribute in the resulting VisualizationSet (or a separate '
+    'ContextGeometry layer if --text-attr is True). Face attributes '
+    'input here can have . that separates the nested attributes from '
+    'one another. For example, properties.energy.construction.',
+    type=click.STRING, multiple=True, default=None, show_default=True)
+@click.option(
+    '--color-attr/--text-attr', help='Flag to note whether to note whether the '
+    'input room-attr and face-attr should be expressed as a colored AnalysisGeometry '
+    'or a ContextGeometry as text labels.', default=True, show_default=True)
+@click.option(
+    '--grid-display-mode', '-m', help='Text that dictates how the ContextGeometry '
+    'for Model SensorGrids should display in the resulting visualization. The Default '
+    'option will draw sensor points whenever there is no grid_data_path and will not '
+    'draw them at all when grid data is provided, assuming the AnalysisGeometry of '
+    'the grids is sufficient. Choose from: Default, Points, Wireframe, Surface, '
+    'SurfaceWithEdges, None.',
+    type=str, default='Default', show_default=True)
+@click.option(
+    '--show-grid/--hide-grid', ' /-hg', help='Flag to note whether the SensorGrid '
+    'ContextGeometry should be hidden or shown by default.',
+    default=True, show_default=True)
+@click.option(
+    '--output-format', '-of', help='Text for the output format of the resulting '
+    'VisualizationSet File (.vsf). Choose from: vsf, json, pkl, vtkjs, html. Note '
+    'that both vsf and json refer to the the JSON version of the VisualizationSet '
+    'file and the distinction between the two is only for help in coordinating file '
+    'extensions (since both .vsf and .json can be acceptable). Also note that '
+    'ladybug-vtk must be installed in order for the vtkjs or html options to be usable '
+    'and the html format refers to a web page with the vtkjs file embedded within it.',
+    type=str, default='vsf', show_default=True)
+@click.option(
+    '--output-file', help='Optional file to output the string of the visualization '
+    '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, plenum, no_ceil_adjacency, merge_method,
+    color_by, wireframe, mesh, show_color_by,
+    room_attr, face_attr, color_attr, grid_display_mode, show_grid,
+    output_format, output_file
+):
+    """Translate a Dragonfly Model file (.dfjson) to a VisualizationSet file (.vsf).
+
+    This command can also optionally translate the Dragonfly Model to a .vtkjs file,
+    which can be visualized in the open source Visual ToolKit (VTK) platform.
+
+    \b
+    Args:
+        model_file: Full path to a Dragonfly Model (DFJSON or DFpkl) file.
+    """
+    try:
+        # process all of the CLI input so that it can be passed to the function
+        full_geometry = not multiplier
+        no_plenum = not plenum
+        ceil_adjacency = not no_ceil_adjacency
+        exclude_wireframe = not wireframe
+        faces = not mesh
+        hide_color_by = not show_color_by
+        room_attrs = [] if len(room_attr) == 0 or room_attr[0] == '' else room_attr
+        face_attrs = [] if len(face_attr) == 0 or face_attr[0] == '' else face_attr
+        text_labels = not color_attr
+        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, no_plenum, ceil_adjacency, merge_method,
+            color_by, exclude_wireframe, faces, hide_color_by,
+            room_attrs, face_attrs, text_labels, grid_display_mode,
+            hide_grid, output_format, output_file)
+    except Exception as e:
+        _logger.exception('Failed to translate Model to VisualizationSet.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def model_to_vis_set(
+    model_file, full_geometry=False, no_plenum=False, ceil_adjacency=False,
+    merge_method='Default', 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, 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).
+
+    This function can also optionally translate the Dragonfly Model to a .vtkjs file,
+    which can be visualized in the open source Visual ToolKit (VTK) platform.
+
+    Args:
+        model_file: Path to a Dragonfly Model (DFJSON or DFpkl) file.
+        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.
+        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
+            instead of Adiabatic ones.
+        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. 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 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
+
+        color_by: Text for the property that dictates the colors of the Model
+            geometry. Choose from: type, boundary_condition, none. If none, only
+            a wireframe of the Model will be generated (assuming the exclude_wireframe
+            option is not used). None is useful when the primary purpose of  the
+            visualization is to display results in relation to the Model geometry
+            or display some room_attr or face_attr as an AnalysisGeometry or Text labels.
+        exclude_wireframe: Boolean to note whether a ContextGeometry dedicated to
+            the Model Wireframe (in DisplayLineSegment3D) should be included in
+            the output visualization.
+        faces: Boolean to note whether the colored model geometries should be
+            represented with DisplayMesh3D objects instead of DisplayFace3D objects.
+            Meshes can usually be rendered  faster and they scale well for large models
+            but all geometry is triangulated (meaning that their wireframe in certain
+            platforms might not appear ideal).
+        hide_color_by: Boolean to note whether the color-by geometry should be
+            hidden or shown by default. Hiding the color-by geometry is useful
+            when the primary purpose of the visualization is to display grid_data
+            or room/face attributes but it is still desirable to have the option
+            to turn on the geometry.
+        room_attr: An optional text string of an attribute that the Model Rooms
+            have, which will be used to construct a visualization of this attribute
+            in the resulting VisualizationSet. A list of text can also
+            be passed and a separate VisualizationData will be added to the
+            AnalysisGeometry that represents the attribute in the resulting
+            VisualizationSet (or a separate ContextGeometry layer if text_attr
+            is True). Room attributes input here can have . that separates the nested
+            attributes from one another. For example, properties.energy.program_type.
+        face_attr: An optional text string of an attribute that the Model Faces
+            have, which will be used to construct a visualization of this attribute
+            in the resulting VisualizationSet. A list of text can also be passed and
+            a separate VisualizationData will be added to the AnalysisGeometry that '
+            represents the attribute in the resulting VisualizationSet (or a separate '
+            ContextGeometry layer if text_attr is True). Face attributes input
+            here can have . that separates the nested attributes from one another.
+            For example, properties.energy.construction.
+        text_attr: Boolean to note whether to note whether the input room_attr
+            and face_attr should be expressed as a colored AnalysisGeometry
+            or a ContextGeometry as text labels.
+        grid_display_mode: Text that dictates how the ContextGeometry for Model
+            SensorGrids should display in the resulting visualization. The Default
+            option will draw sensor points whenever there is no grid_data_path
+            and will not draw them at all when grid data is provided, assuming
+            the AnalysisGeometry of the grids is sufficient. Choose from: Default,
+            Points, Wireframe, Surface, SurfaceWithEdges, None.
+        hide_grid: Boolean to note whether the SensorGrid ContextGeometry should
+            be hidden or shown by default.
+        output_format: Text for the output format of the resulting VisualizationSet
+            File (.vsf). Choose from: vsf, json, pkl, vtkjs, html. Note that both
+            vsf and json refer to the the JSON version of the VisualizationSet
+            file and the distinction between the two is only for help in
+            coordinating file extensions (since both .vsf and .json can be
+            acceptable). Also note that ladybug-vtk must be installed in order
+            for the vtkjs or html options to be usable and the html format
+            refers to a web page with the vtkjs file embedded within it.
+        output_file: Optional file to output the string of the visualization
+            file contents. If None, the string will simply be returned from
+            this method.
+    """
+    # load the model object and process simpler attributes
+    model_obj = Model.from_file(model_file)
+    room_attrs = [room_attr] if isinstance(room_attr, str) else room_attr
+    face_attrs = [face_attr] if isinstance(face_attr, str) else face_attr
+    wireframe = not exclude_wireframe
+    mesh = not faces
+    color_attr = not text_attr
+    reset_coordinates = True if output_format.lower() in ('vtkjs', 'html') else False
+
+    # load the room and face attributes
+    face_attributes = []
+    for fa in face_attrs:
+        faa = FaceAttribute(name=fa, attrs=[fa], color=color_attr, text=text_attr)
+        face_attributes.append(faa)
+    room_attributes = []
+    for ra in room_attrs:
+        raa = RoomAttribute(name=ra, attrs=[ra], color=color_attr, text=text_attr)
+        room_attributes.append(raa)
+
+    # create the VisualizationSet
+    multiplier = not full_geometry
+    vis_set = model_obj.to_vis_set(
+        multiplier, no_plenum, ceil_adjacency, merge_method=merge_method,
+        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,
+        reset_coordinates=reset_coordinates
+    )
+
+    # output the VisualizationSet through the CLI
+    return _output_vis_set_to_format(vis_set, output_format, output_file)
+
+
+@display.command('model-comparison-to-vis')
+@click.argument('base-model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.argument('incoming-model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--multiplier/--full-geometry', ' /-fg', help='Flag to note if the '
+    'multipliers on each Building 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.', 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-ceil-adjacency/--ceil-adjacency', ' /-a', help='Flag 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 instead of Adiabatic ones.',
+    default=True, show_default=True)
+@click.option(
+    '--merge-method', 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 3D Honeybee Model and, ultimately, yield '
+    'a faster simulation time in the destination engine with fewer results '
+    'to manage. Choose from: None, Zones, PlenumZones, Stories, PlenumStories.',
+    type=str, default='None', show_default=True)
+@click.option(
+    '--base-color', '-bc', help='An optional hexadecimal code for the color '
+    'of the base model.', type=str, default='#74eded', show_default=True)
+@click.option(
+    '--incoming-color', '-ic', help='An optional hexadecimal code for the color '
+    'of the incoming model.', type=str, default='#ed7474', show_default=True)
+@click.option(
+    '--output-format', '-of', help='Text for the output format of the resulting '
+    'VisualizationSet File (.vsf). Choose from: vsf, json, pkl, vtkjs, html. Note '
+    'that both vsf and json refer to the the JSON version of the VisualizationSet '
+    'file and the distinction between the two is only for help in coordinating file '
+    'extensions (since both .vsf and .json can be acceptable). Also note that '
+    'ladybug-vtk must be installed in order for the vtkjs or html options to be usable '
+    'and the html format refers to a web page with the vtkjs file embedded within it.',
+    type=str, default='vsf', show_default=True)
+@click.option(
+    '--output-file', help='Optional file to output the he string of the visualization '
+    '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, plenum, no_ceil_adjacency,
+    merge_method, base_color, incoming_color, output_format, output_file
+):
+    """Translate two Dragonfly Models to be compared to a VisualizationSet.
+
+    This command can also optionally translate the Dragonfly Model to a .vtkjs file,
+    which can be visualized in the open source Visual ToolKit (VTK) platform.
+
+    \b
+    Args:
+        base_model_file: Full path to a Dragonfly Model (DFJSON or HBpkl) file
+            representing the base model used in the comparison. Typically, this
+            is the model with more data to be kept.
+        incoming_model_file: Full path to a Dragonfly Model (DFJSON or HBpkl) file
+            representing the incoming model used in the comparison. Typically,
+            this is the model with new data to be evaluated against the base model.
+    """
+    try:
+        # process all of the CLI input so that it can be passed to the function
+        full_geometry = not multiplier
+        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, no_plenum,
+            ceil_adjacency, merge_method, base_color, incoming_color,
+            output_format, output_file
+        )
+    except Exception as e:
+        _logger.exception('Failed to translate Model to VisualizationSet.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def model_comparison_to_vis_set(
+    base_model_file, incoming_model_file, full_geometry=False, no_plenum=False,
+    ceil_adjacency=False, merge_method='None',
+    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.
+
+    This command can also optionally translate the Honeybee Model to a .vtkjs file,
+    which can be visualized in the open source Visual ToolKit (VTK) platform.
+
+    Args:
+        base_model_file: Full path to a Honeybee Model (HBJSON or HBpkl) file
+            representing the base model used in the comparison. Typically, this
+            is the model with more data to be kept.
+        incoming_model_file: Full path to a Honeybee Model (HBJSON or HBpkl) file
+            representing the incoming model used in the comparison. Typically,
+            this is the model with new data to be evaluated against the base model.
+        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.
+        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
+            instead of Adiabatic ones.
+        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. 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 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
+
+        base_color: An optional hexadecimal code for the color of the base
+            model. (Default: #74eded).
+        incoming_color: An optional hexadecimal code for the color of the incoming
+            model. (Default: #ed7474).
+        output_format: Text for the output format of the resulting VisualizationSet
+            File (.vsf). Choose from: vsf, json, pkl, vtkjs, html. Note that both
+            vsf and json refer to the the JSON version of the VisualizationSet
+            file and the distinction between the two is only for help in
+            coordinating file extensions (since both .vsf and .json can be
+            acceptable). Also note that ladybug-vtk must be installed in order
+            for the vtkjs or html options to be usable and the html format
+            refers to a web page with the vtkjs file embedded within it.
+        output_file: Optional file to output the string of the visualization
+            file contents. If None, the string will simply be returned from
+            this method.
+    """
+    # load the model objects and process the colors from the hex codes
+    base_model = Model.from_file(base_model_file)
+    incoming_model = Model.from_file(incoming_model_file)
+    base_color = Color.from_hex(base_color)
+    incoming_color = Color.from_hex(incoming_color)
+    base_color.a = 128
+    incoming_color.a = 128
+    reset_coordinates = True if output_format.lower() in ('vtkjs', 'html') else False
+
+    # create the VisualizationSet
+    multiplier = not full_geometry
+    vis_set = base_model.to_vis_set_comparison(
+        incoming_model, multiplier, no_plenum, ceil_adjacency, merge_method,
+        base_color, incoming_color, reset_coordinates=reset_coordinates)
+
+    # output the VisualizationSet through the CLI
+    return _output_vis_set_to_format(vis_set, output_format, output_file)
+
+
+def _output_vis_set_to_format(vis_set, output_format, output_file):
+    """Process a VisualizationSet for output from the CLI.
+
+    Args:
+        vis_set: The VisualizationSet to be output form the CLI.
+        output_format: Text for the output format of the resulting VisualizationSet File.
+        output_file: Optional file to output the string of the visualization
+            file contents. If None, the string will simply be returned from
+            this method.
+    """
+    # output the visualization in the correct format
+    output_format = output_format.lower()
+    if output_format in ('vsf', 'json'):
+        if output_file is None:
+            return json.dumps(vis_set.to_dict())
+        elif isinstance(output_file, str):
+            with open(output_file, 'w') as of:
+                of.write(json.dumps(vis_set.to_dict()))
+        else:
+            output_file.write(json.dumps(vis_set.to_dict()))
+    elif output_format == 'pkl':
+        if output_file is None:
+            return pickle.dumps(vis_set.to_dict())
+        elif isinstance(output_file, str):
+            with open(output_file, 'w') as of:
+                of.write(pickle.dumps(vis_set.to_dict()))
+        elif output_file.name == '<stdout>':
+            output_file.write(pickle.dumps(vis_set.to_dict()))
+        else:
+            out_folder, out_file = os.path.split(output_file.name)
+            vis_set.to_pkl(out_file, out_folder)
+    elif output_format in ('vtkjs', 'html'):
+        if output_file is None or (not isinstance(output_file, str)
+                                   and output_file.name == '<stdout>'):
+            # get a temporary file
+            out_file = str(uuid.uuid4())[:6]
+            out_folder = tempfile.gettempdir()
+        else:
+            f_path = output_file if isinstance(output_file, str) else output_file.name
+            out_folder, out_file = os.path.split(f_path)
+            if out_file.endswith('.vtkjs'):
+                out_file = out_file[:-6]
+            elif out_file.endswith('.html'):
+                out_file = out_file[:-5]
+        try:
+            if output_format == 'vtkjs':
+                vis_set.to_vtkjs(output_folder=out_folder, file_name=out_file)
+            if output_format == 'html':
+                vis_set.to_html(output_folder=out_folder, file_name=out_file)
+        except AttributeError as ae:
+            raise AttributeError(
+                'Ladybug-vtk must be installed in order to use --output-format '
+                'vtkjs.\n{}'.format(ae))
+        if output_file is None or (not isinstance(output_file, str)
+                                   and output_file.name == '<stdout>'):
+            # load file contents
+            out_file_ext = out_file + '.' + output_format
+            out_file_path = os.path.join(out_folder, out_file_ext)
+            if output_format == 'html':
+                with open(out_file_path, encoding='utf-8') as of:
+                    f_contents = of.read()
+            else:  # vtkjs can only be read as binary
+                with open(out_file_path, 'rb') as of:
+                    f_contents = of.read()
+                b = base64.b64encode(f_contents)
+                f_contents = b.decode('utf-8')
+            if output_file is None:
+                return f_contents
+            output_file.write(f_contents)
+    else:
+        raise ValueError('Unrecognized output-format "{}".'.format(output_format))
+
+
+# add display sub-group to dragonfly CLI
+main.add_command(display)