archetypal.idfclass.Outputs

class archetypal.idfclass.Outputs(idf)[source]

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

Examples

>>> from archetypal import IDF
>>> idf = IDF(prep_outputs=False)  # True be default
>>> idf.outputs.add_output_control().add_umi_ouputs(
>>> ).add_profile_gas_elect_ouputs().apply()

Initialize an outputs object.

Parameters: idf (IDF) – the IDF object for wich this outputs object is created.

add_custom(outputs)[source]

Add custom-defined outputs as a list of objects.

Examples

>>> outputs = IDF().outputs
>>> to_add = dict(
>>>       key= "OUTPUT:METER",
>>>       Key_Name="Electricity:Facility",
>>>       Reporting_Frequency="hourly",
>>> )
>>> outputs.add_custom([to_add]).apply()

Parameters: outputs (list, bool) – Pass a list of ep-objects defined as dictionary. See examples. If a bool, ignored.
Returns: self
Return type: Outputs

add_basics()[source]: Adds the summary report and the sql file to the idf outputs

add_schedules()[source]: Adds Schedules object

add_meter_variables(format='IDF')[source]

Generate .mdd file at end of simulation. This file (from the Output:VariableDictionary, regular; and Output:VariableDictionary, IDF; commands) shows all the report meters along with their “availability” for the current input file. A user must first run the simulation (at least semi-successfully) before the available output meters are known. This output file is available in two flavors: regular (listed as they are in the Input Output Reference) and IDF (ready to be copied and pasted into your Input File).

Parameters: format (str) – Choices are “IDF” and “regul
Returns: self
Return type: Outputs

add_summary_report(summary='AllSummary')[source]

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,
Returns: self
Return type: Outputs

add_sql(sql_output_style='SimpleAndTabular')[source]

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.
Returns: self
Return type: Outputs

add_output_control(output_control_table_style='CommaAndHTML')[source]

Sets the OutputControl:Table:Style object.

Parameters: output_control_table_style (str) – Choices are: Comma, Tab, Fixed, HTML, XML, CommaAndHTML, TabAndHTML, XMLAndHTML, All
Returns: self
Return type: Outputs

add_umi_template_outputs()[source]: Adds the necessary outputs in order to create an UMI template.

add_umi_ouputs()[source]: Adds the necessary outputs in order to return the same energy profile as in UMI.

add_profile_gas_elect_ouputs()[source]: Adds the following meters: Electricity:Facility, Gas:Facility, WaterSystems:Electricity, Heating:Electricity, Cooling:Electricity

apply()[source]: Applies the outputs to the idf model. Modifies the model by calling newidfobject()