cosapp.drivers.influence

Classes

Influence(name[, owner])

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

class cosapp.drivers.influence.Influence(name: str, owner: cosapp.systems.System | None = None, **kwargs)

Bases: 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: str | Set[str] | List[str])

Add variable to be influenced.

Parameters:

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

add_response_vars(names: str | Set[str] | List[str])

Add variable to be monitored.

Parameters:

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

delta: float

found_input_vars: List[str]

found_response_vars: List[str]

influence_matrix: pandas.DataFrame

influence_min_threshold: float

input_vars: List[str]

reference: pandas.DataFrame

reset_input_vars()

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

reset_response_vars()

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

response_vars: List[str]

show_influence_matrix(cleaned: bool = True, styling: bool = False, transpose: bool = False, sort_by: str = None)

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