Data

Tools

Indexes

Applications

Experiments

Open Source Science

OpenStudio-HPXML

Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.

https://github.com/NREL/OpenStudio-HPXML

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 20 committers (5.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords from Contributors

building-energy carbon-emissions demand-side-management energy-consumption energy-data energy-efficiency
Last synced: 6 months ago · JSON representation

Repository

Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.

Basic Info
  • Host: GitHub
  • Owner: NREL
  • License: other
  • Language: Ruby
  • Default Branch: master
  • Homepage:
  • Size: 183 MB
Statistics
  • Stars: 53
  • Watchers: 20
  • Forks: 26
  • Open Issues: 135
  • Releases: 19
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License

README.md

OpenStudio®-HPXML

GitHub release (latest by date including pre-releases) ci Documentation Status

OpenStudio-HPXML allows running residential EnergyPlus™ simulations using an HPXML file for the building description. It is intended to be used by user interfaces or other automated software workflows that automatically produce the HPXML file.

OpenStudio-HPXML can accommodate a wide range of different building technologies and geometries. End-to-end simulations typically run in 3-10 seconds, depending on complexity, computer platform and speed, etc.

For more information on running simulations, generating HPXML files with the appropriate inputs to run EnergyPlus, etc., please visit the documentation.

Workflows

A simple run_simulation.rb script is provided to run a residential EnergyPlus simulation from an HPXML file. See the Usage Instructions for documentation on running the workflow.

Since OpenStudio measures are used for model generation, additional OpenStudio-based workflows and interfaces can instead be used if desired.

Capabilities

OpenStudio-HPXML capabilities include: - Modeling individual dwelling units or whole multifamily buildings - Modeling a wide range of building technologies - HVAC design load calculations and equipment autosizing - Electric panel NEC load calculations (experimental research feature) - Occupancy schedules (smooth or stochastic) - Utility bill calculations (flat, tiered, time-of-use, real-time pricing, etc.) - Emissions calculations (CO2e, etc.) - Annual and timeseries outputs (energy, loads, temperatures, etc.) - Optional HPXML inputs with transparent defaults - Schematron and XSD Schema input validation - Can be used for DOE HOMES program approval - Can be used for ACCA Manual J approval

Measures

This repository contains several OpenStudio measures: - BuildResidentialHPXML: A measure that generates an HPXML file from a set of building description inputs (including, e.g., simplified geometry inputs). - BuildResidentialScheduleFile: A measure that generates a CSV of detailed schedules (e.g., stochastic occupancy) for use in the simulation. - HPXMLtoOpenStudio: A measure that translates an HPXML file to an OpenStudio model. - ReportSimulationOutput: A reporting measure that generates a variety of simulation-based annual/timeseries outputs in CSV/JSON/MessagePack format. - ReportUtilityBills: A reporting measure that generates utility bill outputs in CSV/JSON/MessagePack format.

Users

OpenStudio-HPXML is used by a number of software products or organizations, including:

Are you using OpenStudio-HPXML and want to be mentioned here? Email us or open a Pull Request.

License

This 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.

Owner

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Create event: 144
  • Commit comment event: 2
  • Release event: 3
  • Delete event: 137
  • Member event: 3
  • Pull request event: 270
  • Fork event: 11
  • Issues event: 83
  • Watch event: 8
  • Issue comment event: 126
  • Push event: 1,588
  • Gollum event: 2
  • Pull request review event: 485
  • Pull request review comment event: 539
Last Year
  • Create event: 144
  • Commit comment event: 2
  • Release event: 3
  • Delete event: 137
  • Member event: 3
  • Pull request event: 270
  • Fork event: 11
  • Issues event: 83
  • Watch event: 8
  • Issue comment event: 126
  • Push event: 1,588
  • Gollum event: 2
  • Pull request review event: 485
  • Pull request review comment event: 539

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 12,865
  • Total Committers: 20
  • Avg Commits per committer: 643.25
  • Development Distribution Score (DDS): 0.554
Past Year
  • Commits: 1,649
  • Committers: 13
  • Avg Commits per committer: 126.846
  • Development Distribution Score (DDS): 0.573
Top Committers
Name Email Commits
Scott Horowitz s****z@n****v 5,739
Joe Robertson j****n@n****v 3,007
GitHub Action g****n 1,617
Yueyue Zhou y****u@n****v 1,279
bpark1327 b****k@n****v 438
Noel Merket n****t@n****v 219
aspeake1 a****e@n****v 207
Jeff Maguire J****e@n****v 97
Rajendra Adhikari r****e@g****m 83
prsh5175 p****a@n****v 53
Sashadf1 S****e@n****v 46
Shen d****9@g****m 31
Jon j****r@n****v 20
Matt Steen m****n@n****v 12
Anthony Fontanini 3****i 9
Leo Rainer l****r@l****v 3
Julien Marrec j****c@g****m 2
Andrew Parker a****2@g****m 1
JLReyna j****a@n****v 1
mdahlhausen m****n@g****m 1
Committer Domains (Top 20 + Academic)
nrel.gov: 12 lbl.gov: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 489
  • Total pull requests: 1,865
  • Average time to close issues: 4 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 24
  • Total pull request authors: 16
  • Average comments per issue: 1.07
  • Average comments per pull request: 0.83
  • Merged pull requests: 1,642
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 63
  • Pull requests: 323
  • Average time to close issues: 21 days
  • Average time to close pull requests: 8 days
  • Issue authors: 9
  • Pull request authors: 8
  • Average comments per issue: 0.62
  • Average comments per pull request: 0.34
  • Merged pull requests: 268
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • shorowit (374)
  • joseph-robertson (46)
  • yzhou601 (10)
  • chrisbalbach (8)
  • jmaguire1 (6)
  • ejhw (6)
  • jonwinkler (6)
  • rajeee (5)
  • afontani (5)
  • jmarrec (3)
  • lixiliu (3)
  • nmerket (3)
  • jefffriesen (2)
  • pegdeploy (2)
  • mdahlhausen (1)
Pull Request Authors
  • shorowit (1,344)
  • joseph-robertson (308)
  • yzhou601 (101)
  • bpark1327 (30)
  • rajeee (23)
  • jmaguire1 (15)
  • aspeake (11)
  • Sashadf1 (9)
  • nmerket (6)
  • prsh5175 (5)
  • afontani (4)
  • jonwinkler (3)
  • MatthewSteen (2)
  • dshen109 (2)
  • jmarrec (1)
Top Labels
Issue Labels
enhancement (135) bug (87) priority low (76) refactor (34) priority medium (26) question (22) energyplus (19) hpxml (15) priority high (15) documentation (14) performance (13) openstudio (9) help wanted (3) invalid (1)
Pull Request Labels
enhancement (242) bug (112) refactor (109) documentation (55) openstudio (28) performance (23) energyplus (21) hpxml (13) priority medium (12) priority high (4) priority low (3)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 38
proxy.golang.org: github.com/nrel/openstudio-hpxml
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago
proxy.golang.org: github.com/NREL/OpenStudio-HPXML
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago

Dependencies

.github/workflows/config.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
Gemfile rubygems
  • minitest = 5.15
  • minitest-reporters >= 0
  • msgpack >= 0
  • oga >= 0
  • parallel >= 0
  • rake >= 0
  • rubyzip >= 0
  • simplecov >= 0
  • simplecov-html >= 0
Gemfile.lock rubygems
  • ansi 1.5.0
  • ast 2.4.2
  • builder 3.2.4
  • bundler 2.2.29
  • docile 1.4.0
  • minitest 5.15.0
  • minitest-reporters 1.5.0
  • msgpack 1.5.2
  • oga 3.3
  • parallel 1.22.1
  • rake 13.0.6
  • ruby-ll 2.1.2
  • ruby-progressbar 1.11.0
  • rubyzip 2.3.2
  • simplecov 0.21.2
  • simplecov-html 0.12.3
  • simplecov_json_formatter 0.1.4