pyidf.output_reporting module

Data objects in group “Output Reporting”

class pyidf.output_reporting.EnvironmentalImpactFactors

Bases: pyidf.helper.DataObject

Corresponds to IDD object 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.

district_cooling_cop

field District Cooling COP

District cooling COP used when converted to electricity

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field District Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of district_cooling_cop or None if not set Return type:float

district_heating_efficiency

field District Heating Efficiency

District heating efficiency used when converted to natural gas

Default value: 0.3

Parameters:value (float) – value for IDD Field District Heating Efficiency Raises:ValueError – if value is not a valid value Returns:the value of district_heating_efficiency or None if not set Return type:float

steam_conversion_efficiency

field Steam Conversion Efficiency

Steam conversion efficiency used to convert steam usage to natural gas

Default value: 0.25

Parameters:value (float) – value for IDD Field Steam Conversion Efficiency Raises:ValueError – if value is not a valid value Returns:the value of steam_conversion_efficiency or None if not set Return type:float

total_carbon_equivalent_emission_factor_from_ch4

field Total Carbon Equivalent Emission Factor From CH4

Units: kg/kg

Default value: 6.2727

Parameters:value (float) – value for IDD Field Total Carbon Equivalent Emission Factor From CH4 Raises:ValueError – if value is not a valid value Returns:the value of total_carbon_equivalent_emission_factor_from_ch4 or None if not set Return type:float

total_carbon_equivalent_emission_factor_from_co2

field Total Carbon Equivalent Emission Factor From CO2

Units: kg/kg

Default value: 0.2727

Parameters:value (float) – value for IDD Field Total Carbon Equivalent Emission Factor From CO2 Raises:ValueError – if value is not a valid value Returns:the value of total_carbon_equivalent_emission_factor_from_co2 or None if not set Return type:float

total_carbon_equivalent_emission_factor_from_n2o

field Total Carbon Equivalent Emission Factor From N2O

Units: kg/kg

Default value: 80.7272

Parameters:value (float) – value for IDD Field Total Carbon Equivalent Emission Factor From N2O Raises:ValueError – if value is not a valid value Returns:the value of total_carbon_equivalent_emission_factor_from_n2o or None if not set Return type:float

class pyidf.output_reporting.FuelFactors

Bases: pyidf.helper.DataObject

Corresponds to IDD object 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).

ch4_emission_factor

field CH4 Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field CH4 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of ch4_emission_factor or None if not set Return type:float

ch4_emission_factor_schedule_name

field CH4 Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field CH4 Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of ch4_emission_factor_schedule_name or None if not set Return type:str

co2_emission_factor

field CO2 Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field CO2 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of co2_emission_factor or None if not set Return type:float

co2_emission_factor_schedule_name

field CO2 Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field CO2 Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of co2_emission_factor_schedule_name or None if not set Return type:str

co_emission_factor

field CO Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field CO Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of co_emission_factor or None if not set Return type:float

co_emission_factor_schedule_name

field CO Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field CO Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of co_emission_factor_schedule_name or None if not set Return type:str

energy_per_unit_factor

field Energy per Unit Factor

Parameters:value (float) – value for IDD Field Energy per Unit Factor Raises:ValueError – if value is not a valid value Returns:the value of energy_per_unit_factor or None if not set Return type:float

existing_fuel_resource_name

field Existing Fuel Resource Name

Parameters:value (str) – value for IDD Field Existing Fuel Resource Name Raises:ValueError – if value is not a valid value Returns:the value of existing_fuel_resource_name or None if not set Return type:str

hg_emission_factor

field Hg Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field Hg Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of hg_emission_factor or None if not set Return type:float

hg_emission_factor_schedule_name

field Hg Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field Hg Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of hg_emission_factor_schedule_name or None if not set Return type:str

n2o_emission_factor

field N2O Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field N2O Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of n2o_emission_factor or None if not set Return type:float

n2o_emission_factor_schedule_name

field N2O Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field N2O Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of n2o_emission_factor_schedule_name or None if not set Return type:str

nh3_emission_factor

field NH3 Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field NH3 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of nh3_emission_factor or None if not set Return type:float

nh3_emission_factor_schedule_name

field NH3 Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field NH3 Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of nh3_emission_factor_schedule_name or None if not set Return type:str

nmvoc_emission_factor

field NMVOC Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field NMVOC Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of nmvoc_emission_factor or None if not set Return type:float

nmvoc_emission_factor_schedule_name

field NMVOC Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field NMVOC Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of nmvoc_emission_factor_schedule_name or None if not set Return type:str

nox_emission_factor

field NOx Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field NOx Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of nox_emission_factor or None if not set Return type:float

nox_emission_factor_schedule_name

field NOx Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field NOx Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of nox_emission_factor_schedule_name or None if not set Return type:str

nuclear_high_level_emission_factor

field Nuclear High Level Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field Nuclear High Level Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of nuclear_high_level_emission_factor or None if not set Return type:float

nuclear_high_level_emission_factor_schedule_name

field Nuclear High Level Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field Nuclear High Level Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of nuclear_high_level_emission_factor_schedule_name or None if not set Return type:str

nuclear_low_level_emission_factor

field Nuclear Low Level Emission Factor

Units: m3/MJ

Parameters:value (float) – value for IDD Field Nuclear Low Level Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of nuclear_low_level_emission_factor or None if not set Return type:float

nuclear_low_level_emission_factor_schedule_name

field Nuclear Low Level Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field Nuclear Low Level Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of nuclear_low_level_emission_factor_schedule_name or None if not set Return type:str

pb_emission_factor

field Pb Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field Pb Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of pb_emission_factor or None if not set Return type:float

pb_emission_factor_schedule_name

field Pb Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field Pb Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of pb_emission_factor_schedule_name or None if not set Return type:str

pm10_emission_factor

field PM10 Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field PM10 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of pm10_emission_factor or None if not set Return type:float

pm10_emission_factor_schedule_name

field PM10 Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field PM10 Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of pm10_emission_factor_schedule_name or None if not set Return type:str

pm2_5_emission_factor

field PM2.5 Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field PM2.5 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of pm2_5_emission_factor or None if not set Return type:float

pm2_5_emission_factor_schedule_name

field PM2.5 Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field PM2.5 Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of pm2_5_emission_factor_schedule_name or None if not set Return type:str

pm_emission_factor

field PM Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field PM Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of pm_emission_factor or None if not set Return type:float

pm_emission_factor_schedule_name

field PM Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field PM Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of pm_emission_factor_schedule_name or None if not set Return type:str

so2_emission_factor

field SO2 Emission Factor

Units: g/MJ

Parameters:value (float) – value for IDD Field SO2 Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of so2_emission_factor or None if not set Return type:float

so2_emission_factor_schedule_name

field SO2 Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field SO2 Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of so2_emission_factor_schedule_name or None if not set Return type:str

source_energy_factor

field Source Energy Factor

Units: J/J

Parameters:value (float) – value for IDD Field Source Energy Factor Raises:ValueError – if value is not a valid value Returns:the value of source_energy_factor or None if not set Return type:float

source_energy_schedule_name

field Source Energy Schedule Name

Parameters:value (str) – value for IDD Field Source Energy Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of source_energy_schedule_name or None if not set Return type:str

units_of_measure

field Units of Measure

Parameters:value (str) – value for IDD Field Units of Measure Raises:ValueError – if value is not a valid value Returns:the value of units_of_measure or None if not set Return type:str

water_emission_factor

field Water Emission Factor

Units: L/MJ

Parameters:value (float) – value for IDD Field Water Emission Factor Raises:ValueError – if value is not a valid value Returns:the value of water_emission_factor or None if not set Return type:float

water_emission_factor_schedule_name

field Water Emission Factor Schedule Name

Parameters:value (str) – value for IDD Field Water Emission Factor Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of water_emission_factor_schedule_name or None if not set Return type:str

class pyidf.output_reporting.MeterCustom

Bases: pyidf.helper.DataObject

Corresponds to IDD object Meter:Custom 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.

add_extensible(key_name_1=None, output_variable_or_meter_name_1=None)

Add values for extensible fields

Parameters:

• key_name_1 (str) – value for IDD Field Key Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• output_variable_or_meter_name_1 (str) – value for IDD Field Output Variable or Meter Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

fuel_type

field Fuel Type

Parameters:value (str) – value for IDD Field Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of fuel_type or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

class pyidf.output_reporting.MeterCustomDecrement

Bases: pyidf.helper.DataObject

Corresponds to IDD object Meter:CustomDecrement 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.

add_extensible(key_name_1=None, output_variable_or_meter_name_1=None)

Add values for extensible fields

Parameters:

• key_name_1 (str) – value for IDD Field Key Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• output_variable_or_meter_name_1 (str) – value for IDD Field Output Variable or Meter Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

fuel_type

field Fuel Type

Parameters:value (str) – value for IDD Field Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of fuel_type or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

source_meter_name

field Source Meter Name

Parameters:value (str) – value for IDD Field Source Meter Name Raises:ValueError – if value is not a valid value Returns:the value of source_meter_name or None if not set Return type:str

class pyidf.output_reporting.OutputConstructions

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Constructions 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.

details_type_1

field Details Type 1

Parameters:value (str) – value for IDD Field Details Type 1 Raises:ValueError – if value is not a valid value Returns:the value of details_type_1 or None if not set Return type:str

details_type_2

field Details Type 2

Parameters:value (str) – value for IDD Field Details Type 2 Raises:ValueError – if value is not a valid value Returns:the value of details_type_2 or None if not set Return type:str

class pyidf.output_reporting.OutputControlReportingTolerances

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutputControl:ReportingTolerances 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.

tolerance_for_time_cooling_setpoint_not_met

field Tolerance for Time Cooling Setpoint Not Met

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”

Units: deltaC

Default value: 0.2

value <= 10.0

Parameters:value (float) – value for IDD Field Tolerance for Time Cooling Setpoint Not Met Raises:ValueError – if value is not a valid value Returns:the value of tolerance_for_time_cooling_setpoint_not_met or None if not set Return type:float

tolerance_for_time_heating_setpoint_not_met

field Tolerance for Time Heating Setpoint Not Met

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”

Units: deltaC

Default value: 0.2

value <= 10.0

Parameters:value (float) – value for IDD Field Tolerance for Time Heating Setpoint Not Met Raises:ValueError – if value is not a valid value Returns:the value of tolerance_for_time_heating_setpoint_not_met or None if not set Return type:float

class pyidf.output_reporting.OutputControlSurfaceColorScheme

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutputControl:SurfaceColorScheme 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.

color_for_drawing_element_1

field Color for Drawing Element 1

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 1 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_1 or None if not set Return type:int

color_for_drawing_element_10

field Color for Drawing Element 10

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 10 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_10 or None if not set Return type:int

color_for_drawing_element_11

field Color for Drawing Element 11

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 11 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_11 or None if not set Return type:int

color_for_drawing_element_12

field Color for Drawing Element 12

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 12 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_12 or None if not set Return type:int

color_for_drawing_element_13

field Color for Drawing Element 13

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 13 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_13 or None if not set Return type:int

color_for_drawing_element_14

field Color for Drawing Element 14

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 14 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_14 or None if not set Return type:int

color_for_drawing_element_15

field Color for Drawing Element 15

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 15 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_15 or None if not set Return type:int

color_for_drawing_element_2

field Color for Drawing Element 2

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 2 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_2 or None if not set Return type:int

color_for_drawing_element_3

field Color for Drawing Element 3

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 3 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_3 or None if not set Return type:int

color_for_drawing_element_4

field Color for Drawing Element 4

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 4 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_4 or None if not set Return type:int

color_for_drawing_element_5

field Color for Drawing Element 5

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 5 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_5 or None if not set Return type:int

color_for_drawing_element_6

field Color for Drawing Element 6

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 6 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_6 or None if not set Return type:int

color_for_drawing_element_7

field Color for Drawing Element 7

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 7 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_7 or None if not set Return type:int

color_for_drawing_element_8

field Color for Drawing Element 8

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 8 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_8 or None if not set Return type:int

color_for_drawing_element_9

field Color for Drawing Element 9

use color number for output assignment (e.g. DXF)

value <= 255

Parameters:value (int) – value for IDD Field Color for Drawing Element 9 Raises:ValueError – if value is not a valid value Returns:the value of color_for_drawing_element_9 or None if not set Return type:int

drawing_element_10_type

field Drawing Element 10 Type

Parameters:value (str) – value for IDD Field Drawing Element 10 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_10_type or None if not set Return type:str

drawing_element_11_type

field Drawing Element 11 Type

Parameters:value (str) – value for IDD Field Drawing Element 11 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_11_type or None if not set Return type:str

drawing_element_12_type

field Drawing Element 12 Type

Parameters:value (str) – value for IDD Field Drawing Element 12 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_12_type or None if not set Return type:str

drawing_element_13_type

field Drawing Element 13 Type

Parameters:value (str) – value for IDD Field Drawing Element 13 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_13_type or None if not set Return type:str

drawing_element_14_type

field Drawing Element 14 Type

Parameters:value (str) – value for IDD Field Drawing Element 14 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_14_type or None if not set Return type:str

drawing_element_15_type

field Drawing Element 15 Type

Parameters:value (str) – value for IDD Field Drawing Element 15 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_15_type or None if not set Return type:str

drawing_element_1_type

field Drawing Element 1 Type

Parameters:value (str) – value for IDD Field Drawing Element 1 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_1_type or None if not set Return type:str

drawing_element_2_type

field Drawing Element 2 Type

Parameters:value (str) – value for IDD Field Drawing Element 2 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_2_type or None if not set Return type:str

drawing_element_3_type

field Drawing Element 3 Type

Parameters:value (str) – value for IDD Field Drawing Element 3 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_3_type or None if not set Return type:str

drawing_element_4_type

field Drawing Element 4 Type

Parameters:value (str) – value for IDD Field Drawing Element 4 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_4_type or None if not set Return type:str

drawing_element_5_type

field Drawing Element 5 Type

Parameters:value (str) – value for IDD Field Drawing Element 5 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_5_type or None if not set Return type:str

drawing_element_6_type

field Drawing Element 6 Type

Parameters:value (str) – value for IDD Field Drawing Element 6 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_6_type or None if not set Return type:str

drawing_element_7_type

field Drawing Element 7 Type

Parameters:value (str) – value for IDD Field Drawing Element 7 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_7_type or None if not set Return type:str

drawing_element_8_type

field Drawing Element 8 Type

Parameters:value (str) – value for IDD Field Drawing Element 8 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_8_type or None if not set Return type:str

drawing_element_9_type

field Drawing Element 9 Type

Parameters:value (str) – value for IDD Field Drawing Element 9 Type Raises:ValueError – if value is not a valid value Returns:the value of drawing_element_9_type or None if not set Return type:str

name

field Name

choose a name or use one of the DataSets

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

class pyidf.output_reporting.OutputControlTableStyle

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutputControl:Table:Style default style for the OutputControl:Table:Style is comma – this works well for importing into spreadsheet programs such as Excel(tm) 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.

column_separator

field Column Separator

Default value: Comma

Parameters:value (str) – value for IDD Field Column Separator Raises:ValueError – if value is not a valid value Returns:the value of column_separator or None if not set Return type:str

unit_conversion

field Unit Conversion

Default value: None

Parameters:value (str) – value for IDD Field Unit Conversion Raises:ValueError – if value is not a valid value Returns:the value of unit_conversion or None if not set Return type:str

class pyidf.output_reporting.OutputDebuggingData

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:DebuggingData switch eplusout.dbg file on or off

report_debugging_data

field Report Debugging Data

value=1 then yes all others no

Parameters:value (float) – value for IDD Field Report Debugging Data Raises:ValueError – if value is not a valid value Returns:the value of report_debugging_data or None if not set Return type:float

report_during_warmup

field Report During Warmup

value=1 then always even during warmup all others no

Parameters:value (float) – value for IDD Field Report During Warmup Raises:ValueError – if value is not a valid value Returns:the value of report_during_warmup or None if not set Return type:float

class pyidf.output_reporting.OutputDiagnostics

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Diagnostics Special keys to produce certain warning messages or effect certain simulation characteristics.

key_1

field Key 1

Parameters:value (str) – value for IDD Field Key 1 Raises:ValueError – if value is not a valid value Returns:the value of key_1 or None if not set Return type:str

key_2

field Key 2

Parameters:value (str) – value for IDD Field Key 2 Raises:ValueError – if value is not a valid value Returns:the value of key_2 or None if not set Return type:str

class pyidf.output_reporting.OutputEnergyManagementSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:EnergyManagementSystem This object is used to control the output produced by the Energy Management System

actuator_availability_dictionary_reporting

field Actuator Availability Dictionary Reporting

Default value: None

Parameters:value (str) – value for IDD Field Actuator Availability Dictionary Reporting Raises:ValueError – if value is not a valid value Returns:the value of actuator_availability_dictionary_reporting or None if not set Return type:str

ems_runtime_language_debug_output_level

field EMS Runtime Language Debug Output Level

Default value: None

Parameters:value (str) – value for IDD Field EMS Runtime Language Debug Output Level Raises:ValueError – if value is not a valid value Returns:the value of ems_runtime_language_debug_output_level or None if not set Return type:str

internal_variable_availability_dictionary_reporting

field Internal Variable Availability Dictionary Reporting

Default value: None

Parameters:value (str) – value for IDD Field Internal Variable Availability Dictionary Reporting Raises:ValueError – if value is not a valid value Returns:the value of internal_variable_availability_dictionary_reporting or None if not set Return type:str

class pyidf.output_reporting.OutputEnvironmentalImpactFactors

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:EnvironmentalImpactFactors This is used to Automatically report the facility meters and turn on the Environmental Impact Report calculations for all of the Environmental Factors.

reporting_frequency

field Reporting Frequency

Parameters:value (str) – value for IDD Field Reporting Frequency Raises:ValueError – if value is not a valid value Returns:the value of reporting_frequency or None if not set Return type:str

class pyidf.output_reporting.OutputMeter

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Meter 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 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.

name

field Name

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

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

reporting_frequency

field Reporting Frequency

Timestep refers to the zone Timestep/Number of Timesteps in hour value

RunPeriod, Environment, and Annual are the same

RunPeriod, Environment, and Annual are synonymous

Default value: Hourly

Parameters:value (str) – value for IDD Field Reporting Frequency Raises:ValueError – if value is not a valid value Returns:the value of reporting_frequency or None if not set Return type:str

class pyidf.output_reporting.OutputMeterCumulative

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Meter:Cumulative 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.

name

field Name

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

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

reporting_frequency

field Reporting Frequency

Timestep refers to the zone Timestep/Number of Timesteps in hour value

RunPeriod, Environment, and Annual are the same

RunPeriod, Environment, and Annual are synonymous

Default value: Hourly

Parameters:value (str) – value for IDD Field Reporting Frequency Raises:ValueError – if value is not a valid value Returns:the value of reporting_frequency or None if not set Return type:str

class pyidf.output_reporting.OutputMeterCumulativeMeterFileOnly

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Meter:Cumulative:MeterFileOnly 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.

name

field Name

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

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

reporting_frequency

field Reporting Frequency

Timestep refers to the zone Timestep/Number of Timesteps in hour value

RunPeriod, Environment, and Annual are the same

RunPeriod, Environment, and Annual are synonymous

Default value: Hourly

Parameters:value (str) – value for IDD Field Reporting Frequency Raises:ValueError – if value is not a valid value Returns:the value of reporting_frequency or None if not set Return type:str

class pyidf.output_reporting.OutputMeterMeterFileOnly

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Meter:MeterFileOnly 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.

name

field Name

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

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

reporting_frequency

field Reporting Frequency

Timestep refers to the zone Timestep/Number of Timesteps in hour value

RunPeriod, Environment, and Annual are the same

RunPeriod, Environment, and Annual are synonymous

Default value: Hourly

Parameters:value (str) – value for IDD Field Reporting Frequency Raises:ValueError – if value is not a valid value Returns:the value of reporting_frequency or None if not set Return type:str

class pyidf.output_reporting.OutputPreprocessorMessage

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:PreprocessorMessage 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.

error_severity

field Error Severity

Depending on type, InputProcessor may terminate the program.

Parameters:value (str) – value for IDD Field Error Severity Raises:ValueError – if value is not a valid value Returns:the value of error_severity or None if not set Return type:str

message_line_1

field Message Line 1

Parameters:value (str) – value for IDD Field Message Line 1 Raises:ValueError – if value is not a valid value Returns:the value of message_line_1 or None if not set Return type:str

message_line_10

field Message Line 10

Parameters:value (str) – value for IDD Field Message Line 10 Raises:ValueError – if value is not a valid value Returns:the value of message_line_10 or None if not set Return type:str

message_line_2

field Message Line 2

Parameters:value (str) – value for IDD Field Message Line 2 Raises:ValueError – if value is not a valid value Returns:the value of message_line_2 or None if not set Return type:str

message_line_3

field Message Line 3

Parameters:value (str) – value for IDD Field Message Line 3 Raises:ValueError – if value is not a valid value Returns:the value of message_line_3 or None if not set Return type:str

message_line_4

field Message Line 4

Parameters:value (str) – value for IDD Field Message Line 4 Raises:ValueError – if value is not a valid value Returns:the value of message_line_4 or None if not set Return type:str

message_line_5

field Message Line 5

Parameters:value (str) – value for IDD Field Message Line 5 Raises:ValueError – if value is not a valid value Returns:the value of message_line_5 or None if not set Return type:str

message_line_6

field Message Line 6

Parameters:value (str) – value for IDD Field Message Line 6 Raises:ValueError – if value is not a valid value Returns:the value of message_line_6 or None if not set Return type:str

message_line_7

field Message Line 7

Parameters:value (str) – value for IDD Field Message Line 7 Raises:ValueError – if value is not a valid value Returns:the value of message_line_7 or None if not set Return type:str

message_line_8

field Message Line 8

Parameters:value (str) – value for IDD Field Message Line 8 Raises:ValueError – if value is not a valid value Returns:the value of message_line_8 or None if not set Return type:str

message_line_9

field Message Line 9

Parameters:value (str) – value for IDD Field Message Line 9 Raises:ValueError – if value is not a valid value Returns:the value of message_line_9 or None if not set Return type:str

preprocessor_name

field Preprocessor Name

Parameters:value (str) – value for IDD Field Preprocessor Name Raises:ValueError – if value is not a valid value Returns:the value of preprocessor_name or None if not set Return type:str

class pyidf.output_reporting.OutputSchedules

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Schedules 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.

key_field

field Key Field

Parameters:value (str) – value for IDD Field Key Field Raises:ValueError – if value is not a valid value Returns:the value of key_field or None if not set Return type:str

class pyidf.output_reporting.OutputSqlite

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:SQLite Output from EnergyPlus can be written to an SQLite format file.

option_type

field Option Type

Parameters:value (str) – value for IDD Field Option Type Raises:ValueError – if value is not a valid value Returns:the value of option_type or None if not set Return type:str

class pyidf.output_reporting.OutputSurfacesDrawing

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Surfaces:Drawing Produces reports/files that are capable of rendering graphically or being imported into other programs. Rendering does not alter the actual inputs/surfaces.

report_specifications_1

field Report Specifications 1

Triangulate3DFace (default), ThickPolyline, RegularPolyline apply to DXF

This field is ignored for DXF:WireFrame and VRML

Default value: Triangulate3DFace

Parameters:value (str) – value for IDD Field Report Specifications 1 Raises:ValueError – if value is not a valid value Returns:the value of report_specifications_1 or None if not set Return type:str

report_specifications_2

field Report Specifications 2

Use ColorScheme Name for DXF reports

Parameters:value (str) – value for IDD Field Report Specifications 2 Raises:ValueError – if value is not a valid value Returns:the value of report_specifications_2 or None if not set Return type:str

report_type

field Report Type

Parameters:value (str) – value for IDD Field Report Type Raises:ValueError – if value is not a valid value Returns:the value of report_type or None if not set Return type:str

class pyidf.output_reporting.OutputSurfacesList

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Surfaces:List Produces a report summarizing the details of surfaces in the eio output file.

report_specifications

field Report Specifications

(IDF, only for Output:Surfaces:List, Lines report –

will print transformed coordinates in IDF style)

Parameters:value (str) – value for IDD Field Report Specifications Raises:ValueError – if value is not a valid value Returns:the value of report_specifications or None if not set Return type:str

report_type

field Report Type

Parameters:value (str) – value for IDD Field Report Type Raises:ValueError – if value is not a valid value Returns:the value of report_type or None if not set Return type:str

class pyidf.output_reporting.OutputTableAnnual

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Table:Annual 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.

filter

field Filter

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.

Parameters:value (str) – value for IDD Field Filter Raises:ValueError – if value is not a valid value Returns:the value of filter or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

schedule_name

field Schedule Name

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.

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

class pyidf.output_reporting.OutputTableMonthly

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Table:Monthly 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.

add_extensible(variable_or_meter_1_name=None, aggregation_type_for_variable_or_meter_1=None)

Add values for extensible fields

Parameters:

• variable_or_meter_1_name (str) – value for IDD Field Variable or Meter 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• aggregation_type_for_variable_or_meter_1 (str) – value for IDD Field Aggregation Type for Variable or Meter 1 if value is None it will not be checked against the specification and is assumed to be a missing value

digits_after_decimal

field Digits After Decimal

Default value: 2

value <= 10

Parameters:value (int) – value for IDD Field Digits After Decimal Raises:ValueError – if value is not a valid value Returns:the value of digits_after_decimal or None if not set Return type:int

extensibles

Get list of all extensibles

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

class pyidf.output_reporting.OutputTableSummaryReports

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Table:SummaryReports 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. There should be as many fields (A) in this object as there are keys in the following (minus AllSummary+AllMonthly+AllSummaryAndMonthly)

class pyidf.output_reporting.OutputTableTimeBins

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Table:TimeBins 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.

interval_count

field Interval Count

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.

value >= 1

value <= 20

Parameters:value (int) – value for IDD Field Interval Count Raises:ValueError – if value is not a valid value Returns:the value of interval_count or None if not set Return type:int

interval_size

field Interval Size

The size of the bins starting with Interval start.

Units are based on field A4

Parameters:value (float) – value for IDD Field Interval Size Raises:ValueError – if value is not a valid value Returns:the value of interval_size or None if not set Return type:float

interval_start

field Interval Start

The lowest value for the intervals being binned into.

Units are based on field A4

Parameters:value (float) – value for IDD Field Interval Start Raises:ValueError – if value is not a valid value Returns:the value of interval_start or None if not set Return type:float

key_value

field Key Value

use ‘*’ (without quotes) to apply this variable to all keys

Default value: *

Parameters:value (str) – value for IDD Field Key Value Raises:ValueError – if value is not a valid value Returns:the value of key_value or None if not set Return type:str

schedule_name

field Schedule Name

Optional schedule name. Binning is performed for non-zero hours.

Binning always performed if left blank.

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

variable_name

field Variable Name

Parameters:value (str) – value for IDD Field Variable Name Raises:ValueError – if value is not a valid value Returns:the value of variable_name or None if not set Return type:str

variable_type

field Variable Type

Optional input on the type of units for the variable used by other fields in the object.

Parameters:value (str) – value for IDD Field Variable Type Raises:ValueError – if value is not a valid value Returns:the value of variable_type or None if not set Return type:str

class pyidf.output_reporting.OutputVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:Variable 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.

key_value

field Key Value

use ‘*’ (without quotes) to apply this variable to all keys

Default value: *

Parameters:value (str) – value for IDD Field Key Value Raises:ValueError – if value is not a valid value Returns:the value of key_value or None if not set Return type:str

reporting_frequency

field Reporting Frequency

Detailed lists every instance (i.e. HVAC variable timesteps)

Timestep refers to the zone Timestep/Number of Timesteps in hour value

RunPeriod, Environment, and Annual are the same

RunPeriod, Environment, and Annual are synonymous

Default value: Hourly

Parameters:value (str) – value for IDD Field Reporting Frequency Raises:ValueError – if value is not a valid value Returns:the value of reporting_frequency or None if not set Return type:str

schedule_name

field Schedule Name

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

variable_name

field Variable Name

Parameters:value (str) – value for IDD Field Variable Name Raises:ValueError – if value is not a valid value Returns:the value of variable_name or None if not set Return type:str

class pyidf.output_reporting.OutputVariableDictionary

Bases: pyidf.helper.DataObject

Corresponds to IDD object Output:VariableDictionary 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.

key_field

field Key Field

Default value: regular

Parameters:value (str) – value for IDD Field Key Field Raises:ValueError – if value is not a valid value Returns:the value of key_field or None if not set Return type:str

sort_option

field Sort Option

Parameters:value (str) – value for IDD Field Sort Option Raises:ValueError – if value is not a valid value Returns:the value of sort_option or None if not set Return type:str