sinergym.utils.common

Common utilities.

Functions

apply_wrappers_info(env, wrappers_info)

Apply wrapper information to the environment.

convert_conf_to_env_parameters(conf)

Convert YAML configuration to a dictionary of possible environments.

create_environment(env_id, env_params, wrappers)

Create a EplusEnv environment with the given parameters and wrappers.

deep_update(source, updates)

Recursively update a dictionary with another dictionary.

eppy_element_to_dict(element)

Converts an eppy element into a dictionary following the EnergyPlus epJSON standard.

export_schedulers_to_excel(schedulers, path)

Exports scheduler information from a dictionary to an 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_wrappers_info(env[, path_to_save])

Get ordered information about the wrappers applied to the environment.

import_from_path(dotted_or_file_path)

Import a class or function from a dotted module path or a file path.

is_wrapped(env, wrapper_class)

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

ornstein_uhlenbeck_process(data, ...)

Add noise to the data using the Ornstein-Uhlenbeck process.

parse_actuators_settings(actuators)

Convert actuators dictionary from Sinergym YAML settings to EnergyPlus format.

parse_meters_settings(meters)

Convert meters dictionary from Sinergym YAML settings to EnergyPlus format.

parse_variables_settings(variables)

Convert Sinergym YAML variable settings to EnergyPlus API format.

process_algorithm_parameters(alg_params)

process_environment_parameters(env_params)

unwrap_wrapper(env, wrapper_class)

Retrieve a wrapper object by recursively searching.