Modules

IDF Class

IDF	Class for loading and parsing idf models.
Outputs	Handles preparation of EnergyPlus outputs.
Meters	Lists available meters in the IDF model.
Variables	Lists available variables in the IDF model.

UMI Template Library

UmiTemplateLibrary

Handles parsing and creating Template Library Files for UMI for Rhino.

Template Classes

BuildingTemplate	Main class supporting the definition of a single building template.
ZoneConditioning	HVAC settings for the zone.
DomesticHotWaterSetting	Domestic Hot Water settings.
GasMaterial	Gas Materials.
GlazingMaterial	Glazing Materials class.
ZoneLoad	Zone Loads.
OpaqueConstruction	Opaque Constructions.
OpaqueMaterial	Use this component to create a custom opaque material.
UmiSchedule	Class that handles Schedules.
StructureInformation	Building Structure settings.
VentilationSetting	Zone Ventilation Settings.
WindowConstruction	Window Construction.
WindowSetting	Defines the various window-related properties of a Zone.
ZoneDefinition	Zone settings class.
ZoneConstructionSet	ZoneConstructionSet class.

Template Helper Classes

Classes that support the Template Classes classes above.

umi_base.UmiBase	Base class for template objects.
materials.material_base.MaterialBase	A class used to store data linked with the Life Cycle aspect of materials.
materials.material_layer.MaterialLayer	Class used to define one layer in a construction assembly.
constructions.base_construction.ConstructionBase	A class used to store data linked to Life Cycle aspects.
constructions.base_construction.LayeredConstruction	Defines the layers of an OpaqueConstruction.
structure.MassRatio	Handles the properties of the mass ratio for building template structure.
schedule.YearSchedulePart	Helper Class for YearSchedules defined with FromDay FromMonth ToDay ToMonth.
schedule.DaySchedule	Superclass of UmiSchedule that handles daily schedules.
schedule.WeekSchedule	Superclass of UmiSchedule that handles weekly schedules.
schedule.YearSchedule	Superclass of UmiSchedule that handles yearly schedules.
constructions.window_construction.WindowType	Refers to the window type.
constructions.window_construction.ShadingType	Refers to window shading types.

Graph Module

ZoneGraph

A subclass of networkx.Graph.

Schedule Module

Schedule

Class handling any EnergyPlus schedule object.

Data Portal

tabula_available_buildings	Returns all available building types for a specific country.
tabula_building_details_sheet	How to format code_building.
tabula_system	Return system level information from TABULA archetypes.
tabula_system_request	Returns:
openei_api_request	Query the OpenEI.org API.
nrel_api_cbr_request	Query the NREL Commercial Building Resource Database
nrel_bcl_api_request	Send a request to the Building Component Library API via HTTP GET and return the JSON response.
stat_can_request	Send a request to the StatCan API via HTTP GET and return the JSON response.
stat_can_geo_request	param type ”json” or “xml”. json = json response format and xml = xml
download_bld_window	Find window constructions corresponding to a combination of a u_factor, shgc and visible transmittance and download their idf file to disk.

EnergyDataFrame

Note

EnergyDataFrame is now part of its own package energy-pandas.

EnergySeries

Note

EnergySeries is now part of its own package energy-pandas.

Report Data

ReportData.__init__
ReportData.from_sql_dict	Create from dictionary.
ReportData.from_sqlite	Read an EnergyPlus eplusout.sql file.
ReportData.filter_report_data	filter RaportData using specific keywords.

Tabular Data

TabularData.from_sql	Returns a DataFrame from the ‘TabularDataWithStrings’ table
TabularData.filter_tabular_data	filter RaportData using specific keywords.

Utils

config	Package configurations.
log	Write a message to the log file and/or print to the the console.
weighted_mean	Compute the weighted average while ignoring NaNs.
top	Compute the highest ranked value weighted by some other variable.
copy_file	Handles a copy of test idf files
load_umi_template	Load umi template file to list of dict.
check_unique_name	Making sure new_name does not already exist
angle	Calculate the angle between 2 vectors
float_round	Makes sure a variable is a float and round it at “n” decimals
timeit	Use this method as a decorator on a function to calculate the time it take to complete.
lcm	This function takes two integers and returns the least common multiple.
recursive_len	Calculate the number of elements in nested list
rotate	Shift list elements to the left
parallel_process	A parallel version of the map function with a progress b