revrt.routing.cli.base.RouteToDefinitionConverter

class RouteToDefinitionConverter(cost_fpath, route_points, out_fp, routing_options, transmission_config=None, drivers=None, transition_costs=None)

Bases: ABC

Abstract base class for route definition converters

Parameters:

• cost_fpath (path-like) – Path to layered Zarr file containing cost and other required routing layers.

• route_points (pandas.DataFrame) – DataFrame defining the points to be routed. This DataFrame should contain route definitions to be transformed and passed down to the Rust routing algorithm. Route values for polarity and voltage must be provided either as one shared polarity / voltage pair that applies to every routing option, or as a full per-option set of polarity_<option> / voltage_<option> columns.

• out_fp (path-like) – Path to output file where computed routes will be saved. This file will be checked for existing routes to avoid recomputation.

• routing_options (dict) – Mapping of routing-option names to dictionaries describing the cost, friction, and barrier layers for each option. See RoutingOptionConfig.

• transmission_config (path-like or dict, optional) – Dictionary of transmission cost configuration values, or path to JSON/JSON5 file containing this dictionary. See the description of revrt.routing.cli.point_to_point.compute_lcp_routes() for more details.

Methods

Attributes

cost_metadata	Metadata from cost file (CRS, transform, shape)
existing_routes	Already computed routes in the output file
num_routes	Number of routes to be computed
route_points	Validated routing points

property route_points

Validated routing points

Type:

pandas.DataFrame

property num_routes

Number of routes to be computed

Type:

int

property cost_metadata

Metadata from cost file (CRS, transform, shape)

Type:

dict

property existing_routes

Already computed routes in the output file

Type:

set