{"id":13723497,"url":"https://github.com/NREL/OpenStudio-HPXML","last_synced_at":"2025-05-07T16:32:58.521Z","repository":{"id":37251438,"uuid":"155930194","full_name":"NREL/OpenStudio-HPXML","owner":"NREL","description":"Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.","archived":false,"fork":false,"pushed_at":"2025-05-01T23:45:11.000Z","size":181164,"stargazers_count":52,"open_issues_count":145,"forks_count":24,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-05-02T00:26:18.208Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NREL.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"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":"2018-11-02T23:02:25.000Z","updated_at":"2025-05-01T21:18:41.000Z","dependencies_parsed_at":"2023-09-24T14:04:44.806Z","dependency_job_id":"87fcbd56-2e4c-46af-84b5-11d0ff006ba2","html_url":"https://github.com/NREL/OpenStudio-HPXML","commit_stats":{"total_commits":11603,"total_committers":16,"mean_commits":725.1875,"dds":0.5427906575885546,"last_synced_commit":"34fce414bfd4823944aa341bb1989c7eaac6b52c"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FOpenStudio-HPXML","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FOpenStudio-HPXML/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FOpenStudio-HPXML/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FOpenStudio-HPXML/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NREL","download_url":"https://codeload.github.com/NREL/OpenStudio-HPXML/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252072481,"owners_count":21690246,"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","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":"2024-08-03T01:01:42.275Z","updated_at":"2025-05-07T16:32:58.509Z","avatar_url":"https://github.com/NREL.png","language":"Ruby","funding_links":[],"categories":["Energy Consumption","Consumption"],"sub_categories":["Buildings and Cities","Buildings and Heating"],"readme":"# OpenStudio®-HPXML\n\n[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/NREL/OpenStudio-HPXML?include_prereleases)](https://github.com/NREL/OpenStudio-HPXML/releases)\n[![ci](https://github.com/NREL/OpenStudio-HPXML/actions/workflows/config.yml/badge.svg?branch=master)](https://github.com/NREL/OpenStudio-HPXML/actions/workflows/config.yml)\n[![Documentation Status](https://readthedocs.org/projects/openstudio-hpxml/badge/?version=latest)](https://openstudio-hpxml.readthedocs.io/en/latest/?badge=latest)\n\nOpenStudio-HPXML allows running residential [EnergyPlus™ simulations](https://energyplus.net/) using an [HPXML file](https://hpxml.nrel.gov/) for the building description.\nIt is intended to be used by user interfaces or other automated software workflows that automatically produce the HPXML file.\n\nOpenStudio-HPXML can accommodate a wide range of different building technologies and geometries.\nEnd-to-end simulations typically run in 3-10 seconds, depending on complexity, computer platform and speed, etc.\n\nFor more information on running simulations, generating HPXML files with the appropriate inputs to run EnergyPlus, etc., please visit the [documentation](https://openstudio-hpxml.readthedocs.io/en/latest).\n\n## Workflows\n\nA simple `run_simulation.rb` script is provided to run a residential EnergyPlus simulation from an HPXML file.\nSee the [Usage Instructions](https://openstudio-hpxml.readthedocs.io/en/latest/usage_instructions.html) for documentation on running the workflow.\n\nSince [OpenStudio measures](http://nrel.github.io/OpenStudio-user-documentation/getting_started/about_measures/) are used for model generation, additional OpenStudio-based workflows and interfaces can instead be used if desired.\n\n## Capabilities\n\nOpenStudio-HPXML capabilities include:\n- Modeling individual dwelling units or whole multifamily buildings\n- Modeling a wide range of building technologies\n- HVAC design load calculations and equipment autosizing\n- Occupancy schedules (smooth or stochastic)\n- Utility bill calculations (flat, tiered, time-of-use, real-time pricing, etc.)\n- Emissions calculations (CO2e, etc.)\n- Annual and timeseries outputs (energy, loads, temperatures, etc.)\n- Optional HPXML inputs with transparent defaults\n- Schematron and XSD Schema input validation\n- Can be used for [DOE HOMES program approval](https://www.energy.gov/scep/single-family-modeling-solutions-home-efficiency-rebates-program)\n- Can be used for [ACCA Manual J approval](https://www.acca.org/standards/approved-software)\n\n## Measures\n\nThis repository contains several OpenStudio measures:\n- `BuildResidentialHPXML`: A measure that generates an HPXML file from a set of building description inputs (including, e.g., simplified geometry inputs).\n- `BuildResidentialScheduleFile`: A measure that generates a CSV of detailed schedules (e.g., stochastic occupancy) for use in the simulation.\n- `HPXMLtoOpenStudio`: A measure that translates an HPXML file to an OpenStudio model.\n- `ReportSimulationOutput`: A reporting measure that generates a variety of simulation-based annual/timeseries outputs in CSV/JSON/MessagePack format.\n- `ReportUtilityBills`: A reporting measure that generates utility bill outputs in CSV/JSON/MessagePack format.\n\n## Users\n\nOpenStudio-HPXML is used by a number of software products or organizations, including:\n\n- [BEopt](https://beopt.nrel.gov)\n- [Clarity Heat Pump Toolkit](https://psdconsulting.com/solutions/)\n- [Energy Rating Index (ERI)](https://github.com/NREL/OpenStudio-ERI)\n- [Home Energy Score](https://www.homeenergyscore.gov)\n- [OptiMiser](https://optimiserenergy.com)\n- [Radiant Labs](https://www.radiantlabs.co)\n- [ResStock](https://resstock.nrel.gov/)\n- [URBANopt](https://www.nrel.gov/buildings/urbanopt.html)\n- [VEIC](https://www.veic.org)\n- [Weatherization Assistant](https://weatherization.ornl.gov/softwaredescription/) (pending)\n- [XeroHome](https://about.xerohome.com/)\n\nAre you using OpenStudio-HPXML and want to be mentioned here? [Email us](mailto:scott.horowitz@nrel.gov) or [open a Pull Request](https://github.com/NREL/OpenStudio-HPXML/edit/master/README.md).\n\n## License\n\nThis project is available under a BSD-3-like license, which is a free, open-source, and permissive license. For more information, check out the [license file](https://github.com/NREL/OpenStudio-HPXML/blob/master/LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNREL%2FOpenStudio-HPXML","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNREL%2FOpenStudio-HPXML","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNREL%2FOpenStudio-HPXML/lists"}