Sha256: e3bd87035472dfa7369020531891619d3280a19673295aa15b9e01e0f532ca48

Contents?: true

Size: 952 Bytes

Versions: 56

Compression:

Stored size: 952 Bytes

Contents

<%#= README.md.erb is used to auto-generate README.md. %>
###### (Automatically generated documentation)

# <%= name %>

## Description
<%= description %>

<%= modelerDescription %>

## Arguments

<% arguments.each do |argument| %>
**<%= argument[:display_name] %>**

<%= argument[:description] %>

- **Name:** ``<%= argument[:name] %>``
- **Type:** ``<%= argument[:type] %>``
<% if argument[:units] %>
- **Units:** ``<%= argument[:units] %>``
<% end %>
- **Required:** ``<%= argument[:required] %>``
<% if argument[:type] == "Choice" %>
- **Choices:** `<%= argument[:choice_values].join("`, `") %>`
<% end %>
<br/>
<% end %>

<% if arguments.size == 0 %>
<%= "This measure does not have any user arguments" %>
<% end %>

<% if outputs.size > 0 %>
## Outputs
All possible measure outputs are listed below. Actual outputs depend on measure argument values provided.

<% outputs.each do |output| %>
- ``<%= output[:display_name] %>``
<% end %>
<% end %>

Version data entries

56 entries across 6 versions & 1 rubygems

Version Path
urbanopt-cli-1.0.1 example_files/resources/residential-measures/measures/ServerDirectoryCleanup/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/measures/BuildExistingModel/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/resources/hpxml-measures/HPXMLtoOpenStudio/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/measures/UpgradeCosts/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/measures/ResStockArguments/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/measures/QOIReport/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/resources/hpxml-measures/ReportSimulationOutput/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/resources/hpxml-measures/ReportUtilityBills/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/resources/hpxml-measures/BuildResidentialScheduleFile/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/resources/hpxml-measures/BuildResidentialHPXML/README.md.erb
urbanopt-cli-1.0.1 example_files/resources/residential-measures/measures/ApplyUpgrade/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/resources/hpxml-measures/BuildResidentialHPXML/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/measures/UpgradeCosts/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/measures/QOIReport/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/resources/hpxml-measures/ReportUtilityBills/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/resources/hpxml-measures/ReportSimulationOutput/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/measures/ServerDirectoryCleanup/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/resources/hpxml-measures/HPXMLtoOpenStudio/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/resources/hpxml-measures/BuildResidentialScheduleFile/README.md.erb
urbanopt-cli-1.0.0 example_files/resources/residential-measures/measures/ResStockArguments/README.md.erb