archetypal.reportdata.ReportData.from_sqlite
- classmethod ReportData.from_sqlite(sqlite_file, table_name, warmup_flag=0, environment_type=3, reporting_frequency=None)[source]
Read an EnergyPlus eplusout.sql file.
- Parameters
sqlite_file (str) – The path of the sqlite3 file.
table_name (str, optional) – Filter results by a specific table name.
warmup_flag (int) – 1 during warmup, 0 otherwise. Defaults to 0.
environment_type (int) – An enumeration of the environment type. (1 = Design Day, 2 = Design Run Period, 3 = Weather Run Period) See the various SizingPeriod objects and the RunPeriod object for details.
reporting_frequency (str, optional) – “HVAC System Timestep”, “Zone Timestep”, “Hourly”, “Daily”, “Monthly”, “Run Period”.
Examples
>>> ReportData.from_sqlite("eplusout.sql", >>> table_name="Air System Total Heating Energy", >>> warmup_flag=0, >>> environment_type=1, >>> )
- Returns
a
ReportData
which is a subclass ofDataFrame
.- Return type
ReportData