CLI Docs¶
Installation¶
To check if the command line is installed correctly use dragonfly-energy --help
ThermalConnectorThermalConnector.ToString()ThermalConnector.duplicate()ThermalConnector.from_dict()ThermalConnector.from_dict_abridged()ThermalConnector.from_geojson_dict()ThermalConnector.move()ThermalConnector.reflect()ThermalConnector.reverse()ThermalConnector.rotate_xy()ThermalConnector.scale()ThermalConnector.to_dict()ThermalConnector.to_geojson_dict()ThermalConnector.display_nameThermalConnector.geometryThermalConnector.identifierBoreholeParameter
FluidParameter
GroundHeatExchangerGroundHeatExchanger.ToString()GroundHeatExchanger.duplicate()GroundHeatExchanger.from_dict()GroundHeatExchanger.from_geojson_dict()GroundHeatExchanger.move()GroundHeatExchanger.reflect()GroundHeatExchanger.rotate_xy()GroundHeatExchanger.scale()GroundHeatExchanger.to_dict()GroundHeatExchanger.to_geojson_dict()GroundHeatExchanger.display_nameGroundHeatExchanger.geometryGroundHeatExchanger.identifierPipeParameter
SoilParameter
ThermalJunctionThermalJunction.ToString()ThermalJunction.duplicate()ThermalJunction.move()ThermalJunction.reflect()ThermalJunction.rotate_xy()ThermalJunction.scale()ThermalJunction.to_geojson_dict()ThermalJunction.building_identifierThermalJunction.display_nameThermalJunction.geometryThermalJunction.identifierThermalJunction.system_identifierFourthGenThermalLoopFourthGenThermalLoop.ToString()FourthGenThermalLoop.duplicate()FourthGenThermalLoop.from_dict()FourthGenThermalLoop.to_des_param_dict()FourthGenThermalLoop.to_dict()FourthGenThermalLoop.chilled_water_setpointFourthGenThermalLoop.display_nameFourthGenThermalLoop.hot_water_setpointFourthGenThermalLoop.identifierGHEThermalLoopGHEThermalLoop.ToString()GHEThermalLoop.assign_junction_buildings()GHEThermalLoop.convert_to_units()GHEThermalLoop.duplicate()GHEThermalLoop.from_dict()GHEThermalLoop.from_geojson()GHEThermalLoop.junctions()GHEThermalLoop.loop_polygon()GHEThermalLoop.move()GHEThermalLoop.ordered_connectors()GHEThermalLoop.reflect()GHEThermalLoop.rotate_xy()GHEThermalLoop.scale()GHEThermalLoop.to_des_param_dict()GHEThermalLoop.to_dict()GHEThermalLoop.to_geojson_dict()GHEThermalLoop.to_ghe_param_dict()GHEThermalLoop.borehole_parametersGHEThermalLoop.clockwise_flowGHEThermalLoop.connectorsGHEThermalLoop.display_nameGHEThermalLoop.fluid_parametersGHEThermalLoop.ground_heat_exchangersGHEThermalLoop.identifierGHEThermalLoop.pipe_parametersGHEThermalLoop.soil_parametersColorNetworkColorNetwork.ToString()ColorNetwork.attr_nameColorNetwork.attr_name_endColorNetwork.attributesColorNetwork.attributes_originalColorNetwork.attributes_uniqueColorNetwork.geometriesColorNetwork.graphic_containerColorNetwork.legend_parametersColorNetwork.max_pointColorNetwork.min_pointColorNetwork.networkColorNetworkResultsColorNetworkResults.ToString()ColorNetworkResults.time_interval_text()ColorNetworkResults.analysis_periodColorNetworkResults.attributeColorNetworkResults.data_collectionsColorNetworkResults.data_typeColorNetworkResults.geometriesColorNetworkResults.graphic_containerColorNetworkResults.legend_parametersColorNetworkResults.matched_dataColorNetworkResults.matched_geometriesColorNetworkResults.matched_valuesColorNetworkResults.max_pointColorNetworkResults.min_pointColorNetworkResults.networkColorNetworkResults.title_textColorNetworkResults.unitElectricalConnectorElectricalConnector.ToString()ElectricalConnector.duplicate()ElectricalConnector.from_dict()ElectricalConnector.from_dict_abridged()ElectricalConnector.from_rnm_geojson_dict()ElectricalConnector.move()ElectricalConnector.reflect()ElectricalConnector.rotate_xy()ElectricalConnector.scale()ElectricalConnector.to_dict()ElectricalConnector.to_geojson_dict()ElectricalConnector.display_nameElectricalConnector.geometryElectricalConnector.identifierElectricalConnector.nominal_voltageElectricalConnector.phase_countElectricalConnector.power_lineElectricalJunctionElectricalJunction.ToString()ElectricalJunction.duplicate()ElectricalJunction.move()ElectricalJunction.reflect()ElectricalJunction.rotate_xy()ElectricalJunction.scale()ElectricalJunction.to_geojson_dict()ElectricalJunction.building_identifierElectricalJunction.display_nameElectricalJunction.geometryElectricalJunction.identifierElectricalJunction.system_identifierElectricalNetworkElectricalNetwork.ToString()ElectricalNetwork.assign_junction_buildings()ElectricalNetwork.convert_to_units()ElectricalNetwork.duplicate()ElectricalNetwork.from_dict()ElectricalNetwork.from_rnm_geojson()ElectricalNetwork.junctions()ElectricalNetwork.move()ElectricalNetwork.reflect()ElectricalNetwork.rotate_xy()ElectricalNetwork.scale()ElectricalNetwork.to_dict()ElectricalNetwork.to_electrical_database_dict()ElectricalNetwork.to_geojson_dict()ElectricalNetwork.connectorsElectricalNetwork.display_nameElectricalNetwork.identifierElectricalNetwork.power_linesElectricalNetwork.substationElectricalNetwork.transformer_propertiesElectricalNetwork.transformersElectricalNetwork.wiresRoadNetwork
PowerLinePowerLine.ToString()PowerLine.duplicate()PowerLine.from_dict()PowerLine.from_dict_abridged()PowerLine.from_electrical_database_dict()PowerLine.lock()PowerLine.to_dict()PowerLine.to_electrical_database_dict()PowerLine.unlock()PowerLine.VALID_PHASESPowerLine.display_namePowerLine.heightsPowerLine.identifierPowerLine.nominal_voltagePowerLine.phase_countPowerLine.phasesPowerLine.relative_xsPowerLine.wire_countPowerLine.wire_idsPowerLine.wiresTransformerTransformer.ToString()Transformer.duplicate()Transformer.from_dict()Transformer.from_dict_abridged()Transformer.from_rnm_geojson_dict()Transformer.move()Transformer.reflect()Transformer.rotate_xy()Transformer.scale()Transformer.to_dict()Transformer.to_geojson_dict()Transformer.display_nameTransformer.geometryTransformer.identifierTransformer.nominal_voltageTransformer.phase_countTransformer.propertiesTransformerPropertiesTransformerProperties.ToString()TransformerProperties.duplicate()TransformerProperties.from_dict()TransformerProperties.from_electrical_database_dict()TransformerProperties.lock()TransformerProperties.to_dict()TransformerProperties.to_electrical_database_dict()TransformerProperties.unlock()TransformerProperties.VALID_CONNECTIONSTransformerProperties.connectionTransformerProperties.display_nameTransformerProperties.high_voltageTransformerProperties.identifierTransformerProperties.is_center_tapTransformerProperties.kvaTransformerProperties.low_voltageTransformerProperties.phase_countTransformerProperties.reactanceTransformerProperties.resistanceConcentricPropertiesConcentricProperties.ToString()ConcentricProperties.duplicate()ConcentricProperties.from_dict()ConcentricProperties.lock()ConcentricProperties.to_dict()ConcentricProperties.unlock()ConcentricProperties.concentric_outside_diameterConcentricProperties.concentric_strand_diameterConcentricProperties.geometrical_mean_radiusConcentricProperties.resistanceConcentricProperties.strand_countWireWire.ToString()Wire.duplicate()Wire.from_dict()Wire.from_electrical_database_dict()Wire.lock()Wire.to_dict()Wire.to_electrical_database_dict()Wire.unlock()Wire.VALID_VOLTAGE_LEVELSWire.VALID_WIRE_TYPESWire.ampacityWire.concentric_propertiesWire.diameterWire.display_nameWire.geometrical_mean_radiusWire.identifierWire.resistanceWire.voltage_levelWire.wire_typeBuildingEnergyPropertiesBuildingEnergyProperties.ToString()BuildingEnergyProperties.add_default_ideal_air()BuildingEnergyProperties.apply_properties_from_dict()BuildingEnergyProperties.apply_properties_from_geojson_dict()BuildingEnergyProperties.averaged_program_type()BuildingEnergyProperties.diversify()BuildingEnergyProperties.duplicate()BuildingEnergyProperties.from_dict()BuildingEnergyProperties.set_all_program_type_from_building_type()BuildingEnergyProperties.set_all_room_2d_hvac()BuildingEnergyProperties.set_all_room_2d_program_type()BuildingEnergyProperties.set_all_room_2d_shw()BuildingEnergyProperties.to_dict()BuildingEnergyProperties.construction_setBuildingEnergyProperties.hostContextShadeEnergyPropertiesContextShadeEnergyProperties.ToString()ContextShadeEnergyProperties.apply_properties_from_dict()ContextShadeEnergyProperties.duplicate()ContextShadeEnergyProperties.from_dict()ContextShadeEnergyProperties.from_honeybee()ContextShadeEnergyProperties.to_dict()ContextShadeEnergyProperties.to_honeybee()ContextShadeEnergyProperties.constructionContextShadeEnergyProperties.hostContextShadeEnergyProperties.is_construction_set_by_userContextShadeEnergyProperties.transmittance_scheduleModelEnergyPropertiesModelEnergyProperties.ToString()ModelEnergyProperties.apply_properties_from_dict()ModelEnergyProperties.check_all()ModelEnergyProperties.check_duplicate_construction_set_identifiers()ModelEnergyProperties.check_duplicate_hvac_identifiers()ModelEnergyProperties.check_duplicate_program_type_identifiers()ModelEnergyProperties.check_duplicate_shw_identifiers()ModelEnergyProperties.duplicate()ModelEnergyProperties.to_dict()ModelEnergyProperties.to_honeybee()ModelEnergyProperties.construction_schedulesModelEnergyProperties.construction_setsModelEnergyProperties.constructionsModelEnergyProperties.face_constructionsModelEnergyProperties.global_construction_setModelEnergyProperties.hostModelEnergyProperties.hvac_schedulesModelEnergyProperties.hvacsModelEnergyProperties.materialsModelEnergyProperties.misc_room_schedulesModelEnergyProperties.program_type_schedulesModelEnergyProperties.program_typesModelEnergyProperties.schedule_type_limitsModelEnergyProperties.schedulesModelEnergyProperties.shade_constructionsModelEnergyProperties.shade_schedulesModelEnergyProperties.shwsRoom2DEnergyPropertiesRoom2DEnergyProperties.ToString()Room2DEnergyProperties.add_default_ideal_air()Room2DEnergyProperties.add_process_load()Room2DEnergyProperties.apply_properties_from_dict()Room2DEnergyProperties.duplicate()Room2DEnergyProperties.from_dict()Room2DEnergyProperties.from_honeybee()Room2DEnergyProperties.remove_process_loads()Room2DEnergyProperties.to_dict()Room2DEnergyProperties.to_honeybee()Room2DEnergyProperties.construction_setRoom2DEnergyProperties.has_window_openingRoom2DEnergyProperties.hostRoom2DEnergyProperties.hvacRoom2DEnergyProperties.is_conditionedRoom2DEnergyProperties.process_loadsRoom2DEnergyProperties.program_typeRoom2DEnergyProperties.shwRoom2DEnergyProperties.total_process_loadRoom2DEnergyProperties.window_vent_controlRoom2DEnergyProperties.window_vent_openingStoryEnergyPropertiesStoryEnergyProperties.ToString()StoryEnergyProperties.add_default_ideal_air()StoryEnergyProperties.apply_properties_from_dict()StoryEnergyProperties.averaged_program_type()StoryEnergyProperties.duplicate()StoryEnergyProperties.from_dict()StoryEnergyProperties.set_all_room_2d_hvac()StoryEnergyProperties.set_all_room_2d_program_type()StoryEnergyProperties.set_all_room_2d_shw()StoryEnergyProperties.to_dict()StoryEnergyProperties.construction_setStoryEnergyProperties.hostFoldersFolders.check_urbanopt_version()Folders.generate_urbanopt_env_path()Folders.COMPATIBILITY_URLFolders.URBANOPT_VERSIONFolders.config_fileFolders.docker_versionFolders.docker_version_strFolders.mapper_pathFolders.reopt_assumptions_pathFolders.urbanopt_cli_pathFolders.urbanopt_env_pathFolders.urbanopt_gemfile_pathFolders.urbanopt_versionFolders.urbanopt_version_strMapperMeasureMapperMeasure.ToString()MapperMeasure.from_dict()MapperMeasure.sort_measures()MapperMeasure.to_dict()MapperMeasure.to_osw_dict()MapperMeasure.validate()MapperMeasure.argumentsMapperMeasure.descriptionMapperMeasure.display_nameMapperMeasure.folderMapperMeasure.identifierMapperMeasure.metadata_fileMapperMeasure.program_fileMapperMeasure.resources_folderMapperMeasure.typeMapperMeasureArgumentMapperMeasureArgument.ToString()MapperMeasureArgument.validate()MapperMeasureArgument.PYTHON_TYPESMapperMeasureArgument.default_valueMapperMeasureArgument.descriptionMapperMeasureArgument.display_nameMapperMeasureArgument.identifierMapperMeasureArgument.model_dependentMapperMeasureArgument.requiredMapperMeasureArgument.typeMapperMeasureArgument.type_textMapperMeasureArgument.valid_choicesMapperMeasureArgument.valueFinancialParameter
GeneratorParameter
GroundMountPVGroundMountPV.ToString()GroundMountPV.duplicate()GroundMountPV.from_dict()GroundMountPV.move()GroundMountPV.reflect()GroundMountPV.rotate_xy()GroundMountPV.scale()GroundMountPV.to_dict()GroundMountPV.to_geojson_dict()GroundMountPV.building_identifierGroundMountPV.display_nameGroundMountPV.geometryGroundMountPV.identifierPVParameter
REoptParameter
StorageParameter
WindParameter