reV-rpm
RPM Command Line Interface
reV-rpm [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
- -n, --name <name>
Job name. Default is “RPM”.
- Default:
RPM
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
from-config
Run reVX-rpm from a config.
reV-rpm from-config [OPTIONS]
Options
- -c, --config <config>
Required Filepath to reVX-rpm config json file.
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
local
Run reVX-REEDS on local hardware.
reV-rpm local [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
Options
- -o, --out_dir <out_dir>
Required Directory to dump output files
- -cf, --cf_profiles <cf_profiles>
Required Path to reV .h5 file containing desired capacity factor profiles
- -log, --log_dir <log_dir>
Directory to dump log files. Default is out_dir.
- -mw, --max_workers <max_workers>
Number of parallel workers. 1 will run serial, None will use all available.
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
cluster
Cluster RPM Regions
reV-rpm local cluster [OPTIONS]
Options
- -m, --rpm_meta <rpm_meta>
Required Path to .csv or .json containing the RPM meta data:- Categorical regions of interest with column label “region”- # of clusters per region with column label “clusters”- A column that maps the RPM regions to the cf_fpath meta data: “res_gid” (priorized) or “gen_gid”. This can be omitted if the rpm_region_col kwarg input is found in the cf_fpath meta
- -reg, --region_col <region_col>
The meta-data field to map RPM regions to
- -drf, --dist_rank_filter
Re-cluster data by minimizing the sum of the: distance between each point and each cluster centroid
- -cf, --contiguous_filter
Flag to re-classify clusters by making contigous cluster polygons
rep-profiles
Extract representative profiles from RPM clusters
reV-rpm local rep-profiles [OPTIONS]
Options
- -rc, --rpm_clusters <rpm_clusters>
Path to pre-existing RPM cluster results .csv with (gid, gen_gid, cluster_id, rank)
- -excl, --exclusions <exclusions>
Filepath to exclusions data (must match the techmap grid) None will not apply exclusions.
- -exd, --excl_dict <excl_dict>
String representation of a dictionary of exclusion LayerMask arguments {layer: {kwarg: value}} where layer is a dataset in excl_fpath and kwarg can be “inclusion_range”, “exclude_values”, “include_values”, “use_as_weights”, or “weight”.
- -tmd, --techmap_dset <techmap_dset>
Dataset name in the techmap file containing the exclusions-to-resource mapping data.
- -trg, --trg_bins <trg_bins>
Filepath to a single-column CSV containing ordered TRG bin edges.
- -trgd, --trg_dset <trg_dset>
TRG dataset found in cf_fpath that is associated with the TRG bins
- Default:
lcoe_fcr
- -np, --n_profiles <n_profiles>
Number of profiles per cluster to export.
- Default:
1
- -fcst, --forecast_fpath <forecast_fpath>
reV generation output file for forecast data. If this is input, profiles will be taken from forecast file instead of the cf file, based on a NN mapping.
valid-config-keys
Echo the valid RPM config keys
reV-rpm valid-config-keys [OPTIONS]