OpenStudio-HPXML

https://openstudio-hpxml.readthedocs.io/en/v1.1.0/
Admin
OpenStudio-HPXML is a residential EnergyPlus-based workflow that translates HPXML building...
Tokens:15,105
Snippets:214
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Help for Basic Simulation Script

Source: https://openstudio-hpxml.readthedocs.io/en/v1.1.0/getting_started.html

Run this command to view all available commands and arguments for the `run_simulation.rb` script.

```bash
openstudio workflow/run_simulation.rb -h
```

--------------------------------

### HPXML Window Element Example

Source: https://openstudio-hpxml.readthedocs.io/en/v1.1.0/workflow_inputs.html

An example of a basic window definition in an HPXML file. This shows the core attributes required for a window.

```xml
<Window>
  <SystemIdentifier id='Window'/>
  <Area>108.0</Area>
  <Azimuth>0</Azimuth>
  <UFactor>0.33</UFactor>
  <SHGC>0.45</SHGC>
  <AttachedToWall idref='Wall'/>
</Window>
```

--------------------------------

### HPXML Window Element with Defaults

Source: https://openstudio-hpxml.readthedocs.io/en/v1.1.0/workflow_inputs.html

An example of a window definition in the generated 'in.xml' file, showing how default elements are populated. This includes interior shading and fraction operable.

```xml
<Window>
  <SystemIdentifier id='Window'/>
  <Area>108.0</Area>
  <Azimuth>0</Azimuth>
  <UFactor>0.33</UFactor>
  <SHGC>0.45</SHGC>
  <InteriorShading>
    <SystemIdentifier id='WindowInteriorShading'/>
    <SummerShadingCoefficient dataSource='software'>0.7</SummerShadingCoefficient>
    <WinterShadingCoefficient dataSource='software'>0.85</WinterShadingCoefficient>
  </InteriorShading>
  <FractionOperable dataSource='software'>0.67</FractionOperable>
  <AttachedToWall idref='Wall'/>
</Window>
```

--------------------------------

### Run Basic Simulation with OpenStudio CLI

Source: https://openstudio-hpxml.readthedocs.io/en/v1.1.0/getting_started.html

Use this command for the simplest and fastest method to run simulations. It calls the OpenStudio CLI with a specified Ruby script and an XML input file. A 'run' directory is created with all input/output files.

```bash
openstudio workflow/run_simulation.rb -x workflow/sample_files/base.xml
```

--------------------------------

### Run Advanced Simulation with OSW File

Source: https://openstudio-hpxml.readthedocs.io/en/v1.1.0/getting_started.html

This command is used for advanced simulations requiring more flexibility, such as specifying individual measure arguments or including additional measures. It runs simulations based on a JSON OpenStudio Workflow (OSW) file.

```bash
openstudio run -w workflow/template.osw
```
Tokens:
Raw