Modules¶

IDF Class¶

`load_idf`	Returns a parsed IDF object from file.
`IDF`	Wrapper over the geomeppy.IDF class and subsequently the eppy.modeleditor.IDF class
`run_eplus`	Run an EnergyPlus file using the EnergyPlus executable.
`OutputPrep`	Handles preparation of EnergyPlus outputs.

An object designed to handle any EnergyPlus schedule object

`EnergyDataFrame.set_unit`
`EnergyDataFrame.discretize_tsam`	uses tsam
`plot_energydataframe_map`

`EnergySeries.from_sqlite`	Create a.
`EnergySeries.unit_conversion`	returns the multiplier to convert units
`EnergySeries.concurrent_sort`	param ascending
`EnergySeries.normalize`	Returns a normalized EnergySeries
`EnergySeries.ldc_source`	Returns the Load Duration Curve from the source side of theoretical Heat Pumps
`EnergySeries.source_side`	Returns the Source Side EnergySeries given a Seasonal COP.
`EnergySeries.discretize_tsam`	uses tsam
`EnergySeries.discretize`	Retruns a discretized pandas.Series
`EnergySeries.plot3d`	param energy_series
`EnergySeries.plot2d`	param data
`EnergySeries.p_max`
`EnergySeries.p_max`
`EnergySeries.monthly`
`EnergySeries.capacity_factor`
`EnergySeries.bin_edges`
`EnergySeries.time_at_min`
`EnergySeries.bin_scaling_factors`
`EnergySeries.duration_scaling_factor`
`EnergySeries.ldc`
`EnergySeries.nseries`
`save_and_show`	Save a figure to disk and show it, as specified.
`plot_energyseries`	param energy_series
`plot_energyseries_map`	param data

`ReportData.from_sql_dict`
`ReportData.from_sqlite`	Reads an EnergyPlus eplusout.sql file and returns a `ReportData` which is a subclass of `DataFrame`.
`ReportData.heating_load`	Returns the aggragated ‘Heating:Electricity’, ‘Heating:Gas’ and ‘Heating:DistrictHeating’ of each archetype
`ReportData.filter_report_data`	filter RaportData using specific keywords.
`ReportData.sorted_values`	Returns sorted values by filtering key_value and name

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

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