Modules¶
IDF Class¶
Class for loading and parsing idf models. |
|
Handles preparation of EnergyPlus outputs. |
|
Lists available meters in the IDF model. |
|
Lists available variables in the IDF model. |
UMI Template Library¶
Handles parsing and creating Template Library Files for UMI for Rhino. |
Template Classes¶
Main class supporting the definition of a single building template. |
|
HVAC settings for the zone |
|
Domestic Hot Water settings |
|
Gas Materials |
|
Glazing Materials |
|
Zone Loads |
|
Opaque Constructions |
|
Use this component to create a custom opaque material. |
|
Class that handles Schedules as |
|
Building Structure settings. |
|
Zone Ventilation Settings |
|
Window Construction. |
|
Window Settings define the various window-related properties of a specific |
|
Class containing HVAC settings: Conditioning, Domestic Hot Water, Loads, Ventilation, adn Constructions |
|
Zone-specific |
Template Helper Classes¶
Classes that support the Template Classes classes above.
The UmiBase class handles common properties to all Template objects. |
|
A class used to store data linked with the Life Cycle aspect of materials |
|
Class used to define one layer in a construction assembly. |
|
A class used to store data linked with the Life Cycle aspect of constructions (eg.: wall assemblies). |
|
Defines the layers of an |
|
Handles the properties of the |
|
Helper Class for YearSchedules that are defined using FromDay FromMonth ToDay ToMonth attributes. |
|
Superclass of UmiSchedule that handles daily schedules. |
|
Superclass of UmiSchedule that handles weekly schedules. |
|
Superclass of UmiSchedule that handles yearly schedules. |
|
Refers to the window type. |
|
Refers to window shading types. |
Graph Module¶
A subclass of |
Data Portal¶
Returns all available building types for a specific country. |
|
How to format |
|
Return system level information from TABULA archetypes. |
|
Returns: |
|
Query the OpenEI.org API. |
|
Query the NREL Commercial Building Resource Database |
|
Send a request to the Building Component Library API via HTTP GET and return the JSON response. |
|
Send a request to the StatCan API via HTTP GET and return the JSON response. |
|
|
|
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¶
Create from dictionary. |
|
Read an EnergyPlus eplusout.sql file. |
|
filter RaportData using specific keywords. |
Tabular Data¶
Returns a DataFrame from the ‘TabularDataWithStrings’ table |
|
filter RaportData using specific keywords. |
IDF to BUI module¶
Convert regular IDF file (EnergyPlus) to TRNBuild file (TRNSYS) |
|
Gets idf objects |
|
Clean names of IDF objects. |
|
Return coordinates of a zone |
|
Find closest coordinates to given ones |
|
Function that parse window library from Berkeley Lab in two parts. |
|
Return window object from TRNBuild library |
|
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¶
Package configurations. |
|
|
|
Write a message to the log file and/or print to the the console. |
|
Reads |
|
Returns flattened DataFrame of umi_objects |
|
Returns list of common umi objects |
|
Takes the previous DataFrame and calculates a new Index range. |
|
Simple function transforming one-based hours (1->24) into zero-based hours (0->23) |
|
Compute the weighted average while ignoring NaNs. |
|
Compute the highest ranked value weighted by some other variable. |
|
Handles a copy of test idf files |
|
returns a piecewise function from an array of the form [hour1, hour2, …, value1, value2, …] |
|
calculate rmse with target values |
|
Find the first occurrence of a string and return its line number |
|
Delete file if exists, then write lines in it |
|
|
|
Making sure new_name does not already exist |
|
Calculate the angle between 2 vectors |
|
Makes sure a variable is a float and round it at “n” decimals |
|
Use this method as a decorator on a function to calculate the time it take to complete. |
|
This function takes two integers and returns the L.C.M. |
|
Calculate the number of elements in nested list |
|
Shift list elements to the left |
|
A parallel version of the map function with a progress b |