trnslator.idfclass.OutputPrep

class trnslator.idfclass.OutputPrep(idf, save=True)

Handles preparation of EnergyPlus outputs. Different instance methods allow to chain methods together and to add predefined bundles of outputs in one go.

For example:

>>> OutputPrep(idf=idf_obj).add_output_control().add_umi_ouputs().add_profile_gas_elect_ouputs()

Initialize an OutputPrep object.

Parameters

• idf (IDF) – the IDF object for wich this OutputPrep object is created.

• save (bool) – weather to save or not changes after adding outputs to the IDF file.

add_custom(outputs)

Add custom-defined outputs as a list of objects.

Examples

>>> outputs = [
>>>         {
>>>             "ep_object": "OUTPUT:METER",
>>>             "kwargs": dict(
>>>                 Key_Name="Electricity:Facility",
>>>                 Reporting_Frequency="hourly",
>>>                 save=True,
>>>             ),
>>>         },
>>>     ]
>>> OutputPrep().add_custom(outputs)

Parameters

outputs (list) – Pass a list of ep-objects defined as dictionary. See examples.

add_basics()

Adds the summary report and the sql file to the idf outputs

add_schedules()

Adds Schedules object

add_summary_report(summary='AllSummary')

Adds the Output:Table:SummaryReports object.

Parameters

summary (str) – Choices are AllSummary, AllMonthly, AllSummaryAndMonthly, AllSummaryAndSizingPeriod, AllSummaryMonthlyAndSizingPeriod, AnnualBuildingUtilityPerformanceSummary, InputVerificationandResultsSummary, SourceEnergyEndUseComponentsSummary, ClimaticDataSummary, EnvelopeSummary, SurfaceShadowingSummary, ShadingSummary, LightingSummary, EquipmentSummary, HVACSizingSummary, ComponentSizingSummary, CoilSizingDetails, OutdoorAirSummary, SystemSummary, AdaptiveComfortSummary, SensibleHeatGainSummary, Standard62.1Summary, EnergyMeters, InitializationSummary, LEEDSummary, TariffReport, EconomicResultSummary, ComponentCostEconomicsSummary, LifeCycleCostReport, HeatEmissionsSummary,

add_sql(sql_output_style='SimpleAndTabular')

Adds the Output:SQLite object. This object will produce an sql file that contains the simulation results in a database format. See eplusout.sql for more details.

Parameters

sql_output_style (str) – The Simple option will include all of the predefined database tables as well as time series related data. Using the SimpleAndTabular choice adds database tables related to the tabular reports that are already output by EnergyPlus in other formats.

add_output_control(output_control_table_style='CommaAndHTML')

Sets the OutputControl:Table:Style object.

Parameters

output_control_table_style (str) – Choices are: Comma, Tab, Fixed, HTML, XML, CommaAndHTML, TabAndHTML, XMLAndHTML, All

add_template_outputs()

Adds the necessary outputs in order to create an UMI template.

add_umi_ouputs()

Adds the necessary outputs in order to return the same energy profile as in UMI.

add_profile_gas_elect_ouputs()

Adds the following meters: Electricity:Facility, Gas:Facility, WaterSystems:Electricity, Heating:Electricity, Cooling:Electricity