Sha256: bf14e6abc4b8e8d977cb4dec1820285ca12ca32a07bd52d8e2d4342e5ab686dd

Contents?: true

Size: 1.51 KB

Versions: 4

Compression:

Stored size: 1.51 KB

Contents

###### (Automatically generated documentation)

# HPXML to OpenStudio Translator

## Description
Translates HPXML file to OpenStudio Model



## Arguments


**HPXML File Path**

Absolute/relative path of the HPXML file.

- **Name:** ``hpxml_path``
- **Type:** ``String``

- **Required:** ``true``

<br/>

**Directory for Output Files**

Absolute/relative path for the output files directory.

- **Name:** ``output_dir``
- **Type:** ``String``

- **Required:** ``true``

<br/>

**Debug Mode?**

If true: 1) Writes in.osm file, 2) Generates additional log output, and 3) Creates all EnergyPlus output files.

- **Name:** ``debug``
- **Type:** ``Boolean``

- **Required:** ``false``

<br/>

**Add component loads?**

If true, adds the calculation of heating/cooling component loads (not enabled by default for faster performance).

- **Name:** ``add_component_loads``
- **Type:** ``Boolean``

- **Required:** ``false``

<br/>

**Skip Validation?**

If true, bypasses HPXML input validation for faster performance. WARNING: This should only be used if the supplied HPXML file has already been validated against the Schema & Schematron documents.

- **Name:** ``skip_validation``
- **Type:** ``Boolean``

- **Required:** ``false``

<br/>

**BuildingID**

The ID of the HPXML Building. Only required if there are multiple Building elements in the HPXML file. Use 'ALL' to run all the HPXML Buildings (dwelling units) of a multifamily building in a single model.

- **Name:** ``building_id``
- **Type:** ``String``

- **Required:** ``false``

<br/>





Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
urbanopt-cli-0.14.0 example_files/resources/residential-measures/resources/hpxml-measures/HPXMLtoOpenStudio/README.md
urbanopt-cli-0.13.0 example_files/resources/residential-measures/resources/hpxml-measures/HPXMLtoOpenStudio/README.md
urbanopt-cli-0.11.1 example_files/resources/hpxml-measures/HPXMLtoOpenStudio/README.md
urbanopt-cli-0.11.0 example_files/resources/hpxml-measures/HPXMLtoOpenStudio/README.md