Input¶

Classes for defining inputs.

IndexTagger ¶

IndexTagger(*index_trios)

Tag regular commands by indexing.

This tagger locates the EnergyPlus field to be modified through indexing, which is informed by an index trio comprising the class name, the object name and the field name. Multiple index trios can be specified to modify multiple EnergyPlus fields with the same value.

Currently, tagging inside macro files are not supported.

PARAMETER	DESCRIPTION
`*index_trios`	Single or multiple index trios. TYPE: `iterables of str` DEFAULT: `()`

StringTagger ¶

StringTagger(*string_trios)

Tag regular and macro commands by string replacement.

This tagger locates the regular or the macro command to be modified through string replacement, which is informed by an string trio comprising the string, the prefix and the suffix. Multiple string trios can be specified to modify multiple regular or macro commands with the same value.

The prefix and the suffix are useful to delimit the right string to be replaced, when the string itself is not unique in the EnergyPlus model.

Currently, tagging inside macro files are not supported.

PARAMETER	DESCRIPTION
`*string_trios`	Single or multiple string trios. TYPE: `iterables of str` DEFAULT: `()`

WeatherModifier ¶

WeatherModifier(*options, distribution=None, is_noise=False, name='')

Modify the weather input variable.

PARAMETER	DESCRIPTION
`*options`	Single or multiple options. TYPE: `strs or path-like objects` DEFAULT: `()`
`distribution`	Probability distribution defined by `scipy`. TYPE: `SupportsPPF` DEFAULT: `None`
`is_noise`	Whether the variable is uncertain. TYPE: `bool` DEFAULT: `False`
`name`	Variable name. TYPE: `str` DEFAULT: `''`

ContinuousModifier ¶

ContinuousModifier(
    low, high, /, *, distribution=None, is_noise=False, tagger=None, name=""
)

Modify a continuous input variable.

PARAMETER	DESCRIPTION
`low`	Lower limit. TYPE: `float`
`high`	Upper limit. TYPE: `float`
`distribution`	Probability distribution defined by `scipy`. TYPE: `SupportsPPF` DEFAULT: `None`
`is_noise`	Whether the variable is uncertain. TYPE: `bool` DEFAULT: `False`
`tagger`	A tagger object. TYPE: `Tagger` DEFAULT: `None`
`name`	Variable name. TYPE: `str` DEFAULT: `''`

DiscreteModifier ¶

DiscreteModifier(*options, distribution=None, is_noise=False, tagger=None, name='')

Modify a discrete input variable.

PARAMETER	DESCRIPTION
`*options`	Single or multiple options. TYPE: `floats` DEFAULT: `()`
`distribution`	Probability distribution defined by `scipy`. TYPE: `SupportsPPF` DEFAULT: `None`
`is_noise`	Whether the variable is uncertain. TYPE: `bool` DEFAULT: `False`
`tagger`	A tagger object. TYPE: `Tagger` DEFAULT: `None`
`name`	Variable name. TYPE: `str` DEFAULT: `''`

CategoricalModifier ¶

CategoricalModifier(*options, distribution=None, is_noise=False, tagger=None, name='')

Modify a categorical input variable.

PARAMETER	DESCRIPTION
`*options`	Single or multiple options. TYPE: `floats` DEFAULT: `()`
`distribution`	Probability distribution defined by `scipy`. TYPE: `SupportsPPF` DEFAULT: `None`
`is_noise`	Whether the variable is uncertain. TYPE: `bool` DEFAULT: `False`
`tagger`	A tagger object. TYPE: `Tagger` DEFAULT: `None`
`name`	Variable name. TYPE: `str` DEFAULT: `''`

FunctionalModifier ¶

FunctionalModifier(func, /, input_indices, func_kwargs=None, *, tagger=None, name='')

Modify a functional input variable.

This modifier is useful to define dependent input variables.

PARAMETER	DESCRIPTION
`func`	A function that takes a tuple of input values as the argument and returns an input value. TYPE: `_AnyFunc`
`input_indices`	Coincident input indices to input values passed into `func`. TYPE: `iterable of int`
`func_kwargs`	Additional keyword arguments passed into `func`. TYPE: `dict` DEFAULT: `None`
`tagger`	A tagger object. TYPE: `Tagger` DEFAULT: `None`
`name`	Variable name. TYPE: `str` DEFAULT: `''`