{"id":30895480,"url":"https://github.com/ladybug-tools/dragonfly-energy","last_synced_at":"2026-06-01T01:01:50.922Z","repository":{"id":37493216,"uuid":"217591299","full_name":"ladybug-tools/dragonfly-energy","owner":"ladybug-tools","description":":dragon: :fire: Dragonfly extension for energy simulation","archived":false,"fork":false,"pushed_at":"2026-03-27T23:53:12.000Z","size":3618,"stargazers_count":9,"open_issues_count":1,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2026-03-28T05:54:50.915Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.ladybug.tools/dragonfly-energy/docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ladybug-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-10-25T18:18:01.000Z","updated_at":"2026-03-27T23:51:06.000Z","dependencies_parsed_at":"2023-10-14T21:14:35.193Z","dependency_job_id":"3589ae66-78be-4a3d-93ac-2b72c46f96d1","html_url":"https://github.com/ladybug-tools/dragonfly-energy","commit_stats":{"total_commits":1584,"total_committers":7,"mean_commits":"226.28571428571428","dds":"0.49368686868686873","last_synced_commit":"ed7fb93cc2a362917f44e0260f5006001f8b93e7"},"previous_names":[],"tags_count":1637,"template":false,"template_full_name":null,"purl":"pkg:github/ladybug-tools/dragonfly-energy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fdragonfly-energy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fdragonfly-energy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fdragonfly-energy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fdragonfly-energy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladybug-tools","download_url":"https://codeload.github.com/ladybug-tools/dragonfly-energy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fdragonfly-energy/sbom","scorecard":{"id":426479,"data":{"date":"2025-08-11","repo":{"name":"github.com/ladybug-tools/dragonfly-energy","commit":"c82289ef0b5aced7d3236b06cc8f34f626d7ea33"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.3,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yaml:1","Warn: no topLevel permission defined: .github/workflows/dependency-release.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU Affero General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:112: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:123: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependency-release.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/dependency-release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependency-release.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/dragonfly-energy/dependency-release.yaml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.10-slim to python:3.10-slim@sha256:420fbb0e468d3eaf0f7e93ea6f7a48792cbcadc39d43ac95b96bee2afe4367da","Warn: pipCommand not pinned by hash: Dockerfile:32-37","Warn: pipCommand not pinned by hash: Dockerfile:32-37","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:37","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:38","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:39","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:40","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:61","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:62","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:63","Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:67","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:117","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:118","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of  11 pipCommand dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/ci.yaml:44"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2013-22 / GHSA-27x4-j476-jp5f","Warn: Project is vulnerable to: PYSEC-2025-49 / GHSA-5rjg-fvgr-3xxf","Warn: Project is vulnerable to: GHSA-cx63-2mw6-8hw5","Warn: Project is vulnerable to: PYSEC-2022-43012 / GHSA-r9hx-vwmv-q579","Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T02:20:54.282Z","repository_id":37493216,"created_at":"2025-08-19T02:20:54.282Z","updated_at":"2025-08-19T02:20:54.282Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31291549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-08T22:06:38.838Z","updated_at":"2026-04-01T20:23:54.126Z","avatar_url":"https://github.com/ladybug-tools.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png)\n\n[![Build Status](https://github.com/ladybug-tools/dragonfly-energy/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-energy/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-energy/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-energy)\n\n[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# dragonfly-energy\n\nDragonfly extension for energy simulation, including integration with the \n[EnergyPlus](https://github.com/NREL/EnergyPlus) simulation engine, the \n[OpenStudio](https://github.com/NREL/OpenStudio) SDK, and the\n[URBANopt](https://docs.urbanopt.net/) SDK.\n\n## Installation\n\n`pip install dragonfly-energy`\n\nTo check if Dragonfly command line interface is installed correctly\nuse `dragonfly-energy --help`.\n\n## QuickStart\n\n```python\nimport dragonfly_energy\n```\n\n## [API Documentation](http://ladybug-tools.github.io/dragonfly-energy/docs)\n\n## Usage\nSince the building geometry in dragonfly is fundamentally 2D, creating a model of\na building and assigning energy model properties can be done with a few lines of\ncode. Here is an example:\n\n```python\nfrom dragonfly.model import Model\nfrom dragonfly.building import Building\nfrom dragonfly.story import Story\nfrom dragonfly.room2d import Room2D\nfrom dragonfly.windowparameter import SimpleWindowRatio\nfrom honeybee_energy.lib.programtypes import office_program\n\n# create the Building object\npts_1 = (Point3D(0, 0, 3), Point3D(0, 10, 3), Point3D(10, 10, 3), Point3D(10, 0, 3))\npts_2 = (Point3D(10, 0, 3), Point3D(10, 10, 3), Point3D(20, 10, 3), Point3D(20, 0, 3))\npts_3 = (Point3D(0, 10, 3), Point3D(0, 20, 3), Point3D(10, 20, 3), Point3D(10, 10, 3))\npts_4 = (Point3D(10, 10, 3), Point3D(10, 20, 3), Point3D(20, 20, 3), Point3D(20, 10, 3))\nroom2d_1 = Room2D('Office1', Face3D(pts_1), 3)\nroom2d_2 = Room2D('Office2', Face3D(pts_2), 3)\nroom2d_3 = Room2D('Office3', Face3D(pts_3), 3)\nroom2d_4 = Room2D('Office4', Face3D(pts_4), 3)\nstory = Story('OfficeFloor', [room2d_1, room2d_2, room2d_3, room2d_4])\nstory.solve_room_2d_adjacency(0.01)\nstory.set_outdoor_window_parameters(SimpleWindowRatio(0.4))\nstory.multiplier = 4\nbuilding = Building('OfficeBuilding', [story])\n\n# assign energy properties\nfor room in story.room_2ds:\n    room.properties.energy.program_type = office_program\n    room.properties.energy.add_default_ideal_air()\n\n# create the Model object\nmodel = Model('NewDevelopment', [building])\n```\n\nOnce a Dragonfly Model has been created, it can be converted to a honeybee Model,\nwhich can then be converted to IDF format like so:\n\n```python\n# create the dragonfly Model object\nmodel = Model('NewDevelopment', [building])\n\n# serialize the dragonfly Model to Honeybee Models and convert them to IDF\nhb_models = model.to_honeybee('Building', use_multiplier=False, tolerance=0.01)\nidfs = [hb_model.to.idf(hb_model) for hb_model in hb_models]\n```\n\nThe dragonfly model can also be serialized to a geoJSON to be simulated with URBANopt.\n\n```python\nfrom ladybug.location import Location\n\n# create the dragonfly Model object\nmodel = Model('NewDevelopment', [building])\n\n# create a location for the geoJSON and write it to a folder\nlocation = Location('Boston', 'MA', 'USA', 42.366151, -71.019357)\nsim_folder = './tests/urbanopt_model'\ngeojson, hb_model_jsons, hb_models = model.to.urbanopt(model, location, folder=sim_folder)\n```\n\n## Local Development\n\n1. Clone this repo locally\n```\ngit clone git@github.com:ladybug-tools/dragonfly-energy\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-energy\n```\n2. Install dependencies:\n```\ncd dragonfly-energy\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```\nsphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_energy\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fdragonfly-energy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladybug-tools%2Fdragonfly-energy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fdragonfly-energy/lists"}