sinergym.utils.common

Common utilities.

Functions

convert_conf_to_env_parameters(conf)

Convert a conf from json format (sinergym/data/default_configuration/file.json) in a dictionary of all possible environments as dictionary with id as key and env_kwargs as value.

eppy_element_to_dict(element)

Given a eppy element, this function will create a dictionary using the name as key and the rest of fields as value.

export_schedulers_to_excel(schedulers, path)

Given a python dictionary with schedulers from modeling format, this method export that information in a excel file

get_delta_seconds(st_year, st_mon, st_day, ...)

Returns the delta seconds between st year:st mon:st day:0:0:0 and end year:end mon:end day:24:0:0.

get_ids([start])

Returns a list of environment IDs created by Sinergym (starting by Eplus).

get_record_keys(record)

Given an opyplus Epm Record (one element from opyplus.epm object) this function returns list of keys (opyplus hasn't got this functionality explicitly)

is_wrapped(env, wrapper_class)

Check if a given environment has been wrapped with a given wrapper.

json_to_actuators(actuators)

Read actuators dictionary (from Sinergym JSON conf) and adapt it to the

json_to_meters(meters)

Read meters dictionary (from Sinergym JSON conf) and adapt it to the

json_to_variables(variables)

Read variables dictionary (from Sinergym JSON conf) and adapt it to the

ranges_getter(output_path[, last_result])

Given a path with simulations outputs, this function is used to extract max and min absolute values of all episodes in each variable.

unwrap_wrapper(env, wrapper_class)

Retrieve a VecEnvWrapper object by recursively searching.