US-wave

US Wave Command Line Interface

US-wave [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

-d, --domain <domain>

Required Geospatial domain to extract data from

Options

West_Coast | Hawaii

-o, --out_dir <out_dir>

Required Directory to dump output files

-yrs, --years <years>

List of years to access, by default None

-b, --buoy

Boolean flag to use access virtual buoy data

-hpc, --eagle

Boolean flag to use access data on NRELs HPC vs. via HSDS

-log, --log_file <log_file>

Path to .log file, if None only log to stdout

-v, --verbose

Flag to turn on debug logging. Default is not verbose.

dataset

Extract a single dataset

US-wave dataset [OPTIONS] COMMAND [ARGS]...

Options

-d, --dataset <dataset>

Required Dataset to extract

box

Extract all pixels in the given bounding box

US-wave dataset box [OPTIONS]

Options

-ll1, --lat_lon_1 <lat_lon_1>

Required One corner of the bounding box

-ll2, --lat_lon_2 <lat_lon_2>

Required The other corner of the bounding box

-ts, --timestep <timestep>

Timestep to extract

-fs, --file_suffix <file_suffix>

File name suffix

map-means

Map means for given dataset in region if given.

US-wave dataset map-means [OPTIONS] COMMAND [ARGS]...

Options

-r, --region <region>

Region to extract

-col, --region_col <region_col>

Meta column to search for region

Default

state

multi-year

Map means for a given year

US-wave dataset map-means multi-year [OPTIONS]

Options

-yrs, --years <years>

Required List of Years to average

year

Map means for a given year

US-wave dataset map-means year [OPTIONS]

Options

-yr, --year <year>

Required Year to average

multi-site

Extract multiple sites given in ‘–sites’ .csv or .json as “latitude”, “longitude” pairs OR “gid”s

US-wave dataset multi-site [OPTIONS]

Options

-s, --sites <sites>

Required .csv or .json file with columns “latitude”, “longitude” OR “gid”

region

Extract a single dataset for all gids in the given region

US-wave dataset region [OPTIONS]

Options

-r, --region <region>

Required Region to extract

-col, --region_col <region_col>

Meta column to search for region

-ts, --timestep <timestep>

Timestep to extract

site

Extract the nearest pixel to the given (lat, lon) coordinates OR the given resource gid

US-wave dataset site [OPTIONS]

Options

-ll, --lat_lon <lat_lon>

(lat, lon) coordinates of interest

-gid, --gid <gid>

Resource gid of interest