Outputs and Analysis
====================

OCHRE saves many time series outputs throughout the simulation. These time
series outputs are used to calculate metrics that describe the simulation
results. The set of time series outputs depends on the ``verbosity`` of the
simulation, and the set of metrics depends on the ``metrics_verbosity``. OCHRE
also includes analysis and visualization modules for common methods. 

Dwelling Time Series Outputs
----------------------------

+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| **OCHRE Name**                | **OCHRE Units** | **Verbosity** | **Description**                                       |
+===============================+=================+===============+=======================================================+
| Total Electric Power (kW)     | kW              | 1             | Total dwelling real electric power                    |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| Total Electric Energy (kWh)   | kWh             | 1             | Total dwelling real electric energy for 1 time step   |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| Total Gas Power (therms/hour) | therms/hour     | 1             | Total dwelling gas power                              |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| Total Gas Energy (therms)     | therms          | 1             | Total dwelling gas energy consumption for 1 time step |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| Total Reactive Power (kVAR)   | kVAR            | 1             | Total dwelling reactive power                         |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| Total Reactive Energy (kVARh) | kVARh           | 1             | Total dwelling reactive energy for 1 time step        |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+
| Grid Voltage (-)              | p.u.            | 5             | Per-unit grid voltage                                 |
+-------------------------------+-----------------+---------------+-------------------------------------------------------+


Equipment-specific Time Series Outputs
--------------------------------------

All Equipment
~~~~~~~~~~~~~

+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| **OCHRE Name**                      | **OCHRE Units** | **Verbosity** | **Description**                                                          |
+=====================================+=================+===============+==========================================================================+
| <end use> Electric Power (kW)       | kW              | 2             | Real electric power of all equipment within the end use                  |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| <end use> Gas Power (therms/hour)   | therms/hour     | 2             | Gas power of all equipment within the end use                            |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| <end use> Reactive Power (kVAR)     | kVAR            | 5             | Reactive electric power of all equipment within the end use              |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| <equipment> Mode                    | N/A             | 6             | Current mode of equipment operation                                      |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| <equipment> Electric Power (kW)     | kW              | 6             | Real electric power of the equipment (Lighting and Other equipment only) |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| <equipment> Gas Power (therms/hour) | therms/hour     | 6             | Gas power of the equipment                                               |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+
| <equipment> Reactive Power (kVAR)   | kVAR            | 6             | Reactive electric power of the equipment                                 |
+-------------------------------------+-----------------+---------------+--------------------------------------------------------------------------+

HVAC Heating and Cooling
~~~~~~~~~~~~~~~~~~~~~~~~

The following outputs are associated with the HVAC equipment.

+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| **OCHRE Name**                             | **OCHRE Units** | **Verbosity** | **Description**                                                           |
+============================================+=================+===============+===========================================================================+
| HVAC <Heating or Cooling> Delivered (W)    | W               | 3             | HVAC sensible heat gain delivered to indoor zone                          |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Setpoint (C)     | degC            | 6             | HVAC temperature setpoint                                                 |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Main Power (kW)  | kW              | 6             | HVAC electric or gas power excluding fan, peripherals, and backup element |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> ER Power (kW)    | kW              | 6             | HVAC backup element power (ASHPHeater only)                               |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Fan Power (kW)   | kW              | 6             | HVAC fan and peripherals power                                            |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Latent Gains (W) | W               | 6             | HVAC latent heat gain delivered to indoor zone                            |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Capacity (W)     | W               | 6             | HVAC heat capacity of main unit                                           |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Max Capacity (W) | W               | 6             | HVAC maximum heat capacity of main unit                                   |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> COP (-)          | unitless        | 6             | HVAC coefficient of performance of main unit                              |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> SHR (-)          | unitless        | 6             | HVAC sensible heat ratio                                                  |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Speed (-)        | unitless        | 6             | HVAC speed index. Fractions indicate the relative time in adjacent speeds |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+
| HVAC <Heating or Cooling> Duct Losses (W)  | W               | 6             | Heat gains to duct zone due to duct losses                                |
+--------------------------------------------+-----------------+---------------+---------------------------------------------------------------------------+

The following outputs are associated with the Envelope model.

+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| **OCHRE Name**                                    | **OCHRE Units** | **Verbosity** | **Description**                                                                                                                           |
+===================================================+=================+===============+===========================================================================================================================================+
| Temperature - <zone> (C)                          | degC            | 1             | Temperature of envelope zone                                                                                                              |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Unmet HVAC Load (C)                               | degC            | 1             | Absolute difference between Indoor temperature and thermal comfort limit (positive if hot, negative if cold)                              |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Occupancy (Persons)                               | Persons         | 4             | Number of current occupants                                                                                                               |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Net Sensible Heat Gain - <zone> (W)               | W               | 4             | Net sensible heat injected into zone. Includes heat gains from infiltration, ventilation, radiation, HVAC, other equipment, and occupants |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Window Transmitted Solar Gain (W)                 | W               | 4             | Heat gains from solar transmitted through windows to Indoor zone                                                                          |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Infiltration Flow Rate - <zone> (m^3/s)           | m^3/s           | 7             | Infiltration flow rate between zone and outdoors                                                                                          |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Forced Ventilation Flow Rate - Indoor (m^3/s)     | m^3/s           | 7             | Mecahnical ventilation flow rate                                                                                                          |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Natural Ventilation Flow Rate - Indoor (m^3/s)    | m^3/s           | 7             | Natural ventilation flow rate (open windows)                                                                                              |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Infiltration Heat Gain - <zone> (W)               | W               | 7             | Infiltration heat gain into zone                                                                                                          |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Forced Ventilation Heat Gain - Indoor (W)         | W               | 7             | Heat gain from mechanical ventilation                                                                                                     |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Natural Ventilation Heat Gain - Indoor (W)        | W               | 7             | Heat gain from natural ventilation                                                                                                        |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Occupancy Heat Gain - Indoor (W)                  | W               | 7             | Heat gain from occupancy                                                                                                                  |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Internal Heat Gain - Indoor (W)                   | W               | 7             | Heat gain from non-HVAC equipment                                                                                                         |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Radiation Heat Gain - Indoor (W)                  | W               | 7             | Heat gain from radiation. Includes transmitted solar and internal radiation to zone                                                       |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Net Latent Heat Gain - Indoor (W)                 | W               | 7             | Net latent heat injected into zone. Includes heat gains from infiltration, ventilation, HVAC, other equipment, and occupants              |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Relative Humidity - Indoor (-)                    | unitless        | 7             | Relative humidity of zone                                                                                                                 |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Humidity Ratio - Indoor (-)                       | unitless        | 7             | Humidity ratio of zone                                                                                                                    |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Wet Bulb - Indoor (C)                             | W               | 7             | Wet bulb temperature in zone                                                                                                              |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Air Density - Indoor (kg/m^3)                     | unitless        | 7             | Air density of zone                                                                                                                       |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> Ext. Solar Gain (W)               | W               | 8             | Solar heat gain on external boundary surface                                                                                              |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> Ext. LWR Gain (W)                 | W               | 8             | Long wave radiation heat gain on external boundary surface                                                                                |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> Ext. Surface Temperature (C)      | degC            | 8             | External boundary surface temperature                                                                                                     |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> Ext. Film Coefficient (m^2-K/W)   | m^2-K/W         | 8             | Film coefficient of external boundary surface                                                                                             |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> <zone> LWR Gain (W)               | W               | 8             | Long wave radiation heat gain on internal boundary surface                                                                                |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> <zone> Surface Temperature (C)    | C               | 8             | Internal boundary surface temperature                                                                                                     |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| <boundary name> <zone> Film Coefficient (m^2-K/W) | m^2-K/W         | 8             | Film coefficient of internal boundary surface                                                                                             |
+---------------------------------------------------+-----------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+

Water Heating
~~~~~~~~~~~~~

The following outputs are associated with the Water Heater equipment.

+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| **OCHRE Name**                             | **OCHRE Units** | **Verbosity** | **Description**                                           |
+============================================+=================+===============+===========================================================+
| Water Heating Delivered (W)                | W               | 3             | Heat delivered by water heater to tank                    |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating COP (-)                      | unitless        | 6             | Water heater coefficient of performance                   |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating Total Sensible Heat Gain (W) | W               | 6             | Sensible heat gain from water tank to envelope zone       |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating Deadband Upper Limit (C)     | C               | 6             | Upper temperature limit for water heater deadband control |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating Deadband Lower Limit (C)     | C               | 6             | Lower temperature limit for water heater deadband control |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating Heat Pump Max Capacity (W)   | W               | 6             | Maximum capacity of HPWH heat pump element                |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating Heat Pump On Fraction (-)    | unitless        | 6             | Fraction of time HPWH heat pump element is on             |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+
| Water Heating Heat Pump COP (-)            | unitless        | 6             | HPWH heat pump coefficient of performance                 |
+--------------------------------------------+-----------------+---------------+-----------------------------------------------------------+

The following outputs are associated with the Water Tank model.

+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| **OCHRE Name**                    | **OCHRE Units** | **Verbosity** | **Description**                                                    |
+===================================+=================+===============+====================================================================+
| Hot Water Delivered (L/min)       | L/min           | 3             | Hot water draw volumetric flow rate                                |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Delivered (W)           | W               | 3             | Hot water draw heat flow rate                                      |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Unmet Demand (kW)       | kW              | 3             | Unmet hot water demand, based on flow rate and desired temperature |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Outlet Temperature (C)  | degC            | 3             | Hot water outlet temperature                                       |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Heat Injected (W)       | W               | 6             | Water tank heat gains from water heater                            |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Heat Loss (W)           | W               | 6             | Water tank heat losses to envelope zone                            |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Average Temperature (C) | degC            | 6             | Water tank average temperature                                     |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Maximum Temperature (C) | degC            | 6             | Water tank maximum temperature                                     |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Minimum Temperature (C) | degC            | 6             | Water tank minimum temperature                                     |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+
| Hot Water Mains Temperature (C)   | degC            | 6             | Water mains temperature                                            |
+-----------------------------------+-----------------+---------------+--------------------------------------------------------------------+

Electric Vehicle
~~~~~~~~~~~~~~~~

+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+
| **OCHRE Name**                 | **OCHRE Units** | **Verbosity** | **Description**                                                         |
+================================+=================+===============+=========================================================================+
| EV SOC (-)                     | unitless        | 3             | EV state of charge                                                      |
+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+
| EV Parked                      | N/A             | 3             | True if EV is parked at home                                            |
+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+
| EV Unmet Load (kW)             | kW              | 3             | Unmet EV demand, determined at parking End Time. Negative value         |
+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+
| EV Start Time                  | N/A             | 6             | If parked, time that EV arrived. If away, next time that EV will arrive |
+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+
| EV End Time                    | N/A             | 6             | Next time that EV will depart                                           |
+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+
| EV Remaining Charge Time (min) | minutes         | 7             | Estimated time to fully charge, based on SOC and max charge rate        |
+--------------------------------+-----------------+---------------+-------------------------------------------------------------------------+

Solar PV
~~~~~~~~

+--------------------+-----------------+---------------+----------------------------+
| **OCHRE Name**     | **OCHRE Units** | **Verbosity** | **Description**            |
+====================+=================+===============+============================+
| PV P Setpoint (kW) | kW              | 6             | PV real power setpoint     |
+--------------------+-----------------+---------------+----------------------------+
| PV Q Setpoint (kW) | kVAR            | 6             | PV reactive power setpoint |
+--------------------+-----------------+---------------+----------------------------+

Battery
~~~~~~~

+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+
| **OCHRE Name**                    | **OCHRE Units** | **Verbosity** | **Description**                                                               |
+===================================+=================+===============+===============================================================================+
| Battery SOC (-)                   | unitless        | 3             | Battery state of charge                                                       |
+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+
| Battery Setpoint (kW)             | kW              | 6             | Battery real power setpoint                                                   |
+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+
| Battery Efficiency (-)            | unitless        | 6             | Battery efficiency                                                            |
+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+
| Battery Energy to Discharge (kWh) | kWh             | 6             | Estimated energy available for discharge, based on SOC and max discharge rate |
+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+
| Battery Nominal Capacity (kWh)    | kWh             | 9             | Nominal battery capacity, including degradation model                         |
+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+
| Battery Actual Capacity (kWh)     | kWh             | 9             | Actual battery capacity, including degradation and temperature models         |
+-----------------------------------+-----------------+---------------+-------------------------------------------------------------------------------+

Equivalent Battery Model
~~~~~~~~~~~~~~~~~~~~~~~~

The following outputs are not reported at any verbosity, but they can be
calculated using the ``Equipment.make_equivalent_battery_model`` function.
Currently, this functions works for the following end uses:

- HVAC Heating
- HVAC Cooling
- Water Heating
- Battery

+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| **OCHRE Name**                         | **OCHRE Units** | **Verbosity** | **Description**                                   |
+========================================+=================+===============+===================================================+
| <end use> EBM Energy (kWh)             | kWh             | N/A           | Energy state of equivalent battery model (EBM)    |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Min Energy (kWh)         | kWh             | N/A           | Minimum energy constraint                         |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Max Energy (kWh)         | kWh             | N/A           | Maximum energy constraint                         |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Max Power (kW)           | kW              | N/A           | Maximum power constraint                          |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Efficiency (-)           | unitless        | N/A           | Input/output power efficiency                     |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Baseline Power (kW)      | kW              | N/A           | Power to maintain constant energy state           |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Max Discharge Power (kW) | kW              | N/A           | Minimum power constraint (negative for discharge) |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+
| <end use> EBM Discharge Efficiency (-) | unitless        | N/A           | Input/output power efficiency while discharging   |
+----------------------------------------+-----------------+---------------+---------------------------------------------------+


All Metrics
-----------

Metrics are calculated at the end of a simulation and summarize the
results over the simulation period (generally a year in most use cases).

+-----------------+--------------------------------+------------------------------------------+
| Metric          | Minimum Metrics Verbosity      | Description                              |
+=================+================================+==========================================+
| Total Electric  | 1                              | Total dwelling real electric energy      |
| Energy (kWh)    |                                | consumption                              |
+-----------------+--------------------------------+------------------------------------------+
| <end use>       | 2                              | Real electric energy consumption of all  |
| Electric Energy |                                | equipment within the end use             |
| (kWh)           |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| <equipment      | 5                              | Real electric energy consumption of the  |
| name> Electric  |                                | equipment                                |
| Energy (kWh)    |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Total Reactive  | 7                              | Total dwelling reactive electric energy  |
| Energy (kVARh)  |                                | consumption                              |
+-----------------+--------------------------------+------------------------------------------+
| <end use>       | 7                              | Reactive electric energy consumption of  |
| Reactive Energy |                                | all equipment within the end use         |
| (kVARh)         |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| <equipment      | 7                              | Reactive electric energy consumption of  |
| name> Reactive  |                                | the equipment                            |
| Energy (kVARh)  |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Total Gas       | 1                              | Total dwelling gas energy consumption    |
| Energy (therms) |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| <end use> Gas   | 2                              | Gas energy consumption of all equipment  |
| Energy (therms) |                                | within the end use                       |
+-----------------+--------------------------------+------------------------------------------+
| <equipment      | 5                              | Gas energy consumption of the equipment  |
| name> Gas       |                                |                                          |
| Energy (therms) |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average         | 3                              | Average temperature of the zone          |
| Temperature -   |                                |                                          |
| <zone name> (C) |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Unmet <Heating  | 4                              | Unmet HVAC load. Based on the difference |
| or Cooling>     |                                | between actual and desired temperature   |
| Load (C-hours)  |                                | and the duration of the unmet load       |
+-----------------+--------------------------------+------------------------------------------+
| Component Load  | 6                              | Total HVAC load (heating minus cooling)  |
| - Internal      |                                | induced by internal gains                |
| Gains (kWh)     |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Component Load  | 6                              | Total HVAC load (heating minus cooling)  |
| - Infiltration  |                                | induced by infiltration                  |
| (kWh)           |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Component Load  | 6                              | Total HVAC load (heating minus cooling)  |
| - Forced        |                                | induced by forced ventilation            |
| Ventilation     |                                |                                          |
| (kWh)           |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Component Load  | 6                              | Total HVAC load (heating minus cooling)  |
| - Natural       |                                | induced by natural ventilation           |
| Ventilation     |                                |                                          |
| (kWh)           |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Component Load  | 6                              | Total HVAC heating load induced by duct  |
| - Ducts,        |                                | losses                                   |
| Heating (kWh)   |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Component Load  | 6                              | Total HVAC cooling load induced by duct  |
| - Ducts,        |                                | losses                                   |
| Cooling (kWh)   |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average         | 6                              | Average dwelling real electric power     |
| Electric Power  |                                |                                          |
| (kW)            |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Peak Electric   | 6                              | Peak dwelling real electric power, using |
| Power (kW)      |                                | simulation time resolution               |
+-----------------+--------------------------------+------------------------------------------+
| Peak Electric   | 6                              | Peak dwelling real electric power, using |
| Power - <time   |                                | specified time resolution                |
| resolution> avg |                                |                                          |
| (kW)            |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average HVAC    | 8                              | Average heating capacity of HVAC         |
| <Heating or     |                                | equipment                                |
| Cooling>        |                                |                                          |
| Capacity (kW)   |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| HVAC <Heating   | **5**                          | Total electric or gas energy consumed by |
| or Cooling>     |                                | main HVAC element (excludes fan and      |
| Main Energy     |                                | other peripherals)                       |
| (kWh)           |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| HVAC <Heating   | 4                              | Total energy consumed by HVAC fan and    |
| or Cooling> Fan |                                | other peripherals                        |
| Energy (kWh)    |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average HVAC    | 4                              | Average coefficient of performance of    |
| <Heating or     |                                | HVAC equipment (excludes fan and other   |
| Cooling> COP    |                                | peripherals)                             |
| (-)             |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average HVAC    | 4                              | Average duct efficiency of HVAC          |
| <Heating or     |                                | equipment                                |
| Cooling> Duct   |                                |                                          |
| Efficiency (-)  |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average HVAC    | 4                              | Average sensible heat ratio of HVAC      |
| Cooling SHR (-) |                                | cooling equipment                        |
+-----------------+--------------------------------+------------------------------------------+
| Std. Dev.       | 8                              | Standard deviation of zone temperature   |
| Temperature -   |                                |                                          |
| <zone name> (C) |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average         |                                | Average Relative Humidity of Indoor zone |
| Relative        |                                |                                          |
| Humidity -      |                                |                                          |
| Indoor (-)      |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average         |                                | Average Humidity Ratio of Indoor zone    |
| Humidity Ratio  |                                |                                          |
| - Indoor (-)    |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Total Hot Water | 4                              | Unmet water heating load. Based on the   |
| Unmet Demand    |                                | difference between actual and desired    |
| (kWh)           |                                | temperature and the duration of the      |
|                 |                                | unmet load                               |
+-----------------+--------------------------------+------------------------------------------+
| Total Hot Water | 4                              | Total volume of hot water delivered to   |
| Delivered       |                                | water draws                              |
| (gal/day)       |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Total Hot Water | 4                              | Total energy of hot water delivered to   |
| Delivered (kWh) |                                | water draws                              |
+-----------------+--------------------------------+------------------------------------------+
| Total Water     | 4                              | Total energy of hot water delivered by   |
| Heating         |                                | the water heater                         |
| Delivered (kWh) |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Average Water   | 4                              | Average coefficient of performance of    |
| Heating COP (-) |                                | water heater                             |
+-----------------+--------------------------------+------------------------------------------+
| Average         | 4                              | The average duration that the home could |
| Islanding Time  |                                | island using battery power given no      |
| (hours)         |                                | changes in other equipment power         |
+-----------------+--------------------------------+------------------------------------------+
| Battery         | 4                              | Total real electric energy consumed by   |
| Charging Energy |                                | the battery during charging              |
| (kWh)           |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Battery         | 4                              | Total real electric energy produced by   |
| Discharging     |                                | the battery during discharging           |
| Energy (kWh)    |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Battery         | 4                              | Average round-trip efficiency. Ignores   |
| Round-trip      |                                | differences between initial and final    |
| Efficiency (-)  |                                | SOC                                      |
+-----------------+--------------------------------+------------------------------------------+
| Gas Generator   | 4                              | Average efficiency of electricity        |
| Efficiency (-)  |                                | outputs to gas inputs                    |
+-----------------+--------------------------------+------------------------------------------+
| Number of       | 4                              | Total number of outages during           |
| Outages         |                                | simulation                               |
+-----------------+--------------------------------+------------------------------------------+
| Average Outage  | 4                              | Average duration of outages during       |
| Duration        |                                | simulation                               |
| (hours)         |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| Longest Outage  | 4                              | Duration of longest outage during        |
| Duration        |                                | simulation                               |
| (hours)         |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+
| <equipment      | 5                              | Number of cycles of the equipment        |
| name> Cycles    |                                | (On/Off cycles only)                     |
+-----------------+--------------------------------+------------------------------------------+
| <equipment      | 5                              | Number of cycles of the equipment with   |
| name> <mode     |                                | multiple modes                           |
| name> Cycles    |                                |                                          |
+-----------------+--------------------------------+------------------------------------------+

Data Analysis
-------------

The ``Analysis`` module has useful data analysis functions for OCHRE
output data:

.. code-block:: python

    from ochre import Analysis
    
    # load existing ochre simulation data
    df, metrics, df_hourly = Analysis.load_ochre(folder)
    # calculate metrics from a pandas DataFrame
    metrics = Analysis.calculate_metrics(df)

Some analysis functions are useful for analyzing or combining results
from multiple OCHRE simulations:

.. code-block:: python

    # Combine OCHRE metrics files from multiple simulations (in subfolders of path)
    df_metrics = Analysis.combine_metrics_files(path=path)
    
    # Combine 1 output column from multiple OCHRE simulations into a single DataFrame
    results_files = Analysis.find_files_from_ending(path, 'ochre.csv')
    df_powers = Analysis.combine_time_series_column('Total Electric Power (kW)', results_files)

Data Visualization
------------------

The ``CreateFigures`` module has useful visualization functions for OCHRE
output data:

.. code-block:: python

    from ochre import Analysis, CreateFigures
    
    df, metrics, df_hourly = Analysis.load_ochre(folder)
    # Create standard HVAC output plots
    CreateFigures.plot_hvac(df)
    # Create stacked plot of power by end use
    CreateFigures.plot_power_stack(df)

Many functions work on any generic pandas DataFrame with a DateTimeIndex.