mean-wind-dirs
Mean Wind Directions Command Line Interface
mean-wind-dirs [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
- -n, --name <name>
Job name.
- Default:
MeanWindDirs
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
from-config
Run mean wind directions from a config.
mean-wind-dirs from-config [OPTIONS]
Options
- -c, --config <config>
Required Filepath to MeanWindDirections config json file.
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
local
Compute mean wind directions on local hardware
mean-wind-dirs local [OPTIONS]
Options
- -res, --res_h5_fpath <res_h5_fpath>
Required Filepath to .h5 file containing wind direction data
- -excl, --excl_fpath <excl_fpath>
Required Filepath to exclusions h5 with techmap dataset.
- -dsets, --wdir_dsets <wdir_dsets>
Required Wind direction dataset to average
- -o, --out_dir <out_dir>
Required Directory to dump output files
- -td, --tm_dset <tm_dset>
Dataset name in the techmap file containing the exclusions-to-resource mapping data,
- Default:
techmap_wtk
- -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”, “inclusion_weights”, “force_inclusion_values”, “use_as_weights”, “exclude_nodata”, and/or “weight”.
- -res, --resolution <resolution>
SC resolution, must be input in combination with gid. Prefered option is to use the row / col slices to define the SC point instead
- Default:
128
- -ea, --excl_area <excl_area>
Area of an exclusion cell (square km)
- -afk, --area_filter_kernel <area_filter_kernel>
Contiguous area filter kernel name (“queen”, “rook”).
- -ma, --min_area <min_area>
Contiguous area filter minimum area, default is None (No minimum area filter).
- -spw, --sites_per_worker <sites_per_worker>
Number of SC points to process on each parallel worker
- Default:
1000
- -mw, --max_workers <max_workers>
Number of cores to run summary on. None is all available cpus
- -log, --log_dir <log_dir>
Directory to dump log files. Default is out_dir.
- -v, --verbose
Flag to turn on debug logging. Default is not verbose.
valid-config-keys
Echo the valid Mean Wind Dirs config keys
mean-wind-dirs valid-config-keys [OPTIONS]