Registry / data / dragonfly-core

dragonfly-core

library1.76.2pypypi✓ verified 85d ago

Dragonfly Core is the core Python library for urban-scale energy modeling, part of the Ladybug Tools ecosystem. It provides objects for building stories, districts, and urban models that can be converted to Honeybee for detailed simulation. Current version 1.76.2, with frequent releases (weekly) and active maintenance.

data web-framework

pip install dragonfly-core

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DRAGONFLY-CORE

dragonfly-core

datapythonv1.76.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Building

✓ from dragonfly.building import Building

✗ import dragonfly.Building

Building is in a submodule; direct import fails.

Story

✓ from dragonfly.story import Story

✗ from dragonfly import Story

Story is not exposed at the top-level package init.

DragonflyModel

✓ from dragonfly.model import DragonflyModel

No common wrong import.

Create a simple Dragonfly model with a single building and story.

from dragonfly.building import Building from dragonfly.story import Story from dragonfly.model import DragonflyModel # Create a simple rectangular building with one story story = Story.from_rect('Story1', width=10, height=5, floor_height=3) building = Building('Building1', unique_stories=[story], floor_to_floor_height=3.0) model = DragonflyModel('MyModel', buildings=[building]) print(model.to_dict())

Debug

Known issues

breakingIn v1.76.0, Clearstory objects were added and roof assignment methods changed. Code that directly manipulates roof subfaces may need updates.

fix

Use new 'assign_clearstory' methods on RoofSpecification; avoid direct subface manipulation.

affects: >=1.76.0

gotchaDragonfly uses meters internally. Coordinates and dimensions must be in meters; incorrect units lead to scaling errors.

fix

Ensure all coordinate and dimension inputs are in meters (m). Convert from feet or other units before passing.

affects: all

deprecatedThe 'Building.stories' property is deprecated in favor of 'Building.unique_stories'. Using 'stories' may raise a deprecation warning in future releases.

fix

Replace 'building.stories' with 'building.unique_stories'.

affects: >=1.60.0

gotchaMultiPolygon geometries are not fully supported by URBANopt. Workaround exists in v1.75.35 but may cause conversion failures.

fix

Upgrade to >=1.75.35 for a partial workaround; avoid MultiPolygon if targeting URBANopt.

affects: <1.75.35

Errors

Common errors & fixes

ImportError: cannot import name 'Building' from 'dragonfly'

Importing from top-level package instead of submodule.

fix

Use 'from dragonfly.building import Building'

AttributeError: 'Building' object has no attribute 'stories'

Property 'stories' was renamed to 'unique_stories' in recent versions.

fix

Use 'building.unique_stories' instead of 'building.stories'

Upgrade

Version history

1.76.2latest on PyPI · released May 8, 2026

Audit

Dependencies

honeybee-corerequiredCore dependency for geometry, simulation, and conversion to Honeybee models.

dragonfly-schemarequiredSchema definitions for Dragonfly objects, required for serialization/deserialization.

ladybug-geometryrequiredUsed for geometric operations on 2D and 3D objects.

Agent activity

9 hits · last 30 days

node

Bingbot

OpenAI (training)

Resources

githubhttps://github.com/ladybug-tools/dragonfly-core ↗

packagehttps://pypi.org/project/dragonfly-core/ ↗

homepagehttps://www.ladybug.tools ↗