objectives

class objectives.EPReader(class_name, frequency, func, **kwargs)

Parameters:

• class_name (str) –
• frequency (str) –
• func –

add_objective(building)

Creates and adds the meter needed by this objective to the building.

Parameters:building – the building to modify Returns:None

setup(building) → None

Prepares an idf so that it’s output can be read by this meter.

Parameters:building – the idf to modify Returns:None

class objectives.EPResults(name, frequency, units, data)

Represents the information about a Meter read from a .mtr file.

class objectives.MeterReader(key_name, class_name, frequency, func, **kwargs)

Parameters:

• key_name (str) –
• class_name (str) –
• frequency (str) –
• func –

class objectives.VariableReader(key_value, variable_name = '*', class_name, frequency, func, **kwargs)

Parameters:

• key_value –
• variable_name –
• class_name –
• frequency –
• func –

objectives.clear_outputs(building, outputs = "all")

Disable certain types of output.

Parameters:

• building – the building to modify
• outputs (Union[str,List[str]]) – Can be the class_name of the output to clear, a shortcut for different types of output, or a list that combines the above.

Returns:

None

objectives.get_data_dict_regex()

Generates a regex expression that can parse a line of the data dictionary in the .mtr file Various assumptions are made about the exact composition of names.

Returns:Regex expression

objectives.read_eso(out_dir, file_name = "eplusout.eso") → Dict[Tuple, EPResults]

Retrieve information from an Energy-Plus simulation, with outputs in out_dir

Parameters:

• out_dir (str) – Directory of the outputs
• file_name (str) – Name of the eso file

Returns:

A dictionary with keys of the form {(MeterName, Reporting_Frequency or None):EPResults dataclass}

objectives.sum_values(results) → float

Returns the sum over the Value column from some results

Parameters:results (EPResults) – the values to sum over Returns:the sum of the first value for each entry in the collection.