CLI Docs¶
Installation¶
To check if the Dragonfly command line interface is installed correctly use dragonfly viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response!
BuildingBuilding.ToString()Building.add_prefix()Building.add_room_3ds()Building.add_stories()Building.all_room_2ds()Building.all_stories()Building.buildings_to_honeybee()Building.convert_all_room_3ds_to_2d()Building.convert_room_3d_to_2d()Building.convert_room_3ds_to_2d()Building.district_to_honeybee()Building.duplicate()Building.footprint()Building.from_all_story_geometry()Building.from_dict()Building.from_footprint()Building.from_honeybee()Building.move()Building.process_alleys()Building.reflect()Building.room_3ds_by_story()Building.rotate_xy()Building.scale()Building.separate_mid_floors()Building.separate_top_bottom_floors()Building.set_outdoor_shading_parameters()Building.set_outdoor_window_parameters()Building.shade_representation()Building.stories_to_honeybee()Building.suggested_alignment_axes()Building.to_dict()Building.to_honeybee()Building.to_rectangular_windows()Building.display_nameBuilding.exterior_aperture_areaBuilding.exterior_wall_areaBuilding.floor_areaBuilding.footprint_areaBuilding.full_idBuilding.has_room_2dsBuilding.has_room_3dsBuilding.heightBuilding.height_above_groundBuilding.height_from_first_floorBuilding.identifierBuilding.maxBuilding.minBuilding.propertiesBuilding.room_2d_story_namesBuilding.room_3d_aperturesBuilding.room_3d_doorsBuilding.room_3d_facesBuilding.room_3d_shadesBuilding.room_3d_story_namesBuilding.room_3dsBuilding.story_countBuilding.story_count_above_groundBuilding.toBuilding.unique_room_2dsBuilding.unique_storiesBuilding.unique_stories_above_groundBuilding.user_dataBuilding.volumeColorRoom2DColorRoom2D.ToString()ColorRoom2D.attr_nameColorRoom2D.attr_name_endColorRoom2D.attributesColorRoom2D.attributes_originalColorRoom2D.attributes_uniqueColorRoom2D.floor_facesColorRoom2D.graphic_containerColorRoom2D.legend_parametersColorRoom2D.max_pointColorRoom2D.min_pointColorRoom2D.room_2dsContextShadeContextShade.ToString()ContextShade.add_prefix()ContextShade.duplicate()ContextShade.from_dict()ContextShade.from_honeybee()ContextShade.move()ContextShade.reflect()ContextShade.rotate_xy()ContextShade.scale()ContextShade.to_dict()ContextShade.to_honeybee()ContextShade.areaContextShade.display_nameContextShade.full_idContextShade.geometryContextShade.identifierContextShade.is_detachedContextShade.maxContextShade.minContextShade.propertiesContextShade.toContextShade.user_dataModelModel.ToString()Model.add_building()Model.add_context_shade()Model.add_model()Model.buildings_by_identifier()Model.check_all()Model.check_all_room3d()Model.check_degenerate_room_2ds()Model.check_duplicate_building_identifiers()Model.check_duplicate_context_shade_identifiers()Model.check_duplicate_room_2d_identifiers()Model.check_duplicate_story_identifiers()Model.check_missing_adjacencies()Model.check_no_roof_overlaps()Model.check_no_room2d_overlaps()Model.check_self_intersecting_room_2ds()Model.check_window_parameters_valid()Model.context_shade_by_identifier()Model.convert_to_units()Model.duplicate()Model.from_dfjson()Model.from_dfpkl()Model.from_dict()Model.from_file()Model.from_geojson()Model.from_honeybee()Model.model_dict_room_2d_subset()Model.model_dict_subset()Model.move()Model.reflect()Model.room_2ds_by_identifier()Model.room_3ds_by_identifier()Model.rotate_xy()Model.scale()Model.separate_top_bottom_floors()Model.set_outdoor_shading_parameters()Model.set_outdoor_window_parameters()Model.stories_by_identifier()Model.to_dfjson()Model.to_dfpkl()Model.to_dict()Model.to_geojson()Model.to_geojson_dict()Model.to_honeybee()Model.to_rectangular_windows()Model.angle_toleranceModel.average_heightModel.average_height_above_groundModel.average_story_countModel.average_story_count_above_groundModel.buildingsModel.context_shadesModel.display_nameModel.exterior_aperture_areaModel.exterior_wall_areaModel.floor_areaModel.footprint_areaModel.full_idModel.identifierModel.maxModel.minModel.propertiesModel.room_2dsModel.room_3dsModel.storiesModel.toModel.toleranceModel.unitsModel.user_dataModel.volumeBuildingProperties
ContextShadePropertiesContextShadeProperties.ToString()ContextShadeProperties.add_prefix()ContextShadeProperties.from_honeybee()ContextShadeProperties.move()ContextShadeProperties.reflect()ContextShadeProperties.rotate_xy()ContextShadeProperties.scale()ContextShadeProperties.to_dict()ContextShadeProperties.to_honeybee()ContextShadeProperties.hostModelProperties
Room2DProperties
StoryProperties
RoofSpecificationRoofSpecification.ToString()RoofSpecification.align()RoofSpecification.duplicate()RoofSpecification.from_dict()RoofSpecification.move()RoofSpecification.overlap_count()RoofSpecification.reflect()RoofSpecification.rotate_xy()RoofSpecification.scale()RoofSpecification.snap_to_grid()RoofSpecification.to_dict()RoofSpecification.update_geometry_2d()RoofSpecification.update_geometry_3d()RoofSpecification.boundary_geometry_2dRoofSpecification.geometryRoofSpecification.has_parentRoofSpecification.maxRoofSpecification.minRoofSpecification.parentRoofSpecification.planesRoom2DRoom2D.ToString()Room2D.add_prefix()Room2D.align()Room2D.check_degenerate()Room2D.check_horizontal()Room2D.check_self_intersecting()Room2D.check_window_parameters_valid()Room2D.coordinate_room_2d_vertices()Room2D.duplicate()Room2D.find_adjacency()Room2D.floor_segment_by_index()Room2D.from_dict()Room2D.from_honeybee()Room2D.from_polygon()Room2D.from_vertices()Room2D.generate_alignment_axes()Room2D.generate_grid()Room2D.group_by_adjacency()Room2D.group_by_air_boundary_adjacency()Room2D.grouped_horizontal_boundary()Room2D.intersect_adjacency()Room2D.join_by_boundary()Room2D.join_room_2ds()Room2D.label_point()Room2D.move()Room2D.offset_skylight_parameters()Room2D.pull_to_polygon()Room2D.pull_to_polyline()Room2D.pull_to_room_2d()Room2D.reflect()Room2D.remove_colinear_vertices()Room2D.remove_degenerate_holes()Room2D.remove_duplicate_vertices()Room2D.remove_short_segments()Room2D.remove_small_holes()Room2D.reset_adjacency()Room2D.rotate_xy()Room2D.scale()Room2D.segment_orientations()Room2D.set_adjacency()Room2D.set_air_boundary()Room2D.set_boundary_condition()Room2D.set_outdoor_shading_parameters()Room2D.set_outdoor_window_parameters()Room2D.set_window_parameter()Room2D.snap_to_grid()Room2D.snap_to_line_end_points()Room2D.solve_adjacency()Room2D.to_core_perimeter()Room2D.to_dict()Room2D.to_honeybee()Room2D.to_rectangular_windows()Room2D.update_floor_geometry()Room2D.air_boundariesRoom2D.boundary_conditionsRoom2D.ceiling_heightRoom2D.centerRoom2D.display_nameRoom2D.exterior_aperture_areaRoom2D.exterior_wall_areaRoom2D.floor_areaRoom2D.floor_geometryRoom2D.floor_heightRoom2D.floor_segmentsRoom2D.floor_segments_2dRoom2D.floor_to_ceiling_heightRoom2D.full_idRoom2D.has_parentRoom2D.identifierRoom2D.interior_wall_areaRoom2D.is_coreRoom2D.is_ground_contactRoom2D.is_perimeterRoom2D.is_top_exposedRoom2D.maxRoom2D.minRoom2D.parentRoom2D.propertiesRoom2D.segment_countRoom2D.segment_normalsRoom2D.shading_parametersRoom2D.skylight_parametersRoom2D.toRoom2D.user_dataRoom2D.volumeRoom2D.window_parametersExtrudedBorder
LouversByCountLouversByCount.ToString()LouversByCount.add_shading_to_face()LouversByCount.duplicate()LouversByCount.from_dict()LouversByCount.scale()LouversByCount.to_dict()LouversByCount.angleLouversByCount.contour_vectorLouversByCount.depthLouversByCount.flip_start_sideLouversByCount.louver_countLouversByCount.offsetLouversByDistanceLouversByDistance.ToString()LouversByDistance.add_shading_to_face()LouversByDistance.duplicate()LouversByDistance.from_dict()LouversByDistance.scale()LouversByDistance.to_dict()LouversByDistance.angleLouversByDistance.contour_vectorLouversByDistance.depthLouversByDistance.distanceLouversByDistance.flip_start_sideLouversByDistance.offsetOverhang
DetailedSkylightsDetailedSkylights.ToString()DetailedSkylights.add_skylight_to_face()DetailedSkylights.area_from_face()DetailedSkylights.check_overlaps()DetailedSkylights.check_self_intersecting()DetailedSkylights.check_valid_for_face()DetailedSkylights.duplicate()DetailedSkylights.from_dict()DetailedSkylights.merge_and_simplify()DetailedSkylights.merge_to_bounding_rectangle()DetailedSkylights.move()DetailedSkylights.offset_polygons_for_face()DetailedSkylights.reflect()DetailedSkylights.rotate()DetailedSkylights.scale()DetailedSkylights.to_dict()DetailedSkylights.union_overlaps()DetailedSkylights.are_doorsDetailedSkylights.polygonsGriddedSkylightArea
GriddedSkylightRatioGriddedSkylightRatio.ToString()GriddedSkylightRatio.add_skylight_to_face()GriddedSkylightRatio.area_from_face()GriddedSkylightRatio.duplicate()GriddedSkylightRatio.from_dict()GriddedSkylightRatio.scale()GriddedSkylightRatio.to_dict()GriddedSkylightRatio.skylight_ratioGriddedSkylightRatio.spacingStoryStory.ToString()Story.add_prefix()Story.add_room_2d()Story.add_room_2ds()Story.align()Story.align_room_2ds()Story.check_missing_adjacencies()Story.check_no_roof_overlaps()Story.check_no_room2d_overlaps()Story.delete_degenerate_room_2ds()Story.duplicate()Story.floor_geometry()Story.footprint()Story.from_dict()Story.from_honeybee()Story.generate_grid()Story.intersect_room_2d_adjacency()Story.make_underground()Story.move()Story.outline_polylines()Story.outline_segments()Story.rebuild_detailed_windows()Story.reflect()Story.remove_room_2d_colinear_vertices()Story.remove_room_2d_duplicate_vertices()Story.remove_room_2d_short_segments()Story.reset_adjacency()Story.reset_room_2d_boundaries()Story.room_2d_story_geometry_valid()Story.room_by_identifier()Story.rooms_by_identifier()Story.rotate_xy()Story.scale()Story.set_ground_contact()Story.set_outdoor_shading_parameters()Story.set_outdoor_window_parameters()Story.set_top_exposed()Story.set_top_exposed_by_story_above()Story.shade_representation()Story.shade_representation_multiplier()Story.solve_room_2d_adjacency()Story.split_with_story_above()Story.suggested_alignment_axes()Story.to_dict()Story.to_honeybee()Story.to_rectangular_windows()Story.display_nameStory.exterior_aperture_areaStory.exterior_wall_areaStory.floor_areaStory.floor_heightStory.floor_to_floor_heightStory.full_idStory.has_parentStory.identifierStory.is_above_groundStory.maxStory.minStory.multiplierStory.parentStory.propertiesStory.roofStory.room_2dsStory.toStory.user_dataStory.volumeDetailedWindowsDetailedWindows.ToString()DetailedWindows.add_window_to_face()DetailedWindows.adjust_for_segment()DetailedWindows.area_from_segment()DetailedWindows.check_self_intersecting()DetailedWindows.check_valid_for_segment()DetailedWindows.check_window_overlaps()DetailedWindows.duplicate()DetailedWindows.flip()DetailedWindows.from_dict()DetailedWindows.from_face3ds()DetailedWindows.is_face3d_in_segment_plane()DetailedWindows.is_flipped_equivalent()DetailedWindows.merge()DetailedWindows.merge_and_simplify()DetailedWindows.merge_to_bounding_rectangle()DetailedWindows.merge_to_rectangular()DetailedWindows.scale()DetailedWindows.split()DetailedWindows.to_dict()DetailedWindows.to_rectangular_windows()DetailedWindows.union_overlaps()DetailedWindows.are_doorsDetailedWindows.polygonsDetailedWindows.user_dataRectangularWindowsRectangularWindows.ToString()RectangularWindows.add_window_to_face()RectangularWindows.area_from_segment()RectangularWindows.check_valid_for_segment()RectangularWindows.check_window_overlaps()RectangularWindows.duplicate()RectangularWindows.flip()RectangularWindows.from_dict()RectangularWindows.merge()RectangularWindows.merge_to_rectangular()RectangularWindows.scale()RectangularWindows.split()RectangularWindows.to_dict()RectangularWindows.to_rectangular_windows()RectangularWindows.are_doorsRectangularWindows.heightsRectangularWindows.originsRectangularWindows.user_dataRectangularWindows.widthsRepeatingWindowRatioRepeatingWindowRatio.ToString()RepeatingWindowRatio.add_window_to_face()RepeatingWindowRatio.area_from_segment()RepeatingWindowRatio.duplicate()RepeatingWindowRatio.from_dict()RepeatingWindowRatio.merge()RepeatingWindowRatio.merge_to_rectangular()RepeatingWindowRatio.scale()RepeatingWindowRatio.split()RepeatingWindowRatio.to_dict()RepeatingWindowRatio.to_rectangular_windows()RepeatingWindowRatio.horizontal_separationRepeatingWindowRatio.sill_heightRepeatingWindowRatio.user_dataRepeatingWindowRatio.vertical_separationRepeatingWindowRatio.window_heightRepeatingWindowRatio.window_ratioRepeatingWindowWidthHeightRepeatingWindowWidthHeight.ToString()RepeatingWindowWidthHeight.add_window_to_face()RepeatingWindowWidthHeight.area_from_segment()RepeatingWindowWidthHeight.duplicate()RepeatingWindowWidthHeight.from_dict()RepeatingWindowWidthHeight.merge()RepeatingWindowWidthHeight.merge_to_rectangular()RepeatingWindowWidthHeight.scale()RepeatingWindowWidthHeight.split()RepeatingWindowWidthHeight.to_dict()RepeatingWindowWidthHeight.to_rectangular_windows()RepeatingWindowWidthHeight.horizontal_separationRepeatingWindowWidthHeight.sill_heightRepeatingWindowWidthHeight.user_dataRepeatingWindowWidthHeight.window_heightRepeatingWindowWidthHeight.window_widthSimpleWindowAreaSimpleWindowArea.ToString()SimpleWindowArea.add_window_to_face()SimpleWindowArea.area_from_segment()SimpleWindowArea.duplicate()SimpleWindowArea.from_dict()SimpleWindowArea.merge()SimpleWindowArea.merge_to_rectangular()SimpleWindowArea.scale()SimpleWindowArea.split()SimpleWindowArea.to_dict()SimpleWindowArea.to_rectangular_windows()SimpleWindowArea.user_dataSimpleWindowArea.window_areaSimpleWindowRatioSimpleWindowRatio.ToString()SimpleWindowRatio.add_window_to_face()SimpleWindowRatio.area_from_segment()SimpleWindowRatio.duplicate()SimpleWindowRatio.from_dict()SimpleWindowRatio.merge()SimpleWindowRatio.merge_to_rectangular()SimpleWindowRatio.scale()SimpleWindowRatio.split()SimpleWindowRatio.to_dict()SimpleWindowRatio.to_rectangular_windows()SimpleWindowRatio.user_dataSimpleWindowRatio.window_ratioSingleWindowSingleWindow.ToString()SingleWindow.add_window_to_face()SingleWindow.area_from_segment()SingleWindow.duplicate()SingleWindow.from_dict()SingleWindow.merge()SingleWindow.merge_to_rectangular()SingleWindow.scale()SingleWindow.split()SingleWindow.to_dict()SingleWindow.to_rectangular_windows()SingleWindow.heightSingleWindow.sill_heightSingleWindow.user_dataSingleWindow.width