Command Line Interface (CLI)#
reVReports#
reVReports command line interface
Usage
reVReports [OPTIONS] COMMAND [ARGS]...
Options
- --version#
Show the version and exit.
- -v, --verbose#
Flag to turn on debug logging. Default is not verbose.
maps#
Create report maps for configured supply curves
Usage
reVReports maps [OPTIONS]
Options
- -c, --config-file <config_file>#
Required Path to input configuration JSON file.
- -o, --out-path <out_path>#
Path to output folder where plots will be saved. Folder will be created if it does not exist.
- -d, --dpi <dpi>#
Resolution of output images in dots per inch. Default is 300.
plots#
Create report plots for configured supply curves
Usage
reVReports plots [OPTIONS]
Options
- -c, --config-file <config_file>#
Required Path to input configuration JSON file.
- -o, --out-path <out_path>#
Path to output folder where plots will be saved. Folder will be created if it does not exist.
- -d, --dpi <dpi>#
Resolution of output images in dots per inch. Default is 300.
unpack-characterizations#
Unpack characterization data from the input supply curve
The unpacking converts values from embedded JSON strings to new standalone columns, and saves a new version of the supply curve with these columns included.
Usage
reVReports unpack-characterizations [OPTIONS]
Options
- -i, --supply_curve_csv <supply_curve_csv>#
Required Path to bespoke wind supply curve CSV file created by reV
- -m, --char_map <char_map>#
Required Path to JSON file storing characterization map
- -o, --out_csv <out_csv>#
Required Path to CSV to store results
- -c, --cell_size <cell_size>#
Cell size in meters of characterization layers. Default is 90.