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
`ZoneLoad`	Zone Loads
`OpaqueConstruction`	Opaque Constructions
`OpaqueMaterial`	Use this component to create a custom opaque material.
`UmiSchedule`	Class that handles Schedules as
`StructureInformation`	Building Structure settings.
`VentilationSetting`	Zone Ventilation Settings
`WindowConstruction`	Window Construction.
`WindowSetting`	Window Settings define the various window-related properties of a specific `Zone`.
`ZoneDefinition`	Class containing HVAC settings: Conditioning, Domestic Hot Water, Loads, Ventilation, adn Constructions
`ZoneConstructionSet`	Zone-specific `Construction` ids

Template Helper Classes¶

Classes that support the Template Classes classes above.

`UmiBase`	The UmiBase class handles common properties to all Template objects.
`MaterialBase`	A class used to store data linked with the Life Cycle aspect of materials
`MaterialLayer`	Class used to define one layer in a construction assembly.
`ConstructionBase`	A class used to store data linked with the Life Cycle aspect of constructions (eg.: wall assemblies).
`LayeredConstruction`	Defines the layers of an `OpaqueConstruction`.
`MassRatio`	Handles the properties of the
`YearSchedulePart`	Helper Class for YearSchedules that are defined using FromDay FromMonth ToDay ToMonth attributes.
`DaySchedule`	Superclass of UmiSchedule that handles daily schedules.
`WeekSchedule`	Superclass of UmiSchedule that handles weekly schedules.
`YearSchedule`	Superclass of UmiSchedule that handles yearly schedules.
`WindowType`	Refers to the window type.
`ShadingType`	Refers to window shading types.

Graph Module¶

ZoneGraph

A subclass of networkx.Graph.

Schedule Module¶

Schedule

An object designed to handle 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¶

EnergySeries¶

Report Data¶

`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.

IDF to BUI module¶

`convert_idf_to_trnbuild`	Convert regular IDF file (EnergyPlus) to TRNBuild file (TRNSYS)
`get_idf_objects`	Gets idf objects
`clear_name_idf_objects`	Clean names of IDF objects.
`zone_origin`	Return coordinates of a zone
`closest_coords`	Find closest coordinates to given ones
`parse_window_lib`	Function that parse window library from Berkeley Lab in two parts.
`choose_window`	Return window object from TRNBuild library
`trnbuild_idf`	This program sorts and renumbers the IDF file and writes a B18 file based on the geometric information of the IDF file and the template D18 file.

Utils¶

`config`	Package configurations.
`validate_trnsys_folder`	param trnsys_default_folder
`log`	Write a message to the log file and/or print to the the console.
`load_umi_template_objects`	Reads
`umi_template_object_to_dataframe`	Returns flattened DataFrame of umi_objects
`get_list_of_common_umi_objects`	Returns list of common umi objects
`newrange`	Takes the previous DataFrame and calculates a new Index range.
`date_transform`	Simple function transforming one-based hours (1->24) into zero-based hours (0->23)
`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
`piecewise`	returns a piecewise function from an array of the form [hour1, hour2, …, value1, value2, …]
`rmse`	calculate rmse with target values
`checkStr`	Find the first occurrence of a string and return its line number
`write_lines`	Delete file if exists, then write lines in it
`load_umi_template`	param json_template Absolute or relative filepath to an umi json_template
`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 L.C.M.
`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