least-cost-paths
Least Cost Paths Command Line Interface
least-cost-paths [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
- -n, --name <name>
Job name.
- Default:
LeastCostPaths
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
from-config
Run Least Cost Paths from a config.
least-cost-paths from-config [OPTIONS]
Options
- -c, --config <config>
Required Filepath to AssemblyAreas config json file.
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
local
Run Least Cost Paths on local hardware
least-cost-paths local [OPTIONS]
Options
- -cost, --cost_fpath <cost_fpath>
Required Path to h5 file with cost rasters and other required layers
- -feats, --features_fpath <features_fpath>
Required Path to GeoPackage with transmission features
- -cap, --capacity_class <capacity_class>
Required Capacity class of transmission features to connect supply curve points to
- -nn, --network_nodes_fpath <network_nodes_fpath>
Path to Network Nodes GeoPackage. If given alongside transmission_lines_fpath, reinforcement path cost calculation is run.
- -tl, --transmission_lines_fpath <transmission_lines_fpath>
Path to Transmission lines GeoPackage. This file can contain other features, but transmission lines must be identified by ‘TransLine’. If given alongside network_nodes_fpath, reinforcement path cost calculation is run.
- -xcfg, --xmission_config <xmission_config>
Path to transmission config .json
- -cb, --clip_buffer <clip_buffer>
Optional number of array elements to buffer clip area by.
- Default:
0
- -start, --start_index <start_index>
Start index of features to run.
- Default:
0
- -step, --step_index <step_index>
Step index of features to run.
- Default:
1
- -bmult, --barrier_mult <barrier_mult>
Transmission barrier multiplier, used when computing the least cost tie-line path
- Default:
100
- -mw, --max_workers <max_workers>
Number of workers to use for processing, if 1 run in serial, if None use all available cores
- -rid, --region_identifier_column <region_identifier_column>
Name of column in reinforcement regions GeoPackagecontaining a unique identifier for each region.
- -paths, --save_paths
Flag to save least cost path as a multi-line geometry
- -o, --out_dir <out_dir>
Directory to save least cost Paths values to.
- Default:
./
- -log, --log_dir <log_dir>
Directory to dump log files.
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
map-ss-to-rr
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.
least-cost-paths map-ss-to-rr [OPTIONS]
Options
- -feats, --features_fpath <features_fpath>
Required Path to GeoPackage with substation and transmission features
- -regs, --regions_fpath <regions_fpath>
Required Path to reinforcement regions GeoPackage.
- -rid, --region_identifier_column <region_identifier_column>
Required Name of column in reinforcement regions GeoPackagecontaining a unique identifier for each region.
- -nodes, --network_nodes_fpath <network_nodes_fpath>
Path to network nodes GeoPackage. If this input is included, the region_identifier_column is added if it is missing.
- -of, --out_file <out_file>
Name for output GeoPackage file.
valid-config-keys
Echo the valid Least Cost Paths config keys
least-cost-paths valid-config-keys [OPTIONS]