turbine-flicker

Turbine Flicker Command Line Interface

turbine-flicker [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

-n, --name <name>

Job name.

Default:: 'TurbineFlicker'

-v, --verbose: Flag to turn on debug logging. Default is not verbose.

from-config

Run turbine flicker from a config.

turbine-flicker from-config [OPTIONS]

Options

-c, --config <config>: Required Filepath to TurbineFlicker config json file.

-v, --verbose: Flag to turn on debug logging. Default is not verbose.

local

Compute turbine flicker on local hardware

turbine-flicker local [OPTIONS]

Options

-excl, --excl_fpath <excl_fpath>: Required Filepath to exclusions h5 with techmap dataset.

-ref, --res_fpath <res_fpath>: Required Filepath to .h5 file containing wind direction data

-bldl, --building_layer <building_layer>: Exclusion layer containing buildings from which turbine flicker exclusions will be computed.

-h, --hub_height <hub_height>: Required Hub-height in meters to compute turbine shadow flicker.

-rd, --rotor_diameter <rotor_diameter>: Required Rotor diameter in meters to compute turbine shadow flicker.

-ol, --out_layer <out_layer>: Layer to save exclusions under. Layer will be saved in excl_fpath, if not provided will be generated from the building_layer name and hub-height

-o, --out_dir <out_dir>: Required Directory to save setbacks geotiff(s) into

-td, --tm_dset <tm_dset>

Dataset name in the techmap file containing the exclusions-to-resource mapping data

Default:: 'techmap_wtk'

-bldt, --building_threshold <building_threshold>

Threshold for exclusion layer values to identify pixels with buildings. Values are % of pixels containing a building

Default:: 0

-ft, --flicker_threshold <flicker_threshold>

Maximum number of allowable flicker hours

Default:: 30

-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

-gcs, --grid_cell_size <grid_cell_size>

Length (m) of a side of each grid cell in excl_fpath.

Default:: 90

-mfer, --max_flicker_exclusion_range <max_flicker_exclusion_range>

Max distance (m) that flicker exclusions will extend in any of the cardinal directions. Can also be a string like '10x' (default), which is interpreted as 10 times the turbine rotor diameter. Note that increasing this value can lead to drastically instead memory requirements. This value may be increased slightly in order to yield odd exclusion array shapes.

Default:: '10x'

-regs, --regulations_fpath <regulations_fpath>: Path to regulations .csv file, if None create generic setbacks using max - tip height * “multiplier”, by default None

-mw, --max_workers <max_workers>: Number of cores to run summary on. None is all available cpus

-r, --replace: Flag to replace local layer data with arr if layer already exists in the exclusion .h5 file

-hsds, --hsds: Flag to use h5pyd to handle .h5 domain hosted on AWS behind HSDS

-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 Turbine Flicker config keys

turbine-flicker valid-config-keys [OPTIONS]