cosapp.drivers.influence

Classes

Influence(name, owner, **kwargs)

This driver evaluate the influence between inputs and outputs (floats only) In input :
class cosapp.drivers.influence.Influence(name: str, owner: Optional[cosapp.systems.System] = None, **kwargs)[source]

Bases: cosapp.drivers.abstractsetofcases.AbstractSetOfCases

This driver evaluate the influence between inputs and outputs (floats only) In input :

  • the inwards (including in the ports)

In output :

  • the inwards (including in the ports)

  • the connected ports

  • the outwards

Parameters

  • name (str) – Name of the driver

  • owner (System, optional) – System to which driver belongs; defaults to None

  • **kwargs (Any) – Keyword arguments will be used to set driver options

add_input_vars(names: Union[str, Set[str], List[str]])[source]

Add variable to be influenced.

Parameters

names (Union[str, Set[str], List[str]]) – List of variables to be influenced

add_response_vars(names: Union[str, Set[str], List[str]])[source]

Add variable to be monitored.

Parameters

names (Union[str, Set[str], List[str]]) – List of variables to be monitored

delta
found_input_vars
found_response_vars
influence_matrix
influence_min_threshold
input_vars
reference
reset_input_vars()[source]

Reset input_vars variable to its default value [‘*’]

reset_response_vars()[source]

Reset response_vars variable to its default value [‘*’]

response_vars
show_influence_matrix(cleaned: bool = True, styling: bool = False, transpose: bool = False, sort_by: Optional[str] = None)[source]

Return the influence matrix with cleaning and styling options.

Parameters

  • cleaned (bool, optional) – Defines if the returned influence matrix will be cleaned or not

  • styling (bool, optional) – Defines if the returned influence matrix will be styled or not

  • transpose (bool, optional) – Defines if the matrix will transposed or not before return

  • sort_by (str, optional) – If given, will sort