energia.modeling.parameters.instruction

Contents

energia.modeling.parameters.instruction#

A Pre-set Parameter

Classes

Instruction(name, kind, deciding, depending, ...)

Pre-set instructions to deal with parameter calculations
class Instruction(name: str, kind: Type[_Component], deciding: str, depending: str, default: str, label: str = '', latex: str = '')[source]#

Bases: _Name

Pre-set instructions to deal with parameter calculations

Parameters:

  • deciding (str) – Name of the deciding aspect

  • depending (str) – Name of the depending aspect

  • default (str) – Name of the default component

  • label (str, optional) – Label for the parameter. Defaults to ‘’.

  • latex (str, optional) – LaTeX representation of the parameter. Defaults to ‘’.

Raises:

TypeError – If the component provided is not of the correct kind.

Contents