revrt.utilities.cli.map_ss_to_rr#

map_ss_to_rr(features_fpath, regions_fpath, region_identifier_column, out_fpath, substation_category_name='Substation', minimum_substation_voltage_kv=69)[source]#

Map substation locations to reinforcement regions.

Reinforcement regions are user-defined. Typical regions are Balancing Areas, States, or Counties, though custom regions are also allowed. Each region must be supplied with a unique identifier in the input file.

This method also removes substations that do not meet the min 69 kV voltage requirement and adds {‘min_volts’, ‘max_volts’} fields to the remaining substations.

Important

This method DOES NOT clip the substations to the reinforcement regions boundary. All substations will be mapped to their closest region. It is your responsibility to remove any substations outside of the analysis region before calling this method.

Doing the pre-processing step avoids any issues with substations being left out or double counted if they were simply clipped to the reinforcement region shapes.

Parameters:

features_fpath (path-like) – Path to GeoPackage with substation and transmission features.
regions_fpath (path-like) – Path to reinforcement regions GeoPackage.
region_identifier_column (str) – Name of column in reinforcement regions GeoPackage containing a unique identifier for each region.
out_fpath (path-like, optional) – Name for output GeoPackage file.
substation_category_name (str, default "Substation") – Name of category in features GeoPackage that contains substation features. By default, “Substation”.
minimum_substation_voltage_kv (float, default 69) – Minimum voltage (kV) that a substation must have to be included in the output file. By default, 69 kV.