Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.
https://github.com/NREL/OpenStudio-HPXML

Last synced: about 2 months ago
JSON representation

Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.

Host: GitHub
URL: https://github.com/NREL/OpenStudio-HPXML
Owner: NREL
License: other
Created: 2018-11-02T23:02:25.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-10-29T21:40:43.000Z (2 months ago)
Last Synced: 2024-10-29T21:54:20.977Z (2 months ago)
Language: Ruby
Homepage:
Size: 159 MB
Stars: 43
Watchers: 16
Forks: 17
Open Issues: 128
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE.md

Awesome Lists containing this project

open-sustainable-technology - OpenStudio-HPXML - Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML. (Consumption / Buildings and Heating)

README

        # OpenStudio®-HPXML

[![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)

[![ci](https://github.com/NREL/OpenStudio-HPXML/workflows/ci/badge.svg)](https://github.com/NREL/OpenStudio-HPXML/actions)

[![Documentation Status](https://readthedocs.org/projects/openstudio-hpxml/badge/?version=latest)](https://openstudio-hpxml.readthedocs.io/en/latest/?badge=latest)

OpenStudio-HPXML allows running residential EnergyPlus™ simulations using an [HPXML file](https://hpxml.nrel.gov/) 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](https://openstudio-hpxml.readthedocs.io/en/latest).

## Workflows

A simple `run_simulation.rb` script is provided to run a residential EnergyPlus simulation from an HPXML file.

See the [Usage Instructions](https://openstudio-hpxml.readthedocs.io/en/latest/usage_instructions.html) for documentation on running the workflow.

Since [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.

## 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

- 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

## 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:

- [BEopt](https://beopt.nrel.gov)

- [Energy Rating Index (ERI)](https://github.com/NREL/OpenStudio-ERI)

- [Home Energy Score](https://www.homeenergyscore.gov)

- [OptiMiser](https://optimiserenergy.com)

- [Radiant Labs](https://www.radiantlabs.co)

- [ResStock](https://resstock.nrel.gov/)

- [URBANopt](https://www.nrel.gov/buildings/urbanopt.html)

- [VEIC](https://www.veic.org)

- [Weatherization Assistant](https://weatherization.ornl.gov/softwaredescription/) (pending)

Are you using OpenStudio-HPXML and want to be mentioned here? [Email us](mailto:[email protected]) or [open a Pull Request](https://github.com/NREL/OpenStudio-HPXML/edit/master/README.md).

## 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](https://github.com/NREL/OpenStudio-HPXML/blob/master/LICENSE.md).