Problem

Class for defining problem.

EnergyPlusProblem

EnergyPlusProblem(
    model_file,
    weather_input,
    /,
    model_inputs=(),
    outputs=(),
    *,
    evaluation_dir=None,
    has_templates=False,
    noise_sample_kwargs=None,
    clean_patterns=_OutputManager._DEFAULT_CLEAN_PATTERNS,
    removes_subdirs=False,
)

Define an EnergyPlus problem.

PARAMETER	DESCRIPTION
model_file	Model file path. TYPE: str or path-like object
weather_input	Weather input variable. TYPE: WeatherModifier
model_inputs	Model input variables. TYPE: iterable of ModelModifier DEFAULT: ()
outputs	Output variables. TYPE: iterable of Collector DEFAULT: ()
evaluation_dir	Evaluation directory path, default is a directory named 'evaluation' in the same folder as the model file. TYPE: str or path-like object DEFAULT: None
has_templates	Whether the model has HVAC templates. TYPE: bool DEFAULT: `False`
noise_sample_kwargs	Settings for sampling uncertain variables, including Key Description Value type 'mode' Sampling mode {'elementwise', 'cartesian', 'auto'} 'size' Sample size int 'method' Sampling method {'random', 'latin hypercube'} 'seed' Random seed int If 'mode'='elementwise', 'size' and 'method' are mandatory. If 'mode'='cartesian', all model inputs must be non-continuous variables, If 'mode'='auto', the sampling mode is set to 'cartesian' if all variables are non-continuous, otherwise 'elementwise'. TYPE: dict DEFAULT: None
clean_patterns	Patterns to clean simulation files. This is ignored if removes_subdirs is set to True. TYPE: str or iterable of str DEFAULT: `{'*.audit', '*.end', 'sqlite.err'}`
removes_subdirs	Whether to remove the subdirectories in the evaluation directory. TYPE: bool DEFAULT: `False`