opyplus.simulate

opyplus.simulate(epm_or_buffer_or_path, weather_data_or_buffer_or_path, base_dir_path, simulation_name=None, print_function=None, beat_freq=None)

Run a simulation from inputs.

Parameters

epm_or_buffer_or_path: Epm or typing.StringIO or str

weather_data_or_buffer_or_path: WeatherData or typing.StringIO or str

base_dir_path: str

simulation dir path

simulation_name: str or None

if provided, simulation will be done in {base_dir_path}/{simulation_name} else, simulation will be done in {base_dir_path}

print_function: typing.Callable or None

interface fct(message): do what you want with message

beat_freq: float or None

if provided, subprocess in which EnergyPlus is run will write at given frequency in standard output. May be used to monitor subprocess state.

Returns

Simulation