{"id":30895507,"url":"https://github.com/ladybug-tools/honeybee-energy-standards","last_synced_at":"2025-09-08T22:06:57.534Z","repository":{"id":35420134,"uuid":"216285661","full_name":"ladybug-tools/honeybee-energy-standards","owner":"ladybug-tools","description":"🐝 :fire: :books:  Honeybee-energy extension for standards, codes, and templates.","archived":false,"fork":false,"pushed_at":"2025-08-25T21:05:06.000Z","size":3434,"stargazers_count":5,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-25T23:20:48.312Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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}},"created_at":"2019-10-20T00:08:01.000Z","updated_at":"2025-08-25T21:05:10.000Z","dependencies_parsed_at":"2023-11-28T22:06:33.853Z","dependency_job_id":"b0c93dd5-4509-4a62-9bc0-cfef5f9e307b","html_url":"https://github.com/ladybug-tools/honeybee-energy-standards","commit_stats":{"total_commits":149,"total_committers":4,"mean_commits":37.25,"dds":0.3825503355704698,"last_synced_commit":"aa82091d48d2c2d5dec2345496798a8da31fd3ab"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/ladybug-tools/honeybee-energy-standards","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fhoneybee-energy-standards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fhoneybee-energy-standards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fhoneybee-energy-standards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fhoneybee-energy-standards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladybug-tools","download_url":"https://codeload.github.com/ladybug-tools/honeybee-energy-standards/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fhoneybee-energy-standards/sbom","scorecard":{"id":576879,"data":{"date":"2025-08-11","repo":{"name":"github.com/ladybug-tools/honeybee-energy-standards","commit":"f15ab939d27002caf3428ecbcded96f9f70a0679"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/27 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":"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":"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":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.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":"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":"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:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/honeybee-energy-standards/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/honeybee-energy-standards/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/honeybee-energy-standards/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/honeybee-energy-standards/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/ladybug-tools/honeybee-energy-standards/ci.yaml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:23","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:24","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:45","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:46","Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:50","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned","Info:   0 out of   4 pipCommand 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":"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":"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"}},{"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/ci.yaml:28"],"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":"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T18:05:18.275Z","repository_id":35420134,"created_at":"2025-08-20T18:05:18.275Z","updated_at":"2025-08-20T18:05:18.275Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274231549,"owners_count":25245659,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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:55.890Z","updated_at":"2025-09-08T22:06:57.525Z","avatar_url":"https://github.com/ladybug-tools.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://github.com/ladybug-tools/honeybee-energy-standards/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-energy-standards/actions)\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# honeybee-energy-standards\n\nHoneybee-energy extension for standards, codes, and templates.\n\nAll of the data that this module adds to the [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy).lib comes from the\n[OpenStudio Standards Gem](https://github.com/NREL/openstudio-standards) and the master\n[Google Sheets files](https://drive.google.com/drive/folders/1x7yEU4jnKw-gskLBih8IopStwl0KAMEi)\nthat possess all of the most recent data. The original sources of this data include the following:\n\n* The US Department of Energy [Commercial Reference Buildings](https://www.energy.gov/eere/buildings/commercial-reference-buildings).\n* The [ASHRAE Standard 90.1](https://www.ashrae.org/technical-resources/bookstore/standard-90-1) including all versions from 2004 to the present.\n* The [Commercial Buildings Energy Consumption Survey (CBECS)](https://www.eia.gov/consumption/commercial/), specifically for any templates before ASHRAE Standard 90.1 2004.\n\n## Installation\n\n```console\npip install honeybee-energy-standards\n```\n\n## QuickStart\n\n```python\nimport honeybee_energy_standards\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-energy-standards/docs)\n\n## Local Development\n\n1. Clone this repo locally\n\n```console\ngit clone git@github.com:ladybug-tools/honeybee-energy-standards\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-energy-standards\n```\n\n2. Install dependencies:\n\n```console\ncd honeybee-energy-standards\npip install -r dev-requirements.txt\n```\n\n3. Run Tests:\n\n```console\npython -m pytest tests/\n```\n\n4. Re-generate the Data from the [OpenStudio Standards Gem](https://github.com/NREL/openstudio-standards)\n(or to update the JSONs based on changes to the honeybee schema)\n\n```python\nfrom standards_update._util._all import clean_all, remove_all\nfrom standards_update._util._to_honeybee import convert_to_hb_json, remove_hb_jsons\n\nremove_hb_jsons()  # remove all of the honeybee JSON data that currently exists\n\n# generate clean OpenStudio Standards Data JSONs from the gem\nashrae_standards = 'C:/Users/chris/Documents/GitHub/nrel/openstudio-standards/lib/' \\\n    'openstudio-standards/standards/ashrae_90_1/'\nclean_all(ashrae_standards)\n\n# change the package to load all data from the clean Standards Gem JSONs\nimport standards_update._change_to_standards_data\n\nconvert_to_hb_json()  # generate Honeybee JSONs from the clean Standards Gem JSONs\nremove_all()  # remove all of the clean Standards Gem JSONs now that they're converted\n```\n\nThe resulting JSON data will be output to the data folder such that it can be\nchecked before copying it into honeybee_energy_standards.\n\n## Note to developers using this repo as an example\n\nDevelopers may use this repository and Python package as a template to create their\nown extensions for the library of standards accessible to honeybee_energy. For such\ndevelopers, it is important to know the rules that must be followed to have a\nsuccessful honeybee energy standards extension. First, any honeybee energy standards\nextension must have a package name the starts with `honeybee_energy` and ends\nwith `standards` (all words in between are up to the user, barring spaces and\nspecial characters).\n\nSecond, the following folders *MUST* be included in any honeybee energy standards\nextension:\n\n* `constructions`\n* `constructionsets`\n* `schedules`\n* `programtypes`\n\nThe following rules must be followed:\n\n* All JSONs must use the [Honeybee Model Schema](https://www.ladybug.tools/honeybee-schema/model.html)\n    representation of objects and must be formatted with the name of the object as keys\n    and the schema definition of the object as values.\n* The `constructions` sub-folder should contain the following files: `opaque_material.json`,\n    `opaque_construction.json`, `window_material.json`, `window_constructions.json`.\n    These files should possess objects that match their names.\n* The `schedules` sub-folder should have all schedules in a `schedule.json` file.\n* The `constructionsets` and `programtypes` folder can possess any number of JSON\n    files with their respective objects.\n* Any objects that make up larger objects must be present. For example, all of the\n    constructions that make up the objects in `constructionsets` must be found in the\n    `constructions` sub-folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fhoneybee-energy-standards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladybug-tools%2Fhoneybee-energy-standards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fhoneybee-energy-standards/lists"}