API Reference

Opyplus package, a tool to work with EnergyPlus in python.

Functions

simulate(epm_or_buffer_or_path, …[, …])	Run a simulation from inputs.
default_external_files_dir_name(model_name)	Get default dir name for external files.
get_eplus_base_dir_path(version)	Get EnergyPlus base dir path.

Classes

Epm([json_data, check_required, …])	Energyplus model.
WeatherData(weather_series, latitude, …[, …])	Class describing E+ weather data.
Simulation(base_dir_path[, simulation_name])	Class describing an E+ simulation.
StandardOutput(buffer_or_path[, start_year, …])	Class describing an EnergyPlus Standard Output (eso file).
OutputTable(path)	Class describing an E+ output table.
SummaryTable(path)	Class describing an E+ summary table.
Eio(path)	Class describing a .eio file.
Err(path)	Class to serialize EnergyPlus “.err” output.
Idd([version_or_buffer_or_path, …])	Class representing an EnergyPlus Idd file.
Mtd(path)	Class describing an EnergyPlus .mtd file.
CONF	Opyplus configuration class.
FileContent(name, content)	File content class.

Exceptions

DatetimeInstantsCreationError	Exception when datetime instants creation fails.
FieldValidationError	Exception when field validation fails.
MultipleRecordsReturnedError	Exception when more than one record is returned and only one was expected.
RecordDoesNotExistError	Record does not exist exception.