Output Reporting¶

32 object types from idfpy.models.outputs · EnergyPlus 26.2

Object	Summary
EnvironmentalImpactFactors	Used to help convert district and ideal energy use to a fuel type and provide total carbon equivalent with …
FuelFactors	Provides Fuel Factors for Emissions as well as Source=>Site conversions.
Meter:Custom	Used to allow users to combine specific variables and/or meters into "custom" meter configurations.
Meter:CustomDecrement	Used to allow users to combine specific variables and/or meters into "custom" meter configurations.
Output:Constructions	Adds a report to the eio output file which shows details for each construction, including overall properties, …
Output:DebuggingData	switch eplusout.dbg file on or off
Output:Diagnostics	Special keys to produce certain warning messages or effect certain simulation characteristics.
Output:EnergyManagementSystem	This object is used to control the output produced by the Energy Management System
Output:EnvironmentalImpactFactors	This is used to Automatically report the facility meters and turn on the Environmental Impact Report …
Output:JSON	Output from EnergyPlus can be written to JSON format files.
Output:Meter	Each Output:Meter command picks meters to be put onto the standard output file (.eso) and meter file (.mtr).
Output:Meter:Cumulative	Each Output:Meter:Cumulative command picks meters to be reported cumulatively onto the standard output file …
Output:Meter:Cumulative:MeterFileOnly	Each Output:Meter:Cumulative:MeterFileOnly command picks meters to be reported cumulatively onto the standard …
Output:Meter:MeterFileOnly	Each Output:Meter:MeterFileOnly command picks meters to be put only onto meter file (.mtr).
Output:PreprocessorMessage	This object does not come from a user input.
Output:SQLite	Output from EnergyPlus can be written to an SQLite format file.
Output:Schedules	Produces a condensed reporting that illustrates the full range of schedule values in the eio output file.
Output:Surfaces:Drawing	Produces reports/files that are capable of rendering graphically or being imported into other programs.
Output:Surfaces:List	Produces a report summarizing the details of surfaces in the eio output file.
Output:Table:Annual	Provides a generic method of setting up tables of annual results with one row per object.
Output:Table:Monthly	Provides a generic method of setting up tables of monthly results.
Output:Table:ReportPeriod	This object allows the user to generate the resilience tabular reports over a subset of a run period.
Output:Table:SummaryReports	This object allows the user to call report types that are predefined and will appear with the other tabular …
Output:Table:TimeBins	Produces a bin report in the table output file which shows the amount of time in hours that occurs in …
Output:Variable	each Output:Variable command picks variables to be put onto the standard output file (.eso) some variables …
Output:VariableDictionary	Produces a list summarizing the output variables and meters that are available for reporting for the model …
OutputControl:Files	Conditionally turn on/off output from EnergyPlus.
OutputControl:ReportingTolerances	Calculations of the time that setpoints are not met use a tolerance of 0.2C.
OutputControl:ResilienceSummaries	Specifies methods for resilience reporting variables
OutputControl:SurfaceColorScheme	This object is used to set colors for reporting on various building elements particularly for the DXF reports.
OutputControl:Table:Style	default style for the OutputControl:Table:Style is comma -- this works well for importing into spreadsheet …
OutputControl:Timestamp	Control timestamp format, currently applies only to JSON and native CSV (not CSV via ReadVars)

EnvironmentalImpactFactors¶

from idfpy.models import EnvironmentalImpactFactors

Used to help convert district and ideal energy use to a fuel type and provide total carbon equivalent with coefficients Also used in Source=>Site conversions.

Field	Type	Default	Details
`district_heating_water_efficiency` District Heating Water Efficiency	number	`0.3`	District heating efficiency used when converted to natural gas Range: > 0
`district_cooling_cop` District Cooling COP	number W/W	`3.0`	District cooling COP used when converted to electricity Range: > 0
`district_heating_steam_conversion_efficiency` District Heating Steam Conversion Efficiency	number	`0.25`	Steam conversion efficiency used to convert steam usage to natural gas Range: > 0
`total_carbon_equivalent_emission_factor_from_n2o` Total Carbon Equivalent Emission Factor From N2O	number kg/kg	`80.7272`
`total_carbon_equivalent_emission_factor_from_ch4` Total Carbon Equivalent Emission Factor From CH4	number kg/kg	`6.2727`
`total_carbon_equivalent_emission_factor_from_co2` Total Carbon Equivalent Emission Factor From CO2	number kg/kg	`0.2727`

FuelFactors¶

from idfpy.models import FuelFactors

Provides Fuel Factors for Emissions as well as Source=>Site conversions. OtherFuel1, OtherFuel2 provide options for users who want to create and use fuels that may not be mainstream (biomass, wood, pellets).

Field	Type	Details
`existing_fuel_resource_name` Existing Fuel Resource Name	choice	One of `Coal`, `Diesel`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`source_energy_factor` Source Energy Factor	number J/J
`source_energy_schedule_name` Source Energy Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`co2_emission_factor` CO2 Emission Factor	number g/MJ
`co2_emission_factor_schedule_name` CO2 Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`co_emission_factor` CO Emission Factor	number g/MJ
`co_emission_factor_schedule_name` CO Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ch4_emission_factor` CH4 Emission Factor	number g/MJ
`ch4_emission_factor_schedule_name` CH4 Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`nox_emission_factor` NOx Emission Factor	number g/MJ
`nox_emission_factor_schedule_name` NOx Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`n2o_emission_factor` N2O Emission Factor	number g/MJ
`n2o_emission_factor_schedule_name` N2O Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`so2_emission_factor` SO2 Emission Factor	number g/MJ
`so2_emission_factor_schedule_name` SO2 Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pm_emission_factor` PM Emission Factor	number g/MJ
`pm_emission_factor_schedule_name` PM Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pm10_emission_factor` PM10 Emission Factor	number g/MJ
`pm10_emission_factor_schedule_name` PM10 Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pm2_5_emission_factor` PM2.5 Emission Factor	number g/MJ
`pm2_5_emission_factor_schedule_name` PM2.5 Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`nh3_emission_factor` NH3 Emission Factor	number g/MJ
`nh3_emission_factor_schedule_name` NH3 Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`nmvoc_emission_factor` NMVOC Emission Factor	number g/MJ
`nmvoc_emission_factor_schedule_name` NMVOC Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`hg_emission_factor` Hg Emission Factor	number g/MJ
`hg_emission_factor_schedule_name` Hg Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pb_emission_factor` Pb Emission Factor	number g/MJ
`pb_emission_factor_schedule_name` Pb Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`water_emission_factor` Water Emission Factor	number L/MJ
`water_emission_factor_schedule_name` Water Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`nuclear_high_level_emission_factor` Nuclear High Level Emission Factor	number g/MJ
`nuclear_high_level_emission_factor_schedule_name` Nuclear High Level Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`nuclear_low_level_emission_factor` Nuclear Low Level Emission Factor	number m3/MJ
`nuclear_low_level_emission_factor_schedule_name` Nuclear Low Level Emission Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Meter:Custom¶

from idfpy.models import MeterCustom extensible

Used to allow users to combine specific variables and/or meters into "custom" meter configurations. To access these meters by name, one must first run a simulation to generate the RDD/MDD files and names. A Meter:Custom cannot reference another Meter:Custom or a Meter:CustomDecrement.

Field	Type	Details
`name` Name required	string
`resource_type` Resource Type	choice	One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `Generic`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`, `Water`
`variable_details`	list	Each item: `key_name`, `output_variable_or_meter_name`

Meter:CustomDecrement¶

from idfpy.models import MeterCustomDecrement extensible

Used to allow users to combine specific variables and/or meters into "custom" meter configurations. To access these meters by name, one must first run a simulation to generate the RDD/MDD files and names. A Meter:CustomDecrement cannot reference another Meter:CustomDecrement, either as the Source Meter Name or in the Key Name/Output Variable or Meter Name pairs, though it may reference a Meter:Custom.

Field	Type	Details
`name` Name required	string
`resource_type` Resource Type	choice	One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `Generic`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`, `Water`
`source_meter_name` Source Meter Name required	string	Cannot reference another Meter:CustomDecrement.
`variable_details`	list	Each item: `key_name`, `output_variable_or_meter_name`

Output:Constructions¶

from idfpy.models import OutputConstructions

Adds a report to the eio output file which shows details for each construction, including overall properties, a list of material layers, and calculated results related to conduction transfer functions.

Field	Type	Default	Details
`details_type_1` Details Type 1	choice		One of `Constructions`, `Materials`
`details_type_2` Details Type 2	choice		One of `Constructions`, `Materials`

Output:DebuggingData¶

from idfpy.models import OutputDebuggingData unique

switch eplusout.dbg file on or off

Field	Type	Default	Details
`report_debugging_data` Report Debugging Data	choice	`No`	One of `No`, `Yes`
`report_during_warmup` Report During Warmup	choice	`No`	One of `No`, `Yes`

Output:Diagnostics¶

from idfpy.models import OutputDiagnostics unique extensible

Special keys to produce certain warning messages or effect certain simulation characteristics.

Field	Type	Default	Details
`diagnostics`	list		Each item: `key`

Output:EnergyManagementSystem¶

from idfpy.models import OutputEnergyManagementSystem unique

This object is used to control the output produced by the Energy Management System

Field	Type	Default	Details
`actuator_availability_dictionary_reporting` Actuator Availability Dictionary Reporting	choice	`None`	One of `None`, `NotByUniqueKeyNames`, `Verbose`
`internal_variable_availability_dictionary_reporting` Internal Variable Availability Dictionary Reporting	choice	`None`	One of `None`, `NotByUniqueKeyNames`, `Verbose`
`ems_runtime_language_debug_output_level` EMS Runtime Language Debug Output Level	choice	`None`	One of `ErrorsOnly`, `None`, `Verbose`

Output:EnvironmentalImpactFactors¶

from idfpy.models import OutputEnvironmentalImpactFactors

This is used to Automatically report the facility meters and turn on the Environmental Impact Report calculations for all of the Environmental Factors.

Field	Type	Default	Details
`reporting_frequency` Reporting Frequency	choice		Timestep refers to the zone Timestep/Number of Timesteps in hour value RunPeriod and Environment are the same. Detailed is not a valid choice. One of `Annual`, `Daily`, `Environment`, `Hourly`, `Monthly`, `RunPeriod`, `Timestep`

Output:JSON¶

from idfpy.models import OutputJSON unique

Output from EnergyPlus can be written to JSON format files.

Field	Type	Default	Details
`option_type` Option Type required	choice		One of `TimeSeries`, `TimeSeriesAndTabular`
`output_json` Output JSON	choice	`Yes`	One of `No`, `Yes`
`output_cbor` Output CBOR	choice	`No`	One of `No`, `Yes`
`output_messagepack` Output MessagePack	choice	`No`	One of `No`, `Yes`
`unit_conversion_for_tabular_data` Unit Conversion for Tabular Data	choice	`UseOutputControlTableStyle`	Unit conversion option used when writing JSON Tabular Data This option applies to TabularData and TabularDatawithString in the JSON file(s) One of `InchPound`, `InchPoundExceptElectricity`, `JtoGJ`, `JtoKWH`, `JtoMJ`, `None`, `UseOutputControlTableStyle`
`format_numeric_values_for_tabular_data` Format Numeric Values for Tabular Data	choice	`Yes`	If No, all digits are shown after the decimal point without any rounding (23.238769213). If Yes, values are rounded for readability (23.24). One of `No`, `Yes`

Output:Meter¶

from idfpy.models import OutputMeter

Each Output:Meter command picks meters to be put onto the standard output file (.eso) and meter file (.mtr). Not all meters are reported in every simulation. A list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Field	Type	Default	Details
`key_name` Key Name required	string		Form is EnergyUseType:..., e.g. Electricity:* for all Electricity meters or EndUse:..., e.g. GeneralLights:* for all General Lights Output:Meter puts results on both the eplusout.mtr and eplusout.eso files
`reporting_frequency` Reporting Frequency	choice	`Hourly`	Timestep refers to the zone Timestep/Number of Timesteps in hour value RunPeriod and Environment are the same One of `Annual`, `Daily`, `Detailed`, `Environment`, `Hourly`, `Monthly`, `RunPeriod`, `Timestep`

Output:Meter:Cumulative¶

from idfpy.models import OutputMeterCumulative

Each Output:Meter:Cumulative command picks meters to be reported cumulatively onto the standard output file (.eso) and meter file (.mtr). Not all meters are reported in every simulation. a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Field	Type	Default	Details
`key_name` Key Name required	string		Form is EnergyUseType:..., e.g. Electricity:* for all Electricity meters or EndUse:..., e.g. GeneralLights:* for all General Lights Output:Meter:Cumulative puts results on both the eplusout.mtr and eplusout.eso files
`reporting_frequency` Reporting Frequency	choice	`Hourly`	Timestep refers to the zone Timestep/Number of Timesteps in hour value RunPeriod and Environment are the same One of `Annual`, `Daily`, `Detailed`, `Environment`, `Hourly`, `Monthly`, `RunPeriod`, `Timestep`

Output:Meter:Cumulative:MeterFileOnly¶

from idfpy.models import OutputMeterCumulativeMeterFileOnly

Each Output:Meter:Cumulative:MeterFileOnly command picks meters to be reported cumulatively onto the standard output file (.eso) and meter file (.mtr). Not all meters are reported in every simulation. a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Field	Type	Default	Details
`key_name` Key Name required	string		Form is EnergyUseType:..., e.g. Electricity:* for all Electricity meters or EndUse:..., e.g. GeneralLights:* for all General Lights Output:Meter:Cumulative:MeterFileOnly puts results on the eplusout.mtr file only
`reporting_frequency` Reporting Frequency	choice	`Hourly`	Timestep refers to the zone Timestep/Number of Timesteps in hour value RunPeriod and Environment are the same One of `Annual`, `Daily`, `Detailed`, `Environment`, `Hourly`, `Monthly`, `RunPeriod`, `Timestep`

Output:Meter:MeterFileOnly¶

from idfpy.models import OutputMeterMeterFileOnly

Each Output:Meter:MeterFileOnly command picks meters to be put only onto meter file (.mtr). Not all meters are reported in every simulation. A list of meters that can be reported a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Field	Type	Default	Details
`key_name` Key Name required	string		Form is EnergyUseType:..., e.g. Electricity:* for all Electricity meters or EndUse:..., e.g. GeneralLights:* for all General Lights Output:Meter:MeterFileOnly puts results on the eplusout.mtr file only
`reporting_frequency` Reporting Frequency	choice	`Hourly`	Timestep refers to the zone Timestep/Number of Timesteps in hour value RunPeriod and Environment are the same One of `Annual`, `Daily`, `Detailed`, `Environment`, `Hourly`, `Monthly`, `RunPeriod`, `Timestep`

Output:PreprocessorMessage¶

from idfpy.models import OutputPreprocessorMessage

This object does not come from a user input. This is generated by a pre-processor so that various conditions can be gracefully passed on by the InputProcessor.

Field	Type	Details
`preprocessor_name` Preprocessor Name	string
`error_severity` Error Severity	choice	Depending on type, InputProcessor may terminate the program. One of `Fatal`, `Information`, `Severe`, `Warning`
`message_line_1` Message Line 1	string
`message_line_2` Message Line 2	string
`message_line_3` Message Line 3	string
`message_line_4` Message Line 4	string
`message_line_5` Message Line 5	string
`message_line_6` Message Line 6	string
`message_line_7` Message Line 7	string
`message_line_8` Message Line 8	string
`message_line_9` Message Line 9	string
`message_line_10` Message Line 10	string

Output:SQLite¶

from idfpy.models import OutputSQLite unique

Output from EnergyPlus can be written to an SQLite format file.

Field	Type	Default	Details
`option_type` Option Type	choice		One of `Simple`, `SimpleAndTabular`
`unit_conversion_for_tabular_data` Unit Conversion for Tabular Data	choice	`UseOutputControlTableStyle`	Unit conversion option used when writing SQLite Tabular Data This option applies to TabularData and TabularDatawithString in the SQLite file One of `InchPound`, `InchPoundExceptElectricity`, `JtoGJ`, `JtoKWH`, `JtoMJ`, `None`, `UseOutputControlTableStyle`
`format_numeric_values_for_tabular_data` Format Numeric Values for Tabular Data	choice	`Yes`	If No, all digits are shown after the decimal point without any rounding (23.238769213). If Yes, values are rounded for readability (23.24). One of `No`, `Yes`

Output:Schedules¶

from idfpy.models import OutputSchedules

Produces a condensed reporting that illustrates the full range of schedule values in the eio output file. In the style of input: DaySchedule, WeekSchedule, and Annual Schedule.

Field	Type	Default	Details
`key_field` Key Field required	choice		One of `Hourly`, `Timestep`

Output:Surfaces:Drawing¶

from idfpy.models import OutputSurfacesDrawing

Produces reports/files that are capable of rendering graphically or being imported into other programs. Rendering does not alter the actual inputs/surfaces.

Field	Type	Default	Details
`report_type` Report Type required	choice		One of `DXF`, `DXF:WireFrame`, `VRML`
`report_specifications_1` Report Specifications 1	choice	`Triangulate3DFace`	Triangulate3DFace (default), ThickPolyline, RegularPolyline apply to DXF This field is ignored for DXF:WireFrame and VRML One of `RegularPolyline`, `ThickPolyline`, `Triangulate3DFace`
`report_specifications_2` Report Specifications 2	reference		Use ColorScheme Name for DXF reports Names a OutputControl:SurfaceColorScheme

Output:Surfaces:List¶

from idfpy.models import OutputSurfacesList

Produces a report summarizing the details of surfaces in the eio output file.

Field	Type	Default	Details
`report_type` Report Type required	choice		One of `CostInfo`, `DecayCurvesFromComponentLoadsSummary`, `Details`, `DetailsWithVertices`, `Lines`, `Vertices`, `ViewFactorInfo`
`report_specifications` Report Specifications	choice		(IDF, only for Output:Surfaces:List, Lines report -- will print transformed coordinates in IDF style) One of `IDF`

Output:Table:Annual¶

from idfpy.models import OutputTableAnnual extensible

Provides a generic method of setting up tables of annual results with one row per object. The report has multiple columns that are each defined using a repeated group of fields for any number of columns. A single Output:Table:Annual produces a single table in the output.

Field	Type	Details
`name` Name required	string
`filter` Filter	string	An optional text string that is compared to the names of the objects referenced by the variables and if they match are included in the table. A footnote will appear that indicates that the objects shown may not be all the objects that of that type that occur in the file.
`schedule_name` Schedule Name	reference	Optional schedule name. If left blank, aggregation is performed for all hours simulated. If a schedule is specified, aggregation is performed for non-zero hours in the schedule. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`variable_details`	list	Each item: `variable_or_meter_or_ems_variable_or_field_name`, `aggregation_type_for_variable_or_meter`, `digits_after_decimal`

Output:Table:Monthly¶

from idfpy.models import OutputTableMonthly extensible

Provides a generic method of setting up tables of monthly results. The report has multiple columns that are each defined using a repeated group of fields for any number of columns. A single Output:Table:Monthly object often produces multiple tables in the output. A table is produced for every instance of a particular output variable. For example, a table defined with zone variables will be produced once for every zone.

Field	Type	Default	Details
`name` Name required	string
`digits_after_decimal` Digits After Decimal	integer	`2`	Range: ≥ 0, ≤ 10
`variable_details`	list		Each item: `variable_or_meter_name`, `aggregation_type_for_variable_or_meter`

Output:Table:ReportPeriod¶

from idfpy.models import OutputTableReportPeriod

This object allows the user to generate the resilience tabular reports over a subset of a run period. When it is defined, a series of reporting-period-specific resilience summary tables will be generated at the end of all tabular reports. Multiple reporting periods may be input.

Field	Type	Details
`name` Name required	string	descriptive name cannot be blank and must be unique
`report_name` Report Name	choice	currently only allow for these tables, could be extended in the future One of `AllResilienceSummaries`, `CO2ResilienceSummary`, `ThermalResilienceSummary`, `VisualResilienceSummary`
`begin_year` Begin Year	integer	start year of reporting, if specified
`begin_month` Begin Month required	integer	Range: ≥ 1, ≤ 12
`begin_day_of_month` Begin Day of Month required	integer	Range: ≥ 1, ≤ 31
`begin_hour_of_day` Begin Hour of Day required	integer	Range: ≥ 1, ≤ 24
`end_year` End Year	integer	start year of reporting, if specified
`end_month` End Month required	integer	Range: ≥ 1, ≤ 12
`end_day_of_month` End Day of Month required	integer	Range: ≥ 1, ≤ 31
`end_hour_of_day` End Hour of Day required	integer	Range: ≥ 1, ≤ 24

Output:Table:SummaryReports¶

from idfpy.models import OutputTableSummaryReports unique extensible

This object allows the user to call report types that are predefined and will appear with the other tabular reports. These predefined reports are sensitive to the OutputControl:Table:Style object and appear in the same files as the tabular reports. The entries for this object is a list of the predefined reports that should appear in the tabular report output file.

Field	Type	Default	Details
`reports`	list		Each item: `report_name`

Output:Table:TimeBins¶

from idfpy.models import OutputTableTimeBins

Produces a bin report in the table output file which shows the amount of time in hours that occurs in different bins for a single specific output variable or meter. Two different types of binning are reported: by month and by hour of the day.

Field	Type	Default	Details
`key_value` Key Value	string	`*`	use '*' (without quotes) to apply this variable to all keys
`variable_name` Variable Name required	string
`interval_start` Interval Start	number		The lowest value for the intervals being binned into.
`interval_size` Interval Size	number		The size of the bins starting with Interval start.
`interval_count` Interval Count	integer		The number of bins used. The number of hours below the start of the Lowest bin and above the value of the last bin are also shown. Range: ≥ 1, ≤ 20
`schedule_name` Schedule Name	reference		Optional schedule name. Binning is performed for non-zero hours. Binning always performed if left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`variable_type` Variable Type	choice		Optional input on the type of units for the variable used by other fields in the object. One of `Energy`, `Power`, `Temperature`, `VolumetricFlow`

Output:Variable¶

from idfpy.models import OutputVariable

each Output:Variable command picks variables to be put onto the standard output file (.eso) some variables may not be reported for every simulation. a list of variables that can be reported are available after a run on the report dictionary file (.rdd) if the Output:VariableDictionary has been requested.

Field	Type	Default	Details
`key_value` Key Value	string	`*`	use '*' (without quotes) to apply this variable to all keys
`variable_name` Variable Name required	string
`reporting_frequency` Reporting Frequency	choice	`Hourly`	Detailed lists every instance (i.e. HVAC variable timesteps) Timestep refers to the zone Timestep/Number of Timesteps in hour value RunPeriod and Environment are the same One of `Annual`, `Daily`, `Detailed`, `Environment`, `Hourly`, `Monthly`, `RunPeriod`, `Timestep`
`schedule_name` Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Output:VariableDictionary¶

from idfpy.models import OutputVariableDictionary

Produces a list summarizing the output variables and meters that are available for reporting for the model being simulated (rdd output file). The list varies depending on the types of objects present in the idf file. For example, variables related to lights will only appear if a Lights object is present. The IDF option generates complete Output:Variable objects to simplify adding the desired output to the idf file.

Field	Type	Default	Details
`key_field` Key Field	choice	`regular`	One of `IDF`, `regular`
`sort_option` Sort Option	choice		One of `Name`, `Unsorted`

OutputControl:Files¶

from idfpy.models import OutputControlFiles unique

Conditionally turn on/off output from EnergyPlus.

Field	Type	Default	Details
`output_csv` Output CSV	choice	`No`	One of `No`, `Yes`
`output_mtr` Output MTR	choice	`Yes`	One of `No`, `Yes`
`output_eso` Output ESO	choice	`Yes`	One of `No`, `Yes`
`output_eio` Output EIO	choice	`Yes`	One of `No`, `Yes`
`output_tabular` Output Tabular	choice	`Yes`	One of `No`, `Yes`
`output_sqlite` Output SQLite	choice	`Yes`	One of `No`, `Yes`
`output_json` Output JSON	choice	`Yes`	One of `No`, `Yes`
`output_audit` Output AUDIT	choice	`Yes`	One of `No`, `Yes`
`output_space_sizing` Output Space Sizing	choice	`Yes`	One of `No`, `Yes`
`output_zone_sizing` Output Zone Sizing	choice	`Yes`	One of `No`, `Yes`
`output_system_sizing` Output System Sizing	choice	`Yes`	One of `No`, `Yes`
`output_dxf` Output DXF	choice	`Yes`	One of `No`, `Yes`
`output_bnd` Output BND	choice	`Yes`	One of `No`, `Yes`
`output_rdd` Output RDD	choice	`Yes`	One of `No`, `Yes`
`output_mdd` Output MDD	choice	`Yes`	One of `No`, `Yes`
`output_mtd` Output MTD	choice	`Yes`	One of `No`, `Yes`
`output_end` Output END	choice	`Yes`	One of `No`, `Yes`
`output_shd` Output SHD	choice	`Yes`	One of `No`, `Yes`
`output_dfs` Output DFS	choice	`Yes`	One of `No`, `Yes`
`output_glhe` Output GLHE	choice	`Yes`	One of `No`, `Yes`
`output_delightin` Output DelightIn	choice	`Yes`	One of `No`, `Yes`
`output_delighteldmp` Output DelightELdmp	choice	`Yes`	One of `No`, `Yes`
`output_delightdfdmp` Output DelightDFdmp	choice	`Yes`	One of `No`, `Yes`
`output_edd` Output EDD	choice	`Yes`	One of `No`, `Yes`
`output_dbg` Output DBG	choice	`Yes`	One of `No`, `Yes`
`output_perflog` Output PerfLog	choice	`Yes`	One of `No`, `Yes`
`output_sln` Output SLN	choice	`Yes`	One of `No`, `Yes`
`output_sci` Output SCI	choice	`Yes`	One of `No`, `Yes`
`output_wrl` Output WRL	choice	`Yes`	One of `No`, `Yes`
`output_screen` Output Screen	choice	`Yes`	One of `No`, `Yes`
`output_extshd` Output ExtShd	choice	`Yes`	One of `No`, `Yes`
`output_tarcog` Output Tarcog	choice	`Yes`	Not Implemented Yet One of `No`, `Yes`
`output_plant_component_sizing` Output Plant Component Sizing	choice	`Yes`	epluspsz.csv One of `No`, `Yes`

OutputControl:ReportingTolerances¶

from idfpy.models import OutputControlReportingTolerances unique

Calculations of the time that setpoints are not met use a tolerance of 0.2C. This object allows changing the tolerance used to determine when setpoints are being met.

Field	Type	Default	Details
`tolerance_for_time_heating_setpoint_not_met` Tolerance for Time Heating Setpoint Not Met	number deltaC	`0.2`	If the zone temperature is below the heating setpoint by more than this value, the following output variables will increment as appropriate Zone Heating Setpoint Not Met Time Zone Heating Setpoint Not Met While Occupied Time This also impacts table report "Annual Building Utility Performance Summary" subtable "Comfort and Setpoint Not Met Summary" Range: ≥ 0, ≤ 10
`tolerance_for_time_cooling_setpoint_not_met` Tolerance for Time Cooling Setpoint Not Met	number deltaC	`0.2`	If the zone temperature is above the cooling setpoint by more than this value, the following output variables will increment as appropriate Zone Cooling Setpoint Not Met Time Zone Cooling Setpoint Not Met While Occupied Time This also impacts table report "Annual Building Utility Performance Summary" subtable "Comfort and Setpoint Not Met Summary" Range: ≥ 0, ≤ 10

OutputControl:ResilienceSummaries¶

from idfpy.models import OutputControlResilienceSummaries unique

Specifies methods for resilience reporting variables

Field	Type	Default	Details
`heat_index_algorithm` Heat Index Algorithm	choice	`Simplified`	Whether the simplified or the extended method should be used for heat index Simplified: based on regression analysis carried out by Lans P. Rothfusz Extended: Based on paper by Lu & Romps One of `Extended`, `Simplified`

OutputControl:SurfaceColorScheme¶

from idfpy.models import OutputControlSurfaceColorScheme

This object is used to set colors for reporting on various building elements particularly for the DXF reports. We know the user can enter 0 to 255 and the color map is available in DXF output. Therefore, we are limiting the colors in that range. You can extend by editing the IDD but you do so on your own. Colors not changed in any scheme will remain as the default scheme uses.

Field	Type	Details
`name` Name required	string	choose a name or use one of the DataSets
`drawing_element_1_type` Drawing Element 1 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_1` Color for Drawing Element 1	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_2_type` Drawing Element 2 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_2` Color for Drawing Element 2	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_3_type` Drawing Element 3 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_3` Color for Drawing Element 3	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_4_type` Drawing Element 4 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_4` Color for Drawing Element 4	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_5_type` Drawing Element 5 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_5` Color for Drawing Element 5	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_6_type` Drawing Element 6 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_6` Color for Drawing Element 6	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_7_type` Drawing Element 7 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_7` Color for Drawing Element 7	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_8_type` Drawing Element 8 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_8` Color for Drawing Element 8	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_9_type` Drawing Element 9 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_9` Color for Drawing Element 9	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_10_type` Drawing Element 10 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_10` Color for Drawing Element 10	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_11_type` Drawing Element 11 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_11` Color for Drawing Element 11	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_12_type` Drawing Element 12 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_12` Color for Drawing Element 12	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_13_type` Drawing Element 13 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_13` Color for Drawing Element 13	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_14_type` Drawing Element 14 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_14` Color for Drawing Element 14	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255
`drawing_element_15_type` Drawing Element 15 Type	choice	One of `AttachedBuildingShades`, `DaylightReferencePoint1`, `DaylightReferencePoint2`, `DetachedBuildingShades`, `DetachedFixedShades`, `Doors`, `Floors`, `GlassDoors`, `Photovoltaics`, `Roofs`, `Text`, `TubularDaylightDiffusers`, `TubularDaylightDomes`, `Walls`, `Windows`
`color_for_drawing_element_15` Color for Drawing Element 15	integer	use color number for output assignment (e.g. DXF) Range: ≥ 0, ≤ 255

Referenced by 1 object types

Output:Surfaces:Drawing

OutputControl:Table:Style¶

from idfpy.models import OutputControlTableStyle unique

default style for the OutputControl:Table:Style is comma -- this works well for importing into spreadsheet programs such as Excel™ but not so well for word processing programs -- there tab may be a better choice. fixed puts spaces between the "columns". HTML produces tables in HTML. XML produces an XML file. note - if no OutputControl:Table:Style is included, the defaults are comma and None.

Field	Type	Default	Details
`column_separator` Column Separator	choice	`Comma`	One of `All`, `Comma`, `CommaAndHTML`, `CommaAndXML`, `Fixed`, `HTML`, `Tab`, `TabAndHTML`, `XML`, `XMLandHTML`
`unit_conversion` Unit Conversion	choice	`None`	One of `InchPound`, `InchPoundExceptElectricity`, `JtoGJ`, `JtoKWH`, `JtoMJ`, `None`
`format_numeric_values` Format Numeric Values	choice	`Yes`	If No, all digits are shown after the decimal point without any rounding (23.238769213). If Yes, values are rounded for readability (23.24). One of `No`, `Yes`

OutputControl:Timestamp¶

from idfpy.models import OutputControlTimestamp unique

Control timestamp format, currently applies only to JSON and native CSV (not CSV via ReadVars)

Field	Type	Default	Details
`iso_8601_format` ISO 8601 Format	choice	`No`	Use the ISO 8601 format YYYY-MM-DDThhss One of `No`, `Yes`
`timestamp_at_beginning_of_interval` Timestamp at Beginning of Interval	choice	`No`	Determines where the timestamp is produced, either at the beginning (Yes) or end (No) of the interval One of `No`, `Yes`