{"id":23630,"library":"dragonfly-energy","title":"Dragonfly Energy","description":"Dragonfly extension for energy simulation. Part of Ladybug Tools, it enables urban-scale energy modeling using EnergyPlus via Honeybee-Energy. Current version: 1.42.11. Regular releases (weekly).","status":"active","version":"1.42.11","language":"python","source_language":"en","source_url":"https://github.com/ladybug-tools/dragonfly-energy","tags":["ladybug-tools","energy-simulation","urban-modeling","energyplus","building-simulation"],"install":[{"cmd":"pip install dragonfly-energy","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core Dragonfly classes and geometry","package":"dragonfly-core","optional":false},{"reason":"Energy simulation engine interface (EnergyPlus)","package":"honeybee-energy","optional":false},{"reason":"Visualization and display utilities","package":"ladybug-display","optional":true}],"imports":[{"note":"Module is dragonfly_energy, not dragonfly.energy","wrong":"from dragonfly.energy import DragonflyEnergyProperties","symbol":"DragonflyEnergyProperties","correct":"from dragonfly_energy.properties import DragonflyEnergyProperties"},{"note":"Correct subpackage is simulation (not simulate)","wrong":"from dragonfly_energy.simulate import EnergySimulation","symbol":"EnergySimulation","correct":"from dragonfly_energy.simulation import EnergySimulation"},{"note":"","wrong":"","symbol":"SimulateModel","correct":"from dragonfly_energy.simulation import SimulateModel"}],"quickstart":{"code":"from dragonfly_energy.simulation import SimulateModel\nfrom ladybug.futil import preparedir\nfrom pathlib import Path\n\n# Create a simulation model\nmodel_path = Path('./model.dfjson')\nsim = SimulateModel(model_path)\nsim.run()\nprint(f'Simulation completed. Results in: {sim.output_folder}')","lang":"python","description":"Run an EnergyPlus simulation from a Dragonfly Model (DFJSON file)"},"warnings":[{"fix":"Upgrade Python to 3.8 or later","message":"Python 3.7 support dropped in v1.40.0. Only Python 3.8+ supported.","severity":"breaking","affected_versions":"^1.40.0"},{"fix":"Use 'simulation_type' instead of 'run_type'","message":"Deprecated attributes in SimulateModel changed names; old 'run_type' replaced by 'simulation_type'.","severity":"breaking","affected_versions":">=1.30.0 <1.40.0"},{"fix":"Replace Model.load_model(path, **kw) with Model.from_file(path, **kw)","message":"The 'Model.load_model' method is deprecated; use Model.from_file instead.","severity":"deprecated","affected_versions":">=1.35.0"},{"fix":"SimulateModel(model_path, overwrite=False)","message":"SimulateModel output folder is overwritten by default unless you set 'overwrite=False'.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use import dragonfly_energy instead of import dragonfly","cause":"Incorrect import path. The library is installed as dragonfly-energy but the import module is dragonfly_energy.","error":"ModuleNotFoundError: No module named 'dragonfly'"},{"fix":"Use simulation_type='as_expected' instead of run_type='as_expected'","cause":"Parameter renamed from 'run_type' to 'simulation_type' in v1.40.0.","error":"TypeError: SimulateModel.__init__() got an unexpected keyword argument 'run_type'"},{"fix":"Install EnergyPlus (e.g., via ladybug-tools/ladybug-docker) and ensure it's on PATH, or set environment variable ENERGYPLUS_DIR","cause":"EnergyPlus executable not installed or not in PATH.","error":"OSError: [Errno 2] No such file or directory: '.../EnergyPlus'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}