revrt.utilities.cli.add_rr_to_nn#

add_rr_to_nn(network_nodes_fpath, regions_fpath, region_identifier_column, out_fpath, crs_template_file=None)[source]#

Add reinforcement region column to network node file.

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.

Parameters:

  • network_nodes_fpath (path-like) – Path to network nodes GeoPackage. The region_identifier_column will be added to this file if it is missing.

  • regions_fpath (path-like) – Path to reinforcement regions GeoPackage. The region_identifier_column from this file will be added to the network_nodes_fpath if needed.

  • region_identifier_column (str) – Name of column in reinforcement regions GeoPackage containing a unique identifier for each region.

  • out_fpath (path-like) – Name for output GeoPackage file.

  • crs_template_file (path-like, optional) – Path to a file containing the CRS that should be used to perform the mapping. This input can be an exclusions Zarr file, a GeoTIFF, or any file tha can be read with GeoPandas. If None, the network_nodes_fpath file CRS is used to perform the mapping. By default, None.

On this page