revrt.routing.cli.base.RoutingOptions#

class RoutingOptions(routing_options)[source]#

Bases: object

Class to manage validated routing-option configurations

Parameters:

routing_options (dict) – Mapping of routing-option names to dictionaries describing the cost, friction, barrier, and option-level multiplier inputs for that option. See RoutingOptionConfig.

Methods

update_from(pv_by_option, transmission_config)

Update multipliers for multi-option routing

Attributes

default

Default routing option to use if omitted from points
property default[source]#

Default routing option to use if omitted from points

Type:

str

update_from(pv_by_option, transmission_config)[source]#

Update multipliers for multi-option routing

Parameters:

  • pv_by_option (dict) – Dictionary mapping routing options to their corresponding polarity and voltage values, for example {"option_name": {"polarity": "val", "voltage": "val"}}.

  • transmission_config (dict) – Dictionary of transmission cost configuration values.

Returns:

dict – Updated routing options with multipliers applied based on the provided polarity and voltage values.