Sha256: 62e74978d6ef5b649811ecdae97c45daae4834c4f799f03cf00b493124185768

Contents?: true

Size: 1.78 KB

Versions: 4

Compression:

Stored size: 1.78 KB

Contents

###### (Automatically generated documentation)

# Utility Bills Report

## Description
Calculates and reports utility bills for residential HPXML-based models.

Calculate electric/gas utility bills based on monthly fixed charges and marginal rates. Calculate other utility bills based on marginal rates for oil, propane, wood cord, wood pellets, and coal. User can specify PV compensation types of 'Net-Metering' or 'Feed-In Tariff', along with corresponding rates and connection fees.

## Arguments


**Output Format**

The file format of the annual (and timeseries, if requested) outputs.

- **Name:** ``output_format``
- **Type:** ``Choice``

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

- **Choices:** `csv`, `json`, `msgpack`

<br/>

**Generate Annual Utility Bills**

Generates annual utility bills.

- **Name:** ``include_annual_bills``
- **Type:** ``Boolean``

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

<br/>

**Generate Monthly Utility Bills**

Generates monthly utility bills.

- **Name:** ``include_monthly_bills``
- **Type:** ``Boolean``

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

<br/>

**Generate Monthly Output: Timestamp Convention**

Determines whether monthly timestamps use the start-of-period or end-of-period convention.

- **Name:** ``monthly_timestamp_convention``
- **Type:** ``Choice``

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

- **Choices:** `start`, `end`

<br/>

**Annual Output File Name**

If not provided, defaults to 'results_bills.csv' (or 'results_bills.json' or 'results_bills.msgpack').

- **Name:** ``annual_output_file_name``
- **Type:** ``String``

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

<br/>

**Monthly Output File Name**

If not provided, defaults to 'results_bills_monthly.csv' (or 'results_bills_monthly.json' or 'results_bills_monthly.msgpack').

- **Name:** ``monthly_output_file_name``
- **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/ReportUtilityBills/README.md
urbanopt-cli-0.13.0 example_files/resources/residential-measures/resources/hpxml-measures/ReportUtilityBills/README.md
urbanopt-cli-0.11.1 example_files/resources/hpxml-measures/ReportUtilityBills/README.md
urbanopt-cli-0.11.0 example_files/resources/hpxml-measures/ReportUtilityBills/README.md