Command Line#
Help:
tsgettoolbox --help
cdec#
$ tsgettoolbox cdec --help
usage: tsgettoolbox cdec [-h] [--dur_code DUR_CODE]
[--sensor_nums SENSOR_NUMS] [--start_date START_DATE] [--end_date END_DATE]
station_id
The primary function of the California Data Exchange Center (CDEC) is to
facilitate the collection, storage, and exchange of hydrologic and climate
information to support real-time flood management and water supply needs in
California.
California Department of Water Resources: <[4;36mhttp://www.water.ca.gov/[0m> California
Data Exchange Center: <[4;36mhttp://cdec.water.ca.gov[0m>
Downloads data for a set of CDEC station and sensor ids. If either is not
provided, all available data will be downloaded.
positional arguments:
station_id [optional, default is None]
Each string is the CDEC station ID and consist of three capital letters.
options:
-h | --help
show this help message and exit
--dur_code DUR_CODE
[optional, default is None]
Possible values are 'E', 'H', 'D', and 'M' but not all of these time
resolutions are available at every station.
┌──────────┬─────────────┐
│ dur_code │ Description │
╞══════════╪═════════════╡
│ E │ event │
├──────────┼─────────────┤
│ H │ hourly │
├──────────┼─────────────┤
│ D │ daily │
├──────────┼─────────────┤
│ M │ monthly │
╘══════════╧═════════════╛
--sensor_nums SENSOR_NUMS
[optional, default is None]
If None will get all sensors at station_id.
SELECTED CDEC SENSOR NUMBERS (these are not available for all sites):
┌─────────────┬───────────────────────────────────────────┐
│ sensor_nums │ Description │
╞═════════════╪═══════════════════════════════════════════╡
│ 1 │ river stage [ft] │
├─────────────┼───────────────────────────────────────────┤
│ 2 │ precipitation accumulated [in] │
├─────────────┼───────────────────────────────────────────┤
│ 3 │ SWE [in] │
├─────────────┼───────────────────────────────────────────┤
│ 4 │ air temperature [F] │
├─────────────┼───────────────────────────────────────────┤
│ 5 │ EC [ms/cm] │
├─────────────┼───────────────────────────────────────────┤
│ 6 │ reservoir elevation [ft] │
├─────────────┼───────────────────────────────────────────┤
│ 7 │ reservoir scheduled release [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 8 │ full natural flow [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 15 │ reservoir storage [af] │
├─────────────┼───────────────────────────────────────────┤
│ 20 │ flow -- river discharge [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 22 │ reservoir storage change [af] │
├─────────────┼───────────────────────────────────────────┤
│ 23 │ reservoir outflow [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 24 │ Evapotranspiration [in] │
├─────────────┼───────────────────────────────────────────┤
│ 25 │ water temperature [F] │
├─────────────┼───────────────────────────────────────────┤
│ 27 │ water turbidity [ntu] │
├─────────────┼───────────────────────────────────────────┤
│ 28 │ chlorophyll [ug/l] │
├─────────────┼───────────────────────────────────────────┤
│ 41 │ flow -- mean daily [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 45 │ precipitation incremental [in] │
├─────────────┼───────────────────────────────────────────┤
│ 46 │ runoff volume [af] │
├─────────────┼───────────────────────────────────────────┤
│ 61 │ water dissolved oxygen [mg/l] │
├─────────────┼───────────────────────────────────────────┤
│ 62 │ water pH value [pH] │
├─────────────┼───────────────────────────────────────────┤
│ 64 │ pan evaporation (incremental) [in] │
├─────────────┼───────────────────────────────────────────┤
│ 65 │ full natural flow [af] │
├─────────────┼───────────────────────────────────────────┤
│ 66 │ flow -- monthly volume [af] │
├─────────────┼───────────────────────────────────────────┤
│ 67 │ accretions (estimated) [af] │
├─────────────┼───────────────────────────────────────────┤
│ 71 │ spillway discharge [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 74 │ lake evaporation (computed) [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 76 │ reservoir inflow [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 85 │ control regulating discharge [cfs] │
├─────────────┼───────────────────────────────────────────┤
│ 94 │ top conservation storage (reservoir) [af] │
├─────────────┼───────────────────────────────────────────┤
│ 100 │ water EC [us/cm] │
╘═════════════╧═══════════════════════════════════════════╛
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
coops#
$ tsgettoolbox coops --help
usage: tsgettoolbox coops [-h] [--date DATE] [--begin_date BEGIN_DATE]
[--end_date END_DATE] [--range RANGE] [--product PRODUCT] [--datum DATUM]
[--time_zone TIME_ZONE] [--interval INTERVAL] [--bin BIN] station
CO-OPS web services is at <[4;36mhttps://tidesandcurrents.noaa.gov/api/[0m>. The time
zone of the returned data depends on the setting of the "time_zone" option. The
default is "GMT" also known as "UTC".
positional arguments:
station A 7 character station ID, or a currents station ID.
Station listings for various products can be viewed at
<[4;36mhttps://tidesandcurrents.noaa.gov[0m> or viewed on a map at Tides &
Currents Station Map
options:
-h | --help
show this help message and exit
--date DATE
[optional, default is None]
The API understands several parameters related to date ranges. Date
formats are pretty flexible, however the closer to ISO 8601, the
better.
The date related options are 'begin_date', 'end_date', 'date', and
'range'. They can be combined in the following 5 ways, but if
conflicting then follows the table in order. For example, the 'date'
option will be used if present regardless of any other option, then
'range', ...etc.:
┌───────────────────┬─────────────────────────────────────────────────┐
│ Parameter Name(s) │ Description │
╞═══════════════════╪═════════════════════════════════════════════════╡
│ date │ 'latest', 'today', or 'recent' │
├───────────────────┼─────────────────────────────────────────────────┤
│ range │ Specify a number of hours to go back from now │
│ │ and retrieve data for that date range │
├───────────────────┼─────────────────────────────────────────────────┤
│ begin_date and │ Specify a begin date and a number of hours to │
│ range │ retrieve data starting from that date │
├───────────────────┼─────────────────────────────────────────────────┤
│ begin_date and │ Specify the date/time range of retrieval │
│ end_date │ │
├───────────────────┼─────────────────────────────────────────────────┤
│ end_date and │ Specify an end date and a number of hours to │
│ range │ retrieve data ending at that date │
╘═══════════════════╧═════════════════════════════════════════════════╛
┌──────────────────────────────────────┬─────────────────┐
│ Description of "--date" option │ Option │
╞══════════════════════════════════════╪═════════════════╡
│ Today's data │ --date='today' │
├──────────────────────────────────────┼─────────────────┤
│ The last 3 days of data │ --date='recent' │
├──────────────────────────────────────┼─────────────────┤
│ The last data point available within │ --date='latest' │
│ the last 18 minutes. │ │
╘══════════════════════════════════════╧═════════════════╛
--begin_date BEGIN_DATE
[optional, default is None]
The beginning date for the data. See explanation with the 'date' option on
how to use all of the date related parameters.
--end_date END_DATE
[optional, default is None]
The end date for the data. January 1st, 2012 through January 2nd, 2012:
--begin_date='20120101' --end_date='20120102'
See explanation with the 'date' option on how to use all of the date
related parameters.
--range RANGE
[optional, default is None]
Specify the number of hours to go back from now, an 'end_date', or forward
from a 'begin_date'.
48 hours beginning on April 15, 2012:
--begin_date='20120415' --range=48
48 hours ending on March 17, 2012:
--end_date='20120307' --range=48
The last 24 hours from now:
--range=24
The last 3 hours from now:
--range=3
See explanation with the 'date' option on how to use all of the date
related parameters.
--product PRODUCT
[optional, default is 'hourly_height']
Specify the data product.
┌────────────────────────┬────────────────────────────────────────────┐
│ Water Level Data │ Description │
│ Products │ │
╞════════════════════════╪════════════════════════════════════════════╡
│ water_level │ Six minute preliminary or verified water │
│ │ levels, depending on availability. │
├────────────────────────┼────────────────────────────────────────────┤
│ hourly_height │ Verified hourly height water level data │
├────────────────────────┼────────────────────────────────────────────┤
│ high_low │ Verified high/low water level data │
├────────────────────────┼────────────────────────────────────────────┤
│ daily_mean │ Verified daily mean water level data │
├────────────────────────┼────────────────────────────────────────────┤
│ monthly_mean │ Verified monthly mean water level data │
├────────────────────────┼────────────────────────────────────────────┤
│ one_minute_water_level │ One minute water level data │
├────────────────────────┼────────────────────────────────────────────┤
│ predictions │ Water level predictions at specified │
│ │ intervals by the interval argument │
├────────────────────────┼────────────────────────────────────────────┤
│ air_gap │ (distance between a bridge and the water's │
│ │ surface) │
╘════════════════════════╧════════════════════════════════════════════╛
┌────────────────────────┬────────────────────────────────────────────┐
│ Meteorological │ Description │
╞═Products═══════════════╪════════════════════════════════════════════╡
│ air_temperature │ Air temperature │
├────────────────────────┼────────────────────────────────────────────┤
│ water_temperature │ Water temperature │
├────────────────────────┼────────────────────────────────────────────┤
│ wind │ Wind speed, direction, and gusts │
├────────────────────────┼────────────────────────────────────────────┤
│ air_pressure │ Barometric pressure │
├────────────────────────┼────────────────────────────────────────────┤
│ conductivity │ The water's conductivity │
├────────────────────────┼────────────────────────────────────────────┤
│ visibility │ Visibility from the station's visibility │
│ │ sensor. A measure of atmospheric clarity. │
├────────────────────────┼────────────────────────────────────────────┤
│ humidity │ Relative humidity │
├────────────────────────┼────────────────────────────────────────────┤
│ salinity │ Salinity and specific gravity │
╘════════════════════════╧════════════════════════════════════════════╛
┌────────────────────────┬────────────────────────────────────────────┐
│ Currents Products │ Description │
╞════════════════════════╪════════════════════════════════════════════╡
│ currents │ Currents data. Defaults to 6 minute │
│ │ interval, which can be change to hourly │
│ │ using interval="h". │
├────────────────────────┼────────────────────────────────────────────┤
│ currents_predictions │ Predicted currents at interval argument │
│ │ intervals. │
├────────────────────────┼────────────────────────────────────────────┤
│ currents_header │ Header information for currents data. │
│ │ Limited to one month. │
╘════════════════════════╧════════════════════════════════════════════╛
┌────────────────────────┬────────────────────────────────────────────┐
│ Operation Model │ Description │
╞═Products═══════════════╪════════════════════════════════════════════╡
│ ofs_water_level │ Water level data from the NOS OFS models. │
│ │ From 2020 to present. │
╘════════════════════════╧════════════════════════════════════════════╛
The returned data for each "product" documented below is derived from
<[4;36mhttps://api.tidesandcurrents.noaa.gov/api/prod/responseHelp.html[0m>
product = "water_level"
┌─────────────────────────────┬───────────────────────────────────────┐
│ tsgettoolbox Column Name │ Description │
╞═════════════════════════════╪═══════════════════════════════════════╡
│ water_level:{units} │ Measurement │
├─────────────────────────────┼───────────────────────────────────────┤
│ water_level_sigma:{units} │ Standard deviation of 1 second │
│ │ samples used to compute the water │
├─────────────────────────────┼─level height──────────────────────────┤
│ water_level_CntSigma OR │ if preliminary Count of number of 1 │
│ water_level_Inferred │ second that falls outside a 3-sigma │
│ │ band about the mean if verified A │
│ │ flag that when set to 1 indicates │
│ │ that the water level value has been │
├─────────────────────────────┼─inferred──────────────────────────────┤
│ water_level_FlatTol │ A flag that when set to 1 indicates │
│ │ that the flat tolerance limit was │
│ │ exceeded │
├─────────────────────────────┼───────────────────────────────────────┤
│ water_level_RateTol │ A flag that when set to 1 indicates │
│ │ that the rate of change tolerance │
│ │ limit was exceeded │
├─────────────────────────────┼───────────────────────────────────────┤
│ water_level_LimitTol OR │ if preliminary A flag that when set │
│ water_level_TempRateTol │ to 1 indicates that either the │
│ │ maximum or minimum expected value was │
│ │ exceeded if verified A flag that when │
│ │ set to 1 indicates that the rate of │
│ │ change in temperature tolerance limit │
│ │ was exceeded │
├─────────────────────────────┼───────────────────────────────────────┤
│ water_level_quality:{units} │ Quality Assurance/Quality Control "p" │
│ │ = preliminary "v" = verified │
╘═════════════════════════════╧═══════════════════════════════════════╛
product = "air_pressure", "air_temperature", "humidity",
"water_temperature", or "conductivity"
┌───────────────────┬─────────────────────────────────────────────────┐
│ tsgettoolbox │ Description │
│ Column Name │ │
╞═══════════════════╪═════════════════════════════════════════════════╡
│ {product}:{units} │ Measurement │
├───────────────────┼─────────────────────────────────────────────────┤
│ {product}_MaxTol │ A flag that when set to 1 indicates that the │
│ │ maximum expected value was exceeded │
├───────────────────┼─────────────────────────────────────────────────┤
│ {product}_MinTol │ A flag that when set to 1 indicates that the │
│ │ minimum expected value was exceeded │
├───────────────────┼─────────────────────────────────────────────────┤
│ {product}_RateTol │ A flag that when set to 1 indicates that the │
│ │ rate of change tolerance limit was exceeded │
╘═══════════════════╧═════════════════════════════════════════════════╛
Hourly Height: product = "hourly_height"
┌─────────────────────────────┬───────────────────────────────────────┐
│ tsgettoolbox Column Name │ Description │
╞═════════════════════════════╪═══════════════════════════════════════╡
│ hourly_height:{units} │ Value - Measured water level height │
├─────────────────────────────┼───────────────────────────────────────┤
│ hourly_height_sigma:{units} │ Sigma - Standard deviation of 1 │
│ │ second samples used to compute the │
│ │ water level height │
├─────────────────────────────┼───────────────────────────────────────┤
│ hourly_height_Inferred │ A flag that when set to 1 indicates │
│ │ that the water level value has been │
│ │ inferred │
├─────────────────────────────┼───────────────────────────────────────┤
│ hourly_height_LimitTol │ A flag that when set to 1 indicates │
│ │ that either the maximum or minimum │
│ │ expected value was exceeded │
╘═════════════════════════════╧═══════════════════════════════════════╛
High Low: product = "high_low"
┌───────────────────┬─────────────────────────────────────────────────┐
│ tsgettoolbox │ Description │
│ Column Name │ │
╞═══════════════════╪═════════════════════════════════════════════════╡
│ high_low:{units} │ Value - Measured water level height │
├───────────────────┼─────────────────────────────────────────────────┤
│ high_low_Type │ Type - Designation of Water level height. HH = │
│ │ Higher High water H = High water L = Low water │
│ │ LL = Lower Low water │
├───────────────────┼─────────────────────────────────────────────────┤
│ high_low_Inferred │ A flag that when set to 1 indicates that the │
│ │ water level value has been inferred │
├───────────────────┼─────────────────────────────────────────────────┤
│ high_low_LimitTol │ A flag that when set to 1 indicates that either │
│ │ the maximum or minimum expected value was │
│ │ exceeded │
╘═══════════════════╧═════════════════════════════════════════════════╛
Daily Mean: product = "daily_mean"
┌─────────────────────┬───────────────────────────────────────────────┐
│ tsgettoolbox Column │ Description │
│ Name │ │
╞═════════════════════╪═══════════════════════════════════════════════╡
│ daily_mean:{units} │ Value – Mean hourly data over a 24 hour │
├─────────────────────┼─period────────────────────────────────────────┤
│ daily_mean_Inferred │ A flag that when set to 1 indicates that the │
│ │ water level value has been inferred │
├─────────────────────┼───────────────────────────────────────────────┤
│ daily_mean_LimitTol │ A flag that when set to 1 indicates that │
│ │ either the maximum or minimum expected value │
│ │ was exceeded │
╘═════════════════════╧═══════════════════════════════════════════════╛
Monthly Mean: product = "monthly_mean"
┌──────────────┬──────────────────────────────────────────────────────┐
│ tsgettoolbox │ Description │
│ Column Name │ │
╞══════════════╪══════════════════════════════════════════════════════╡
│ year │ Year │
├──────────────┼──────────────────────────────────────────────────────┤
│ month │ Month │
├──────────────┼──────────────────────────────────────────────────────┤
│ highest │ Highest Tide │
├──────────────┼──────────────────────────────────────────────────────┤
│ MHHW │ Mean Higher-High Water │
├──────────────┼──────────────────────────────────────────────────────┤
│ MHW │ Mean High Water │
├──────────────┼──────────────────────────────────────────────────────┤
│ MSL │ Mean Sea Level │
├──────────────┼──────────────────────────────────────────────────────┤
│ MTL │ Mean Tide Level │
├──────────────┼──────────────────────────────────────────────────────┤
│ MLW │ Mean Low Water │
├──────────────┼──────────────────────────────────────────────────────┤
│ MLLW │ Mean Lower-Low Water │
├──────────────┼──────────────────────────────────────────────────────┤
│ DTL │ Mean Diurnal Tide Level │
├──────────────┼──────────────────────────────────────────────────────┤
│ GT │ Great Diurnal Range │
├──────────────┼──────────────────────────────────────────────────────┤
│ MN │ Mean Range of Tide │
├──────────────┼──────────────────────────────────────────────────────┤
│ DHQ │ Mean Diurnal High Water Inequality │
├──────────────┼──────────────────────────────────────────────────────┤
│ DLQ │ Mean Diurnal Low Water Inequality │
├──────────────┼──────────────────────────────────────────────────────┤
│ HWI │ Greenwich High Water Interval (in Hours) │
├──────────────┼──────────────────────────────────────────────────────┤
│ LWI │ Greenwich Low Water Interval (in Hours) │
├──────────────┼──────────────────────────────────────────────────────┤
│ lowest │ Lowest Tide │
├──────────────┼──────────────────────────────────────────────────────┤
│ inferred │ A flag that when set to 1 indicates that the water │
│ │ level value has been inferred │
╘══════════════╧══════════════════════════════════════════════════════╛
One Minute Water Level: product = "one_minute_water_level"
┌────────────────────────────────┬────────────────────────────────────┐
│ tsgettoolbox Column Name │ Description │
╞════════════════════════════════╪════════════════════════════════════╡
│ one_minute_water_level:{units} │ Value - Measured water level │
╘════════════════════════════════╧═height═════════════════════════════╛
Tide Predictions: product = "predictions"
┌─────────────────────┬──────────────────────────────────────┐
│ tsgettoolbox Column │ Description │
│ Name │ │
╞═════════════════════╪══════════════════════════════════════╡
│ predictions:{units} │ Value - Predicted water level height │
╘═════════════════════╧══════════════════════════════════════╛
Air Gap: product = "air_gap"
┌───────────────────────┬─────────────────────────────────────────────┐
│ tsgettoolbox Column │ Description │
│ Name │ │
╞═══════════════════════╪═════════════════════════════════════════════╡
│ air_gap:{units} │ Value - Measured air gap │
├───────────────────────┼─────────────────────────────────────────────┤
│ air_gap_sigma:{units} │ Sigma - Standard deviation of 1 second │
│ │ samples used to compute the air gap │
├───────────────────────┼─────────────────────────────────────────────┤
│ air_gap_CntSigma │ Count of number of 1 second that falls │
│ │ outside a 3-sigma band about the mean │
├───────────────────────┼─────────────────────────────────────────────┤
│ air_gap_FlatTol │ A flag that when set to 1 indicates that │
│ │ the flat tolerance limit was exceeded │
├───────────────────────┼─────────────────────────────────────────────┤
│ air_gap_RateTol │ A flag that when set to 1 indicates that │
│ │ the rate of change tolerance limit was │
├───────────────────────┼─exceeded────────────────────────────────────┤
│ air_gap_MinMaxTol │ A flag that when set to 1 indicates that │
│ │ either the maximum or minimum expected air │
│ │ gap limit was exceeded │
╘═══════════════════════╧═════════════════════════════════════════════╛
Wind: product = "wind"
┌────────────────────────┬────────────────────────────────────────────┐
│ tsgettoolbox Column │ Description │
╞═Name═══════════════════╪════════════════════════════════════════════╡
│ wind_speed:{units} │ Speed - Measured wind speed │
├────────────────────────┼────────────────────────────────────────────┤
│ wind_direction:degrees │ Direction - wind direction in degrees │
├────────────────────────┼────────────────────────────────────────────┤
│ wind_direction:text │ Direction - wind direction in text │
├────────────────────────┼────────────────────────────────────────────┤
│ wind_gust:{units} │ Gust - Measured wind gust speed │
├────────────────────────┼────────────────────────────────────────────┤
│ wind{suffix} │ Data Flags - in order of listing "X,R" │
│ │ Flags described above │
╘════════════════════════╧════════════════════════════════════════════╛
Visibility: product = "visibility"
┌────────────────────┬─────────────────────────────┐
│ tsgettoolbox │ Description │
│ Column Name │ │
╞════════════════════╪═════════════════════════════╡
│ visibility:{units} │ Value - Measured visibility │
╘════════════════════╧═════════════════════════════╛
Salinity: product = "salinity"
┌──────────────────┬──────────────────┐
│ tsgettoolbox │ Description │
│ Column Name │ │
╞══════════════════╪══════════════════╡
│ salinity:{units} │ Salinity │
├──────────────────┼──────────────────┤
│ specific_gravity │ Specific Gravity │
╘══════════════════╧══════════════════╛
Currents: product = "currents"
┌────────────────────────────┬────────────────────────────────────────┐
│ tsgettoolbox Column Name │ Description │
╞════════════════════════════╪════════════════════════════════════════╡
│ currents_speed:{units} │ Speed - Measured current speed │
├────────────────────────────┼────────────────────────────────────────┤
│ currents_direction:degrees │ Direction - current direction in │
├────────────────────────────┼─degrees────────────────────────────────┤
│ currents_bin_number │ Bin number │
╘════════════════════════════╧════════════════════════════════════════╛
--datum DATUM
[optional, default is 'NAVD']
Specify the datum that all water levels will be reported against. Note!
Datum is mandatory for all water level products and defaults to
"NAVD".
┌────────┬───────────────────────────────┬────────────────────────────┐
│ Option │ Description │ Restrictions │
╞════════╪═══════════════════════════════╪════════════════════════════╡
│ CRD │ Colombia River Datum │ Only available for the │
│ │ │ Columbia River │
├────────┼───────────────────────────────┼────────────────────────────┤
│ IGLD │ International Great Lakes │ Only available for the │
│ │ Datum │ Great Lakes │
├────────┼───────────────────────────────┼────────────────────────────┤
│ LWD │ Great Lakes Low Water Datum │ Only available for the │
│ │ │ Great Lakes │
├────────┼───────────────────────────────┼────────────────────────────┤
│ MHHW │ Mean Higher High Water │ │
├────────┼───────────────────────────────┼────────────────────────────┤
│ MHW │ Mean High Water │ │
├────────┼───────────────────────────────┼────────────────────────────┤
│ MTL │ Mean Tide Level │ │
├────────┼───────────────────────────────┼────────────────────────────┤
│ MSL │ Mean Sea Level │ │
├────────┼───────────────────────────────┼────────────────────────────┤
│ MLW │ Mean Low Water │ │
├────────┼───────────────────────────────┼────────────────────────────┤
│ MLLW │ Mean Lower Low Water │ Subordinate tide │
│ │ │ prediction stations must │
├────────┼───────────────────────────────┼─use this datum─────────────┤
│ NAVD │ North American Vertical Datum │ Not available for all │
│ │ │ stations │
├────────┼───────────────────────────────┼────────────────────────────┤
│ STND │ Station Datum │ │
╘════════╧═══════════════════════════════╧════════════════════════════╛
--time_zone TIME_ZONE
[optional, default is 'GMT']
The time zone is specified as 'gmt', 'lst' or 'lst_ldt'.
┌─────────┬───────────────────────────────────────────────────────────┐
│ Option │ Description │
╞═════════╪═══════════════════════════════════════════════════════════╡
│ gmt │ Greenwich Mean Time │
├─────────┼───────────────────────────────────────────────────────────┤
│ lst │ Local Standard Time. The time local to the requested │
│ │ station. │
├─────────┼───────────────────────────────────────────────────────────┤
│ lst_ldt │ Local Standard/Local Daylight Time. The time local to the │
│ │ requested station. │
╘═════════╧═══════════════════════════════════════════════════════════╛
--interval INTERVAL
[optional, defaults to 'h']
Not used for observed water level data products:
product="water_level" # 6 minute
product="hourly_height" # hourly
product="high_low" # variable interval
product="daily_mean" # daily
product="monthly_mean" # monthly
product="one_minute_water_level" # one minute
Interval of the predicted water level.
┌───────────────────────┬──────────────────────────────────────┐
│ product="predictions" │ Description │
╞═══════════════════════╪══════════════════════════════════════╡
│ h │ Hourly water level predictions │
├───────────────────────┼──────────────────────────────────────┤
│ 1, 5, 6, 10, 15, 30, │ Interval in minutes. Only these │
│ 60 │ intervals are available. │
├───────────────────────┼──────────────────────────────────────┤
│ hilo │ High/low predictions for subordinate │
│ │ stations │
╘═══════════════════════╧══════════════════════════════════════╛
Interval of the currents data. Defaults to 6 minute intervals.
┌───────────────────────┬──────────────────────────────────┐
│ product="currents" │ Description │
╞═══════════════════════╪══════════════════════════════════╡
│ h │ Hourly current data │
╘═══════════════════════╧══════════════════════════════════╛
Interval of the predicted currents.
┌────────────────────────────────┬────────────────────────────────────┐
│ product="currents_predictions" │ Description │
╞════════════════════════════════╪════════════════════════════════════╡
│ h │ Hourly current predictions │
├────────────────────────────────┼────────────────────────────────────┤
│ 1, 6, 10, 30, 60 │ Interval in minutes. Only these │
│ │ intervals are available. │
├────────────────────────────────┼────────────────────────────────────┤
│ max_slack │ Current predictions of max │
╘════════════════════════════════╧═flood/ebb══════════════════════════╛
Interval of the meteorological data. Defaults to 6 minute intervals.
┌─────────────────────────────┬────────────────────────────┐
│ product="air_temperature" │ Description │
│ product="water_temperature" │ │
│ product="wind" │ │
│ product="air_pressure" │ │
│ product="conductivity" │ │
│ product="visibility" │ │
│ product="humidity" │ │
│ product="salinity" │ │
╞═════════════════════════════╪════════════════════════════╡
│ h │ Hourly meteorological data │
╘═════════════════════════════╧════════════════════════════╛
--bin BIN
[optional, defaults to None] The bin number for the specified currents
station Example:'--bin=4' Will retrieve data for bin number 4. Note!
If a bin is not specified for a PORTS station, the data is returned
using a predefined real-time bin.
daymet#
$ tsgettoolbox daymet --help
usage: tsgettoolbox daymet [-h] [--start_date START_DATE]
[--end_date END_DATE] [--years YEARS] [--measuredParams MEASUREDPARAMS] lat
lon
Detailed documentation is at <[4;36mhttp://daymet.ornl.gov/[0m>. Since this is daily
data, it covers midnight to midnight based on local time.
positional arguments:
lat Latitude (required): Enter single geographic point by latitude, value
between 52.0N and 14.5N.:
Example: --lat=43.1
lon Longitude (required): Enter single geographic point by longitude, value
between -131.0W and -53.0W.:
Example: --lon=-85.3
options:
-h | --help
show this help message and exit
--start_date START_DATE
For North America and Hawaii, the earliest date is 1980-01-01. For Puerto
Rico, the earliest date it 1950-01-01.
--end_date END_DATE
The latest end date is usually 12-31 of the previous calendar year, though
this is dependent on time required to process the previous year's
data.
--years YEARS
Current Daymet product is available from 1980 to the latest full calendar
year.:
Example: --years=2012,2014
This overrides the start_date and end_date options.
--measuredParams MEASUREDPARAMS
[optional, defaults to "all"]
Use the abbreviations from the following table:
┌───────────────────┬──────────────────────────┬─────────┐
│ measuredParams │ Description │ Unit │
╞═══════════════════╪══════════════════════════╪═════════╡
│ prcp │ precipitation │ mm │
├───────────────────┼──────────────────────────┼─────────┤
│ swe │ snow-water equivalent │ kg/m2 │
├───────────────────┼──────────────────────────┼─────────┤
│ tmax │ maximum temperature │ degC │
├───────────────────┼──────────────────────────┼─────────┤
│ tmin │ minimum temperature │ degC │
├───────────────────┼──────────────────────────┼─────────┤
│ vp │ vapor pressure │ Pa │
├───────────────────┼──────────────────────────┼─────────┤
│ dayl │ daylength │ seconds │
├───────────────────┼──────────────────────────┼─────────┤
│ srad │ shortwave radiation │ W/m2 │
╘═══════════════════╧══════════════════════════╧═════════╛
Example: --measuredParams=tmax,tmin
All variables are returned by default.
epa_wqp#
$ tsgettoolbox epa_wqp --help
usage: tsgettoolbox epa_wqp [-h] [--bBox BBOX] [--lat LAT] [--lon LON]
[--within WITHIN] [--countrycode COUNTRYCODE] [--statecode STATECODE]
[--countycode COUNTYCODE] [--siteType SITETYPE] [--organization
ORGANIZATION] [--siteid SITEID] [--huc HUC] [--sampleMedia SAMPLEMEDIA]
[--characteristicType CHARACTERISTICTYPE] [--characteristicName
CHARACTERISTICNAME] [--pCode PCODE] [--activityId ACTIVITYID] [--startDateLo
STARTDATELO] [--startDateHi STARTDATEHI]
All of the keywords could be considered as subtractive filters of the stations.
Some of the keywords can result in very large number of stations being
downloaded.
options:
-h | --help
show this help message and exit
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--lat LAT
[optional, default is None]
Latitude for radial search, expressed in decimal degrees, WGS84
The lat, lon, and within arguments are used together to form a circle on
the Earth's surface for locating data-collection stations. Many
stations outside the continental US do not have latitude and
longitude referenced to WGS84 and therefore cannot be found using
these parameters.
--lon LON
[optional, default is None]
Longitude for radial search, expressed in decimal degrees, WGS84
The lat, lon, and within arguments are used together to form a circle on
the Earth's surface for locating data-collection stations. Many
stations outside the continental US do not have latitude and
longitude referenced to WGS84 and therefore cannot be found using
these parameters.
--within WITHIN
[optional, default is None]
Distance for radial search, expressed in decimal miles
The lat, lon, and within arguments are used together to form a circle on
the Earth's surface for locating data-collection stations. Many
stations outside the continental US do not have latitude and
longitude referenced to WGS84 and therefore cannot be found using
these parameters.
--countrycode COUNTRYCODE
[optional, default is None]
Two-character Federal Information Processing Standard (FIPS) country code.
(see domain service for available codes)
FIPS country codes were established by the National Institute of
Standards, publication 5-2.
--statecode STATECODE
[optional, default is None]
Two-character Federal Information Processing Standard (FIPS) country code,
followed bu a ":", followed by a two-digit FIPS state code. (see
domain service for available codes)
FIPS state codes were established by the National Institute of Standards,
publication 5-2.
--countycode COUNTYCODE
[optional, default is None]
Two-character Federal Information Processing Standard (FIPS) country code,
followed by a ":", followed by a two-digit FIPS state code, followed
by a ":", followed by a three-digit FIPS county code. (see domain
service for available codes)
FIPS county codes were established by the National Institute of Standards,
publication 5-2.
--siteType SITETYPE
[optional, default is None]
One or more case-sensitive site types, separated by semicolons. (see
domain service for available site types)
Restrict retrieval to stations with specified site type (location in the
hydrologic cycle). The MonitoringLocationTypeName for individual
records may provide more detailed information about the type of
individual stations.
--organization ORGANIZATION
[optional, default is None]
For USGS organization IDs, append an upper-case postal-service state
abbreviation to "USGS-" to identify the USGS office managing the
data collection station records. However, a few US states are
serviced by one USGS office.:
USGS-MA = Massachusetts and Rhode Island
USGS-MD = Maryland, Delaware, and the District of Columbia
USGS-PR = Caribbean Islands
USGS-HI = Pacific Islands
(see domain service for available organization IDs)
USGS offices sometimes provide data for stations outside the political
boundaries associated with the office's organization code. Use the
statecode or countycode arguments to search for stations located
within those political boundaries.
--siteid SITEID
[optional, default is None]
Concatenate an agency code, a hyphen ("-"), and a site-identification
number.
Each data collection station is assigned a unique site-identification
number. Other agencies often use different site identification
numbers for the same stations.
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--sampleMedia SAMPLEMEDIA
[optional, default is None]
One or more case-sensitive sample media, separated by semicolons. (see
domain service for available sample media)
Sample media are broad general classes, and may be subdivided in the
retrieved data. Examine the data elements ActivityMediaName,
ActivityMediaSubdivisionName, and ResultSampleFractionText for more
detailed information.
--characteristicType CHARACTERISTICTYPE
[optional, default is None]
One or more case-sensitive characteristic types (groupings) separated by
semicolons. (see domain service for available characteristic types)
These groups will be expanded as part of the ongoing collaboration between
USGS and USEPA.
--characteristicName CHARACTERISTICNAME
[optional, default is None]
One or more case-sensitive characteristic names, separated by semicolons.
(see domain service for available characteristic names)
Characteristic names identify different types of environmental
measurements. The names are derived from the USEPA Substance
Registry System (SRS). USGS uses parameter codes for the same
purpose and has associated most parameters to SRS names.
--pCode PCODE
[optional, default is None]
One or more five-digit USGS parameter codes, separated by semicolons. This
is equivalent to "parameterCd" used in other USGS web services.
--activityId ACTIVITYID
[optional, default is None]
One or more case-sensitive activity IDs, separated by semicolons.
Designator that uniquely identifies an activity within an
organization.
--startDateLo STARTDATELO
[optional, default is None]
Date of earliest desired data-collection activity. A very wide range of
date strings can be used but the closer to ISO 8601 the better.
--startDateHi STARTDATEHI
[optional, default is None]
Date of last desired data-collection activity. A very wide range of date
strings can be used but the closer to ISO 8601 the better.
fawn#
$ tsgettoolbox fawn --help
usage: tsgettoolbox fawn [-h] [--start_date START_DATE] [--end_date END_DATE]
stations variables reportType
US/FL:station::15T,H,D,M:Florida Automated Weather Network (FAWN)
positional arguments:
stations At the command line can supply a comma separated list of codes or
names. Using the Python API needs to be a Python list.
The current complete list of FAWN stations.
• 260 Alachua
• 320 Apopka
• 490 Arcadia
• 304 Avalon
• 350 Balm
• 410 'Belle Glade'
• 230 Bronson
• 310 Brooksville
• 150 Carrabelle
• 250 Citra
• 405 Clewiston
• 311 'Dade City'
• 120 'Defuniak Springs'
• 360 Dover
• 420 'Fort Lauderdale'
• 390 Frostproof
• 430 'Fort Pierce'
• 270 Hastings
• 440 Homestead
• 450 Immokalee
• 371 'Indian River'
• 110 Jay
• 241 Joshua
• 340 Kenansville
• 330 'Lake Alfred'
• 275 Lecanto
• 170 'Live Oak'
• 180 Macclenny
• 130 Marianna
• 121 May
• 160 Monticello
• 480 'North Port'
• 280 Ocklawaha
• 303 Okahumpka
• 455 Okeechobee
• 380 Ona
• 460 Palmdale
• 290 Pierson
• 240 Putnam Hall
• 140 Quincy
• 470 Sebring
• 435 'St. Lucie West'
• 302 Umatilla
• 425 Wellington
variables At the command line can supply a comma separated list of variable
names. Using the Python API needs to be a Python list.
The current complete list of FAWN variables are:
┌─────────────┬─────────────────────────────────────┬────────┐
│ Name │ Description │ Units │
╞═════════════╪═════════════════════════════════════╪════════╡
│ AirTemp1 │ Air temperature at 60 cm │ degF │
├─────────────┼─────────────────────────────────────┼────────┤
│ AirTemp9 │ Air temperature at 2 m │ degF │
├─────────────┼─────────────────────────────────────┼────────┤
│ AirTemp15 │ Air temperature at 10 m │ degF │
├─────────────┼─────────────────────────────────────┼────────┤
│ SoilTempAvg │ Soil temperature at -10 cm │ degF │
├─────────────┼─────────────────────────────────────┼────────┤
│ DewPoint │ Dew point │ degF │
├─────────────┼─────────────────────────────────────┼────────┤
│ WetBulb │ Wet bulb temperature │ degF │
├─────────────┼─────────────────────────────────────┼────────┤
│ RelHumAvg │ Relative humidity │ │
├─────────────┼─────────────────────────────────────┼────────┤
│ Rainfall │ Rainfall │ in │
├─────────────┼─────────────────────────────────────┼────────┤
│ TotalRad │ Total solar radiation │ w/m2 │
├─────────────┼─────────────────────────────────────┼────────┤
│ WindSpeed │ Wind speed │ mph │
├─────────────┼─────────────────────────────────────┼────────┤
│ WindDir │ Wind direction │ degree │
├─────────────┼─────────────────────────────────────┼────────┤
│ ET │ Reference ET Penman-Monteith │ in │
├─────────────┼─────────────────────────────────────┼────────┤
│ BP │ Barometric pressure at 2 m │ mb │
╘═════════════╧═════════════════════════════════════╧════════╛
The 'ET' variable is only available when reportType is "daily" or "monthly".
reportType Interval of the data. Can be one of "all" for 15 minute, "hourly",
"daily", or "monthly".
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
hydstra_catalog#
$ tsgettoolbox hydstra_catalog --help
<string>:33: (WARNING/2) Option list ends without a blank line; unexpected unindent.
usage: tsgettoolbox hydstra_catalog [-h] [--isleep ISLEEP]
[--tablefmt TABLEFMT] server station
Creates a table of datasources and variables available for a station, including
periods of record for each.
positional arguments:
server Server name or base URL of Hydstra webserver. This can be either
a direct URL (normally up to but not including a '?') or it can be one of
the following predetermined server names.
┌─────────────┬─────────────────────────────────────────────────────┐
│ Name │ Description │
╞═════════════╪═════════════════════════════════════════════════════╡
│ sjrwmd │ St. Johns Water Management District, Florida, USA │
│ │ <[4;36mhttps://secure.sjrwmd.com/hydweb/cgi/webse- │
├─────────────┼─rvice.exe[0m>──────────────────────────────────────┤
│ orangeco_ca │ Orange County Public Works, California USA │
│ │ <[4;36mhttp://Hydstra.OCPublicWorks.com/cgi/webse- │
╘═════════════╧═rvice.exe[0m>══════════════════════════════════════╛
station This should be the short 'station identifier', not the longer 'station
name'.
options:
-h | --help
show this help message and exit
--isleep ISLEEP
Integer seconds to sleep between webservice calls to create the catalog
table. Default is zero.
If HTTP errors occur, it may be due to web calls that come too fast, if
the server is configured to interpret rapid calls as a
denial-of-service attack. If this happens, increase isleep.
Option list ends without a blank line; unexpected unindent.
--tablefmt TABLEFMT
hydstra_stations#
$ tsgettoolbox hydstra_stations --help
usage: tsgettoolbox hydstra_stations [-h] [--activeonly] [--latlong]
[--tablefmt TABLEFMT] server
Creates a table of stations available on the server.
positional arguments:
server Server name or base URL of Hydstra webserver. This can be either
a direct URL (normally up to but not including a '?') or it can be one of
the following predetermined server names.
┌─────────────┬─────────────────────────────────────────────────────┐
│ Name │ Description │
╞═════════════╪═════════════════════════════════════════════════════╡
│ sjrwmd │ St. Johns Water Management District, Florida, USA │
│ │ <[4;36mhttps://secure.sjrwmd.com/hydweb/cgi/webse- │
├─────────────┼─rvice.exe[0m>──────────────────────────────────────┤
│ orangeco_ca │ Orange County Public Works, California USA │
│ │ <[4;36mhttp://Hydstra.OCPublicWorks.com/cgi/webse- │
╘═════════════╧═rvice.exe[0m>══════════════════════════════════════╛
options:
-h | --help
show this help message and exit
--activeonly
Boolean: False (default) returns all stations. True returns only active
stations.
--latlong
Boolean: False (default) omits latitude and longitude from station table.
True includes them.
--tablefmt TABLEFMT
Format for site or catalog table. Allowable values include plain
(default), csv, or any allowed value for the Python tabulate
package.
hydstra_ts#
$ tsgettoolbox hydstra_ts --help
usage: tsgettoolbox hydstra_ts [-h] [--interval INTERVAL] [--provisional]
[--datasource DATASOURCE] [--aggcode AGGCODE] [--quality] [--maxqual MAXQUAL]
server station variable start_time end_time
Hydstra databases are generally organized into stations, datasources, and
variables.
positional arguments:
server Server name or base URL of Hydstra webserver. This can be either
a direct URL (normally up to but not including a '?') or it can be one of
the following predetermined server names.
┌─────────────┬─────────────────────────────────────────────────────┐
│ Name │ Description │
╞═════════════╪═════════════════════════════════════════════════════╡
│ sjrwmd │ St. Johns Water Management District, Florida, USA │
│ │ <[4;36mhttps://secure.sjrwmd.com/hydweb/cgi/webse- │
├─────────────┼─rvice.exe[0m>──────────────────────────────────────┤
│ orangeco_ca │ Orange County Public Works, California USA │
│ │ <[4;36mhttp://Hydstra.OCPublicWorks.com/cgi/webse- │
╘═════════════╧═rvice.exe[0m>══════════════════════════════════════╛
station This should be the short 'station identifier', not the longer 'station
name'.
variable Name of variable or numeric variable code. The list of available
variables varies by server. The following is a typical list of names and
their associated numeric codes:
Rainfall:in: 11.10
Water_Elev_NAVD88:ft: 227.10
Gauge Height:ft: 233.10
Discharge:cfs: 262.17
Other available variable codes for a given station can be determined using
the hydstra_catalog command.
start_time Date and time for start of requested period in ISO format. For daily
and longer intervals, use YYYY-MM-DD. For sub-daily, use YYYY-MM-DD-hh-mm or
YYYY-MM-DD-hh-mm-ss if necessary.
end_time Date and time for end of requested period in ISO format. For daily and
longer intervals, use YYYY-MM-DD. For sub-daily, use YYYY-MM-DD-hh-mm or
YYYY-MM-DD-hh-mm-ss if necessary.
options:
-h | --help
show this help message and exit
--interval INTERVAL
Time step of data to return. Valid values are: year, month, day, hour,
minute, second
--provisional
Boolean: False (default) to skip provisional data. True to include it. In
many cases, this means datasources A and AB respectively. Details
may vary by server.
--datasource DATASOURCE
Hydstra databases include an attribute called 'datasource'. A given
variable may be present as multiple timeseries with different
datasources, each with various available periods of record and
levels of quality assurance.
For some servers, certain datasources are reserved for internal workflows
and may be skipped by the hydstra_catalog command.
Default is 'A' (for 'Archive') if not including provisional data. The
default for provisional data may vary by server. For instance:
sjrwmd The default for including recent non-QA'ed
provisional data is 'AB', which returns the full
span, distinguished by different quality codes. To
get only the provisional data, the 'X' datasource
would be used. There may be overlap in the time
spans of 'A' and 'X', during which the 'A' should
be preferred.
orangeco_ca There is no 'AB' datasource. The 'TELEMETRY'
datasource contains the provisional data, which can
overlap with the 'A' datasource
Required if provisional data is requested.
--aggcode AGGCODE
Aggregation code. defaults to 'tot' for rainfall, 'mean' for elevation and
discharge. Other values vary by server. Required if variable
specified by numeric code.
--quality
Boolean: False (default) provides no quality information. True to add a
column containing a numeric quality code 0 to 255. Definitions of
codes may vary by server.
--maxqual MAXQUAL
Highest allowable numeric quality code, above which the value is
considered missing. May be specified even if a separate quality
column is not requested.
ldas#
$ tsgettoolbox ldas --help
usage: tsgettoolbox ldas [-h] [--lat LAT] [--lon LON] [--variables VARIABLES]
[--startDate STARTDATE] [--endDate ENDDATE] [--variable VARIABLE]
The time zone is always UTC.
This command is deprecated. It has been split up into separate commands for each
of the different LDAS products. This command remains only so that old scripts
don't break.
Please use the following commands instead: ['ldas', 'ldas_gldas_noah',
'ldas_gldas_noah_v2_0', 'ldas_gldas_noah_v2_1', 'ldas_grace', 'ldas_merra',
'ldas_nldas_fora', 'ldas_nldas_noah', 'ldas_nldas_vic', 'ldas_smerge']
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ GLDAS Noah Land Surface │ 0.25x0.25 │ -60, 90 │ -180, 180 │ 3 hour │
│ Model GLDAS_NOAH025_3H │ │ │ │ 1948-01-01 to │
│ V2.0 │ │ │ │ 2014-12-31 │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ GLDAS Noah Land Surface │ 0.25x0.25 │ -60, 90 │ -180, 180 │ 3 hour │
│ Model GLDAS_NOAH025_3H │ │ │ │ 2000-01-01 to │
│ V2.1 │ │ │ │ present │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ Groundwater and Soil │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 7 day 2002-1- │
│ Moisture Conditions from │ │ │ │ 0-04 to │
│ GRACE Data Assimilation │ │ │ │ recent │
│ GRACEDADM_CLSM0125US_7D │ │ │ │ │
│ V4.0 │ │ │ │ │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ MERRA-2 2D, Instantaneous │ 0.5x0.625 │ -90, 90 │ -180, 180 │ 1 hour │
│ Land Surface Forcings │ │ │ │ 1980-01-01 to │
│ M2I1NXLFO V5.12.4 │ │ │ │ recent │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ MERRA-2 2D, Time-averaged │ 0.5x0.625 │ -90, 90 │ -180, 180 │ 1 hour │
│ Surface Flux Diagnostics │ │ │ │ 1980-01-01 to │
│ M2T1NXFLX V5.12.4 │ │ │ │ recent │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ MERRA-2 2D, Time-averaged │ 0.5x0.625 │ -90, 90 │ -180, 180 │ 1 hour │
│ Land Surface Forcings │ │ │ │ 1980-01-01 to │
│ M2T1NXLFO V5.12.4 │ │ │ │ recent │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ NLDAS Primary Forcing │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 hour │
│ Data NLDAS_FORA0125_H │ │ │ │ 1979-01-01T13 │
│ V2.0 │ │ │ │ till recent │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ NLDAS Noah Land Surface │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 hour │
│ Model NLDAS_NOAH0125_H │ │ │ │ 1979-01-01T13 │
├─V002──────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ Smerge-Noah-CCI root zone │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 day 1979-0- │
│ soil moisture 0-40 cm │ │ │ │ 1-02 to │
│ SMERGE_RZSM0_40CM V2.0 │ │ │ │ recent │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌────────────────────────────────────────────┬───────────────────────────┬──────────┐
│ LDAS "variables" string │ Description │ Units │
╞════════════════════════════════════════════╪═══════════════════════════╪══════════╡
│ GLDAS_NOAH025_3H_2_0_AvgSurfT_inst │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_ESoil_tavg │ Direct evaporation from │ W/m**2 │
│ │ bare soil │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Evap_tavg │ Evapotranspiration │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_LWdown_f_tavg │ Downward long-wave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_PotEvap_tavg │ Potential evaporation │ W/m**2 │
├────────────────────────────────────────────┼─rate──────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Psurf_f_inst │ Surface air pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Qair_f_inst │ Specific humidity │ kg/kg │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Qs_acc │ Storm surface runoff │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Qsb_acc │ Baseflow-groundwater │ mm │
├────────────────────────────────────────────┼─runoff────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Qsm_acc │ Snow melt │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Rainf_f_tavg │ Total precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Rainf_tavg │ Rain precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_RootMoist_inst │ Root zone soil moisture │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Snowf_tavg │ Snow precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi0_10cm_inst │ Soil moisture content │ mm │
│ │ (0-10 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi100_200cm_inst │ Soil moisture content │ mm │
│ │ (100-200 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi10_40cm_inst │ Soil moisture content │ mm │
│ │ (10-40 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi40_100cm_inst │ Soil moisture content │ mm │
│ │ (40-100 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilTMP0_10cm_inst │ Soil temperature (0-10 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilTMP100_200cm_inst │ Soil temperature (100-200 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SoilTMP10_40cm_inst │ Soil temperature (10-40 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_SWdown_f_tavg │ Downward shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Tair_f_inst │ Near surface air │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_0_Wind_f_inst │ Near surface wind speed │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Albedo_inst │ Albedo │ percent │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_AvgSurfT_inst │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_CanopInt_inst │ Plant canopy │ kg/m**2 │
├────────────────────────────────────────────┼─surface_water─────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_ECanop_tavg │ Canopy water evaporation │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_ESoil_tavg │ Soil evaporation │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Evap_tavg │ Evapotranspiration │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_LWdown_f_tavg │ Downward long-wave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Lwnet_tavg │ Net long-wave radiation │ W/m**2 │
│ │ flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_PotEvap_tavg │ Potential evaporation │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Psurf_f_inst │ Surface air pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qair_f_inst │ Specific humidity │ kg/kg │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qg_tavg │ Heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qh_tavg │ Sensible heat net flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qle_tavg │ Latent heat net flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qs_acc │ Storm surface runoff │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qsb_acc │ Baseflow-groundwater │ mm │
├────────────────────────────────────────────┼─runoff────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Qsm_acc │ Snow melt │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Rainf_f_tavg │ Total precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Rainf_tavg │ Rain precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_RootMoist_inst │ Root zone soil moisture │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SnowDepth_inst │ Snow depth │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Snowf_tavg │ Snow precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi0_10cm_inst │ Soil moisture content │ mm │
│ │ (0-10 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi100_200cm_inst │ Soil moisture content │ mm │
│ │ (100-200 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi10_40cm_inst │ Soil moisture content │ mm │
│ │ (10-40 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi40_100cm_inst │ Soil moisture content │ mm │
│ │ (40-100 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP0_10cm_inst │ Soil temperature (0-10 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP100_200cm_inst │ Soil temperature (100-200 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP10_40cm_inst │ Soil temperature (10-40 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP40_100cm_inst │ Soil temperature (40-100 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SWdown_f_tavg │ Downward shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_SWE_inst │ Snow depth water │ mm │
├────────────────────────────────────────────┼─equivalent────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Swnet_tavg │ Net shortwave radiation │ W/m**2 │
│ │ flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Tair_f_inst │ Near surface air │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Tveg_tavg │ Transpiration │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GLDAS_NOAH025_3H_2_1_Wind_f_inst │ Near surface wind speed │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GRACEDADM_CLSM0125US_7D_4_0_gws_inst │ Groundwater storage │ percent │
│ │ percentile │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GRACEDADM_CLSM0125US_7D_4_0_rtzsm_inst │ Root zone soil moisture │ percent │
│ │ percentile │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ GRACEDADM_CLSM0125US_7D_4_0_sfsm_inst │ Surface soil moisture │ percent │
│ │ percentile │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2I1NXLFO_5_12_4_HLML │ Surface layer │ m │
│ │ height:instant │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2I1NXLFO_5_12_4_PS │ Surface pressure:instant │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2I1NXLFO_5_12_4_QLML │ Surface specific │ 1 │
│ │ humidity:instant │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2I1NXLFO_5_12_4_SPEEDLML │ Surface wind │ m/s │
├────────────────────────────────────────────┼─speed:instant─────────────┼──────────┤
│ M2I1NXLFO_5_12_4_TLML │ Surface air temperature │ K │
│ │ over land:instant │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_BSTAR │ Surface buoyancy │ m/s**2 │
│ │ scale:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_CDH │ Surface exchange │ mm/s │
│ │ coefficient for │ │
│ │ heat:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_CDM │ Surface exchange │ mm/s │
│ │ coefficient for │ │
│ │ momentum:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_CDQ │ Surface exchange │ mm/s │
│ │ coefficient for │ │
│ │ moisture:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_CN │ Surface neutral drag │ 1 │
│ │ coefficient:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_DISPH │ Zero plane displacement │ m │
│ │ height:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_EFLUX │ Total latent energy │ W/m**2 │
│ │ flux:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_EVAP │ Evaporation from │ mm/s │
│ │ turbulence:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_FRCAN │ Areal fraction of anvil │ 1 │
│ │ showers:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_FRCCN │ Areal fraction of │ 1 │
│ │ convective showers:avera- │ │
├────────────────────────────────────────────┼─ge────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_FRCLS │ Areal fraction of │ 1 │
│ │ nonanvil large scale │ │
├────────────────────────────────────────────┼─showers:average───────────┼──────────┤
│ M2T1NXFLX_5_12_4_FRSEAICE │ Ice covered fraction of │ 1 │
│ │ tile:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_GHTSKIN │ ground heating for skin │ W/m**2 │
│ │ temp:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_HFLUX │ Sensible heat flux from │ W/m**2 │
│ │ turbulence:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_HLML │ Surface layer │ m │
│ │ height:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_NIRDF │ Surface downwelling │ W/m**2 │
│ │ nearinfrared diffuse │ │
│ │ flux:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_NIRDR │ Surface downwelling │ W/m**2 │
│ │ nearinfrared beam │ │
│ │ flux:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PBLH │ Planetary boundary layer │ m │
│ │ height:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PGENTOT │ total column production │ mm/s │
│ │ of precipitation:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PRECANV │ Anvil precipitation:aver- │ mm/s │
├────────────────────────────────────────────┼─age───────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PRECCON │ Convective precipitation- │ mm/s │
│ │ :average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PRECLSC │ Non-anvil large scale │ mm/s │
│ │ precipitation:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PRECSNO │ Snowfall:average │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PRECTOTCORR │ Total precipitation:aver- │ mm/s │
├────────────────────────────────────────────┼─age───────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PRECTOT │ Total precipitation:aver- │ mm/s │
├────────────────────────────────────────────┼─age───────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_PREVTOT │ total column re-evap/subl │ mm/s │
│ │ of precipitation:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_QLML │ Surface specific │ 1 │
│ │ humidity:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_QSH │ Effective surface │ kg/kg │
│ │ specific humidity:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_QSTAR │ Surface moisture │ kg/kg │
│ │ scale:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_RHOA │ Air density at │ kg/m**3 │
│ │ surface:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_RISFC │ Surface bulk Richardson │ 1 │
│ │ number:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_SPEEDMAX │ Surface wind speed:max │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_SPEED │ Surface wind │ m/s │
├────────────────────────────────────────────┼─speed:average─────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TAUGWX │ Surface eastward gravity │ N/m**2 │
│ │ wave stress:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TAUGWY │ Surface northward gravity │ N/m**2 │
│ │ wave stress:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TAUX │ Eastward surface │ N/m**2 │
│ │ stress:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TAUY │ Northward surface │ N/m**2 │
│ │ stress:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TCZPBL │ Transcom planetary │ m │
│ │ boundary layer │ │
├────────────────────────────────────────────┼─height:average────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TLML │ Surface air temperature:- │ K │
│ │ average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TSH │ Effective surface skin │ K │
│ │ temperature:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_TSTAR │ Surface temperature │ K │
│ │ scale:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_ULML │ Surface eastward │ m/s │
│ │ wind:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_USTAR │ Surface velocity │ m/s │
│ │ scale:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_VLML │ Surface northward │ m/s │
│ │ wind:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_Z0H │ Surface roughness for │ m │
│ │ heat:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXFLX_5_12_4_Z0M │ Surface roughness:average │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_LWGAB │ Surface absorbed longwave │ W/m**2 │
│ │ radiation:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_PARDF │ surface downwelling par │ W/m**2 │
│ │ diffuse flux:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_PARDR │ surface downwelling par │ W/m**2 │
│ │ beam flux:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_PRECCUCORR │ liquid water convective │ mm/s │
│ │ precipitation:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_PRECLSCORR │ liquid water large scale │ mm/s │
│ │ precipitation:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_PRECSNOCORR │ Snowfall:average │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_SWGDN │ Incident shortwave │ W/m**2 │
│ │ radiation land:average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXLFO_5_12_4_SWLAND │ Net shortwave │ W/m**2 │
├────────────────────────────────────────────┼─land:average──────────────┼──────────┤
│ M2T1NXSLV_5_12_4_CLDPRS │ Cloud top pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_CLDTMP │ Cloud top temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_DISPH │ Zero plane displacement │ m │
│ │ height │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_H1000 │ Height at 1000 mb │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_H250 │ Height at 250 hPa │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_H500 │ Height at 500 hPa │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_H850 │ Height at 850 hPa │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_OMEGA500 │ Omega at 500 hPa │ Pa/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_PBLTOP │ Pbltop pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_PS │ Surface pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_Q250 │ Specific humidity at 250 │ kg/kg │
│ │ hPa │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_Q500 │ Specific humidity at 500 │ kg/kg │
│ │ hPa │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_Q850 │ Specific humidity at 850 │ kg/kg │
│ │ hPa │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_QV10M │ 10-meter specific │ kg/kg │
├────────────────────────────────────────────┼─humidity──────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_QV2M │ 2-meter specific humidity │ kg/kg │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_SLP │ Sea level pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T10M │ 10-meter air temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T250 │ Air temperature at 250 │ K │
├────────────────────────────────────────────┼─hPa───────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T2M │ 2-meter air temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T2MDEW │ Dew point temperature at │ K │
│ │ 2 m │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T2MWET │ Wet bulb temperature at 2 │ K │
├────────────────────────────────────────────┼─m─────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T500 │ Air temperature at 500 │ K │
├────────────────────────────────────────────┼─hPa───────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_T850 │ Air temperature at 850 │ K │
├────────────────────────────────────────────┼─hPa───────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TO3 │ Total column ozone │ Dobsons │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TOX │ Total column odd oxygen │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TQI │ Total precipitable ice │ mm │
│ │ water │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TQL │ Total precipitable liquid │ mm │
│ │ water │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TQV │ Total precipitable water │ mm │
│ │ vapor │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TROPPB │ Tropopause pressure based │ Pa │
│ │ on blended estimate │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TROPPT │ Tropopause pressure based │ Pa │
│ │ on thermal estimate │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TROPPV │ Tropopause pressure based │ Pa │
│ │ on EPV estimate │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TROPQ │ Tropopause specific │ kg/kg │
│ │ humidity using blended │ │
│ │ TROPP estimate │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TROPT │ Tropopause temperature │ K │
│ │ using blended TROPP │ │
│ │ estimate │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_TS │ Surface skin temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_U10M │ 10-meter eastward wind │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_U250 │ Eastward wind at 250 hPa │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_U2M │ 2-meter eastward wind │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_U500 │ Eastward wind at 500 hPa │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_U50M │ 50-meter eastward │ m/s │
│ │ wind:time average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_U850 │ Eastward wind at 850 hPa │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_V10M │ 10-meter northward wind │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_V250 │ Northward wind at 250 hPa │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_V2M │ 2-meter northward wind │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_V500 │ Northward wind at 500 hPa │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_V50M │ 50-meter northward │ m/s │
│ │ wind:time average │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_V850 │ Northward wind at 850 hPa │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ M2T1NXSLV_5_12_4_ZLCL │ Lifting condensation │ m │
├────────────────────────────────────────────┼─level─────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_CAPE │ Convective Available │ J/kg │
│ │ Potential Energy │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_CRainf_frac │ Fraction of total │ fraction │
│ │ precipitation that is │ │
│ │ convective │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_LWdown │ Surface DW longwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_PotEvap │ Potential evaporation │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_PSurf │ Surface pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Qair │ 2-m above ground specific │ kg/kg │
│ │ humidity │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Rainf │ Precipitation hourly │ mm │
├────────────────────────────────────────────┼─total─────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_SWdown │ Surface DW shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Tair │ 2-m above ground │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Wind_E │ 10-m above ground zonal │ m/s │
│ │ wind │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Wind_N │ 10-m above ground │ m/s │
│ │ meridional wind │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_ACond │ Aerodynamic conductance │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Albedo │ Surface albedo │ percent │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_AvgSurfT │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_CanopInt │ Plant canopy surface │ kg/m**2 │
├────────────────────────────────────────────┼─water─────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_CCond │ Canopy conductance │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_ECanop │ Canopy water evaporation │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_ESoil │ Direct evaporation from │ W/m**2 │
│ │ bare soil │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Evap │ Total evapotranspiration │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_GVEG │ Green vegetation │ fraction │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_LAI │ Leaf Area Index │ unitless │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_LWdown │ Longwave radiation flux │ W/m**2 │
│ │ downwards (surface) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_LWnet │ Net longwave radiation │ W/m**2 │
│ │ flux (surface) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qf │ Snow phase-change heat │ W/m**2 │
├────────────────────────────────────────────┼─flux──────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qg │ Ground heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qh │ Sensible heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qle │ Latent heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qsb │ Subsurface runoff │ mm │
│ │ (baseflow) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qsm │ Snowmelt │ kg/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Qs │ Surface runoff (non- │ mm │
│ │ infiltrating) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Rainf │ Liquid precipitation │ kg/m**2 │
│ │ (rainfall) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SMAvail_0_200cm │ Soil moisture │ percent │
│ │ availability (0-200cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SMAvail_0_40cm │ Soil moisture │ percent │
│ │ availability (0-40cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SnowDepth │ Snow depth │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Snowf │ Frozen precipitation │ kg/m**2 │
│ │ (snowfall) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SnowFrac │ Snow cover │ fraction │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilM_0_100cm │ 0-100 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilM_0_10cm │ 0-10 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilM_0_200cm │ 0-200 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilM_0_40cm │ Soil moisture content │ kg/m**2 │
│ │ (0-40cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilM_10_40cm │ 10-40 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilM_40_200cm │ 40-200 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SoilT │ Soil temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_Streamflow │ Streamflow │ m**3/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SubSnow │ Sublimation (evaporation │ W/m**2 │
│ │ from snow) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SWdown │ Shortwave radiation flux │ W/m**2 │
│ │ downwards (surface) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SWE │ Snow Water Equivalent │ kg/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_SWnet │ Net shortwave radiation │ W/m**2 │
│ │ flux (surface) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_MOS0125_H_2_0_TVeg │ Transpiration │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_ACond │ Aerodynamic conductance │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Albedo │ Surface albedo │ percent │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_AvgSurfT │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_CanopInt │ Plant canopy surface │ mm │
├────────────────────────────────────────────┼─water─────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_CCond │ Canopy conductance │ m/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_ECanop │ Canopy water evaporation │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_ESoil │ Direct evaporation from │ W/m**2 │
│ │ bare soil │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Evap │ Total evapotranspiration │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_GVEG │ Green vegetation │ fraction │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_LAI │ Leaf Area Index │ unitless │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_LWdown │ Surface downwards │ W/m**2 │
│ │ longwave radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_LWnet │ Surface net longwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_PotEvap │ Potential evapotranspira- │ W/m**2 │
│ │ tion │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qf │ Snow phase-change heat │ W/m**2 │
├────────────────────────────────────────────┼─flux──────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qg │ Ground heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qh │ Sensible heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qle │ Latent heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qsb │ Subsurface runoff │ mm │
│ │ (baseflow) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qsm │ Snowmelt │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qs │ Surface runoff (non- │ mm │
│ │ infiltrating) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Rainf │ Liquid precipitation │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCQ │ Humidity parameter in │ fraction │
│ │ canopy conductance │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCSOL │ Soil moisture parameter │ fraction │
│ │ in canopy conductance │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCS │ Solar parameter in canopy │ fraction │
│ │ conductance │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCT │ Temperature parameter in │ fraction │
│ │ canopy conductance │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RootMoist │ Root zone soil moisture │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RSMacr │ Relative soil moisture │ fraction │
│ │ availability control │ │
├────────────────────────────────────────────┼─factor────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RSmin │ Minimal stomatal │ s/m │
├────────────────────────────────────────────┼─resistance────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMAvail_0_100cm │ Soil moisture │ percent │
│ │ availability (0-100cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMAvail_0_200cm │ Soil moisture │ percent │
│ │ availability (0-200cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_0_10cm │ Liquid soil moisture │ mm │
│ │ content (0-10cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_100_200cm │ Liquid soil moisture │ mm │
│ │ content (100-200cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_10_40cm │ Liquid soil moisture │ mm │
│ │ content (10-40cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_40_100cm │ Liquid soil moisture │ mm │
│ │ content (40-100cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SnowDepth │ Snow depth │ m │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Snowf │ Frozen precipitation │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SnowFrac │ Snow cover │ fraction │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_0_100cm │ 0-100 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_0_10cm │ 0-10 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_0_200cm │ 0-200 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_100_200cm │ 100-200 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_10_40cm │ 10-40 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_40_100cm │ 40-100 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_0_10cm │ 0-10 cm soil temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_100_200cm │ 100-200 cm soil │ K │
├────────────────────────────────────────────┼─temperature───────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_10_40cm │ 10-40 cm soil temperature │ K │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_40_100cm │ 40-100 cm soil │ K │
├────────────────────────────────────────────┼─temperature───────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Streamflow │ Streamflow │ m**3/s │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SubSnow │ Sublimation (evaporation │ W/m**2 │
│ │ from snow) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SWdown │ Surface downwards │ W/m**2 │
│ │ shortwave radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SWE │ Snow Water Equivalent │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SWnet │ Surface net shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_TVeg │ Transpiration │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_Evap │ Total evapotranspiration │ mm │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_Qg │ Ground heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_Qh │ Sensible heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_Qle │ Latent heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_Qsb │ Subsurface runoff │ mm │
│ │ (baseflow) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_Qs │ Surface runoff (non- │ mm │
│ │ infiltrating) │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_0_100cm │ 0-100 cm soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_layer1 │ VIC layer 1 soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_layer2 │ VIC layer 2 soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_layer3 │ VIC layer 3 soil moisture │ mm │
│ │ content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_total │ VIC total column depth │ mm │
│ │ soil moisture content │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilT_layer1 │ VIC layer 1 soil │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilT_layer2 │ VIC layer 3 soil │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_VIC0125_H_2_0_SoilT_layer3 │ VIC layer 3 soil │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ SMERGE_RZSM0_40CM_2_0_CCI_ano │ CCI soil moisture │ m3/m3 │
│ │ anomalies 0-40 cm │ │
├────────────────────────────────────────────┼───────────────────────────┼──────────┤
│ SMERGE_RZSM0_40CM_2_0_RZSM │ Average soil moisture of │ m3/m3 │
│ │ 0-40 cm layer │ │
╘════════════════════════════════════════════╧═══════════════════════════╧══════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_gldas_noah#
$ tsgettoolbox ldas_gldas_noah --help
usage: tsgettoolbox ldas_gldas_noah [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
GLDAS Version 2.1 (GLDAS-2.1) Forcing Data Sets
The GLDAS-2.1 simulations were forced with National Oceanic and Atmospheric
Administration (NOAA)/Global Data Assimilation System (GDAS) atmospheric
analysis fields (Derber et al., 1991), the disaggregated Global Precipitation
Climatology Project (GPCP) V1.3 Daily Analysis precipitation fields (Adler et
al., 2003; Huffman et al., 2001), and the Air Force Weather Agency’s
AGRicultural METeorological modeling system (AGRMET) radiation fields. The
simulation was only used with GDAS and GPCP from January 2000 to February 2001,
followed by the addition of AGRMET from March 1, 2001 onwards.
For more information on GLDAS forcing, please visit
<[4;36mhttps://ldas.gsfc.nasa.gov/gldas/forcing-data[0m>.
Noah is National Centers for Environmental Prediction/Oregon State
University/Air Force/Hydrologic Research Lab (Noah) Model
The community Noah LSM was developed beginning in 1993 through a collaboration
of investigators from public and private institutions, spearheaded by the
National Centers for Environmental Prediction. Current development efforts are
consistent with the land surface scheme in Weather Research Forecast (WRF)
system, under the Unified Noah LSM (Chen et al. 1996; Chen et al. 1997; Koren et
al. 1999; Chen et al. 2001; Ek et al. 2003). Noah is a stand-alone, 1-D column
model which can be executed in either coupled or uncoupled mode. The model
applies finite-difference spatial discretization methods and a Crank-Nicholson
time-integration scheme to numerically integrate the governing equations of the
physical processes of the soil-vegetation-snowpack medium. Noah has been used
operationally in NCEP models since 1996, and it continues to be developed at the
University Corporation for Atmospheric Research and National Center for
Atmospheric Research, Research Application Laboratory. For more information, go
to: <[4;36mhttps://ral.ucar.edu/model/unified-noah-lsm[0m>.
Adler, R.F., G.J. Huffman, A. Chang, R. Ferraro, P. Xie, J. Janowiak, B. Rudolf,
U. Schneider, S. Curtis, D. Bolvin, A. Gruber, J. Susskind, P. Arkin, E. Nelkin
2003: The Version 2 Global Precipitation Climatology Project (GPCP) Monthly
Precipitation Analysis (1979-Present). J. Hydrometeor., 4,1147-1167.
Berg, A. A., J. S. Famiglietti, J. P. Walker, and P. R. Houser, 2003: Impact of
bias correction to reanalysis products on simulations of North American soil
moisture and hydrological fluxes, J. Geophys. Res, 108 (D16), 4490.
Chen, F., K. Mitchell, J. Schaake, Y. Xue, H. Pan, V. Koren, Y. Duan, M. Ek, and
A. Betts, Modeling of land-surface evaporation by four schemes and comparison
with FIFE observations, J. Geophys. Res.,101 (D3), 7251-7268, 1996.
Chen, F., Z. Janjic, and K. Mitchell, Impact of atmospheric surface layer
parameterization in the new land-surface scheme of the NCEP Mesoscale Eta
numerical model, Bound.-Layer Meteor., 185, 391-421, 1997.
Chen, F. and J.Dudhia, Coupling an Advanced Land Surface-Hydrology Model with
the Penn State-NCAR MM5 Modeling System. Part I: Model Implementation and
Sensitivity, Mon. Wea. Rev., 129, 569-585, 2001.
Derber, J. C., D. F. Parrish, and S. J. Lord, 1991: The new global operational
analysis system at the National Meteorological Center. Weather Forecasting, 6,
538-547.
Ek, M. B., K. E. Mitchell, Y. Lin, E. Rogers, P. Grunmann, V. Koren, G. Gayno,
and J. D. Tarpley, Implementation of Noah land surface model advances in the
National Centers for Environmental Prediction operational mesoscale Eta model,
J. Geophys. Res., 108(D22), 8851, doi:10.1029/2002JD003296, 2003.
Koren, V., J. Schaake, K. Mitchell, Q. Y. Duan, F. Chen, and J. M. Baker, A
parameterization of snowpack and frozen ground intended for NCEP weather and
climate models, J. Geophys. Res.,104, 19569-19585, 1999.
Sheffield, J., G. Goteti, and E. F. Wood, 2006: Development of a 50-yr
high-resolution global dataset of meteorological forcings for land surface
modeling, J. Climate, 19 (13), 3088-3111.
Xie P., and P. A. Arkin, 1996: Global precipitation: a 17-year monthly analysis
based on gauge observations, satellite estimates, and numerical model outputs.
Bull. Amer. Meteor. Soc., 78, 2539-2558.
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ GLDAS Noah Land Surface │ 0.25x0.25 │ -60, 90 │ -180, 180 │ 3 hour │
│ Model GLDAS_NOAH025_3H │ │ │ │ 2000-01-01 to │
│ V2.1 │ │ │ │ present │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌────────────────────────────────────────────┬───────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞════════════════════════════════════════════╪═══════════════════════════╪═════════╡
│ GLDAS_NOAH025_3H_2_1_Albedo_inst │ Albedo │ percent │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_AvgSurfT_inst │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_CanopInt_inst │ Plant canopy │ kg/m**2 │
├────────────────────────────────────────────┼─surface_water─────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_ECanop_tavg │ Canopy water evaporation │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_ESoil_tavg │ Soil evaporation │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Evap_tavg │ Evapotranspiration │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_LWdown_f_tavg │ Downward long-wave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Lwnet_tavg │ Net long-wave radiation │ W/m**2 │
│ │ flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_PotEvap_tavg │ Potential evaporation │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Psurf_f_inst │ Surface air pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qair_f_inst │ Specific humidity │ kg/kg │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qg_tavg │ Heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qh_tavg │ Sensible heat net flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qle_tavg │ Latent heat net flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qs_acc │ Storm surface runoff │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qsb_acc │ Baseflow-groundwater │ mm │
├────────────────────────────────────────────┼─runoff────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qsm_acc │ Snow melt │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Rainf_f_tavg │ Total precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Rainf_tavg │ Rain precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_RootMoist_inst │ Root zone soil moisture │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SnowDepth_inst │ Snow depth │ m │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Snowf_tavg │ Snow precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi0_10cm_inst │ Soil moisture content │ mm │
│ │ (0-10 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi100_200cm_inst │ Soil moisture content │ mm │
│ │ (100-200 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi10_40cm_inst │ Soil moisture content │ mm │
│ │ (10-40 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi40_100cm_inst │ Soil moisture content │ mm │
│ │ (40-100 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP0_10cm_inst │ Soil temperature (0-10 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP100_200cm_inst │ Soil temperature (100-200 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP10_40cm_inst │ Soil temperature (10-40 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP40_100cm_inst │ Soil temperature (40-100 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SWdown_f_tavg │ Downward shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SWE_inst │ Snow depth water │ mm │
├────────────────────────────────────────────┼─equivalent────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Swnet_tavg │ Net shortwave radiation │ W/m**2 │
│ │ flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Tair_f_inst │ Near surface air │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Tveg_tavg │ Transpiration │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Wind_f_inst │ Near surface wind speed │ m/s │
╘════════════════════════════════════════════╧═══════════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_gldas_noah_v2_0#
$ tsgettoolbox ldas_gldas_noah_v2_0 --help
usage: tsgettoolbox ldas_gldas_noah_v2_0 [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
GLDAS Version 2.0 (GLDAS-2.0) Forcing Data Sets
The GLDAS-2.0 simulations were forced with the Global Meteorological Forcing
Data set from Princeton University [Sheffield et al., 2006] from 1948 to 2014.
For more information on GLDAS forcing, please visit
<[4;36mhttps://ldas.gsfc.nasa.gov/gldas/forcing-data[0m>.
Noah is National Centers for Environmental Prediction/Oregon State
University/Air Force/Hydrologic Research Lab (Noah) Model
The community Noah LSM was developed beginning in 1993 through a collaboration
of investigators from public and private institutions, spearheaded by the
National Centers for Environmental Prediction. Current development efforts are
consistent with the land surface scheme in Weather Research Forecast (WRF)
system, under the Unified Noah LSM (Chen et al. 1996; Chen et al. 1997; Koren et
al. 1999; Chen et al. 2001; Ek et al. 2003). Noah is a stand-alone, 1-D column
model which can be executed in either coupled or uncoupled mode. The model
applies finite-difference spatial discretization methods and a Crank-Nicholson
time-integration scheme to numerically integrate the governing equations of the
physical processes of the soil-vegetation-snowpack medium. Noah has been used
operationally in NCEP models since 1996, and it continues to be developed at the
University Corporation for Atmospheric Research and National Center for
Atmospheric Research, Research Application Laboratory. For more information, go
to: <[4;36mhttps://ral.ucar.edu/model/unified-noah-lsm[0m>.
Adler, R.F., G.J. Huffman, A. Chang, R. Ferraro, P. Xie, J. Janowiak, B. Rudolf,
U. Schneider, S. Curtis, D. Bolvin, A. Gruber, J. Susskind, P. Arkin, E. Nelkin
2003: The Version 2 Global Precipitation Climatology Project (GPCP) Monthly
Precipitation Analysis (1979-Present). J. Hydrometeor., 4,1147-1167.
Berg, A. A., J. S. Famiglietti, J. P. Walker, and P. R. Houser, 2003: Impact of
bias correction to reanalysis products on simulations of North American soil
moisture and hydrological fluxes, J. Geophys. Res, 108 (D16), 4490.
Chen, F., K. Mitchell, J. Schaake, Y. Xue, H. Pan, V. Koren, Y. Duan, M. Ek, and
A. Betts, Modeling of land-surface evaporation by four schemes and comparison
with FIFE observations, J. Geophys. Res.,101 (D3), 7251-7268, 1996.
Chen, F., Z. Janjic, and K. Mitchell, Impact of atmospheric surface layer
parameterization in the new land-surface scheme of the NCEP Mesoscale Eta
numerical model, Bound.-Layer Meteor., 185, 391-421, 1997.
Chen, F. and J.Dudhia, Coupling an Advanced Land Surface-Hydrology Model with
the Penn State-NCAR MM5 Modeling System. Part I: Model Implementation and
Sensitivity, Mon. Wea. Rev., 129, 569-585, 2001.
Derber, J. C., D. F. Parrish, and S. J. Lord, 1991: The new global operational
analysis system at the National Meteorological Center. Weather Forecasting, 6,
538-547.
Ek, M. B., K. E. Mitchell, Y. Lin, E. Rogers, P. Grunmann, V. Koren, G. Gayno,
and J. D. Tarpley, Implementation of Noah land surface model advances in the
National Centers for Environmental Prediction operational mesoscale Eta model,
J. Geophys. Res., 108(D22), 8851, doi:10.1029/2002JD003296, 2003.
Koren, V., J. Schaake, K. Mitchell, Q. Y. Duan, F. Chen, and J. M. Baker, A
parameterization of snowpack and frozen ground intended for NCEP weather and
climate models, J. Geophys. Res.,104, 19569-19585, 1999.
Sheffield, J., G. Goteti, and E. F. Wood, 2006: Development of a 50-yr
high-resolution global dataset of meteorological forcings for land surface
modeling, J. Climate, 19 (13), 3088-3111.
Xie P., and P. A. Arkin, 1996: Global precipitation: a 17-year monthly analysis
based on gauge observations, satellite estimates, and numerical model outputs.
Bull. Amer. Meteor. Soc., 78, 2539-2558.
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ GLDAS Noah Land Surface │ 0.25x0.25 │ -60, 90 │ -180, 180 │ 3 hour │
│ Model GLDAS_NOAH025_3H │ │ │ │ 1948-01-01 to │
│ V2.0 │ │ │ │ 2014-12-31 │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌────────────────────────────────────────────┬───────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞════════════════════════════════════════════╪═══════════════════════════╪═════════╡
│ GLDAS_NOAH025_3H_2_0_AvgSurfT_inst │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_ESoil_tavg │ Direct evaporation from │ W/m**2 │
│ │ bare soil │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Evap_tavg │ Evapotranspiration │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_LWdown_f_tavg │ Downward long-wave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_PotEvap_tavg │ Potential evaporation │ W/m**2 │
├────────────────────────────────────────────┼─rate──────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Psurf_f_inst │ Surface air pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Qair_f_inst │ Specific humidity │ kg/kg │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Qs_acc │ Storm surface runoff │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Qsb_acc │ Baseflow-groundwater │ mm │
├────────────────────────────────────────────┼─runoff────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Qsm_acc │ Snow melt │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Rainf_f_tavg │ Total precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Rainf_tavg │ Rain precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_RootMoist_inst │ Root zone soil moisture │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Snowf_tavg │ Snow precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi0_10cm_inst │ Soil moisture content │ mm │
│ │ (0-10 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi100_200cm_inst │ Soil moisture content │ mm │
│ │ (100-200 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi10_40cm_inst │ Soil moisture content │ mm │
│ │ (10-40 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilMoi40_100cm_inst │ Soil moisture content │ mm │
│ │ (40-100 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilTMP0_10cm_inst │ Soil temperature (0-10 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilTMP100_200cm_inst │ Soil temperature (100-200 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SoilTMP10_40cm_inst │ Soil temperature (10-40 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_SWdown_f_tavg │ Downward shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Tair_f_inst │ Near surface air │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_0_Wind_f_inst │ Near surface wind speed │ m/s │
╘════════════════════════════════════════════╧═══════════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_gldas_noah_v2_1#
$ tsgettoolbox ldas_gldas_noah_v2_1 --help
usage: tsgettoolbox ldas_gldas_noah_v2_1 [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
GLDAS Version 2.1 (GLDAS-2.1) Forcing Data Sets
The GLDAS-2.1 simulations were forced with National Oceanic and Atmospheric
Administration (NOAA)/Global Data Assimilation System (GDAS) atmospheric
analysis fields (Derber et al., 1991), the disaggregated Global Precipitation
Climatology Project (GPCP) V1.3 Daily Analysis precipitation fields (Adler et
al., 2003; Huffman et al., 2001), and the Air Force Weather Agency’s
AGRicultural METeorological modeling system (AGRMET) radiation fields. The
simulation was only used with GDAS and GPCP from January 2000 to February 2001,
followed by the addition of AGRMET from March 1, 2001 onwards.
For more information on GLDAS forcing, please visit
<[4;36mhttps://ldas.gsfc.nasa.gov/gldas/forcing-data[0m>.
Noah is National Centers for Environmental Prediction/Oregon State
University/Air Force/Hydrologic Research Lab (Noah) Model
The community Noah LSM was developed beginning in 1993 through a collaboration
of investigators from public and private institutions, spearheaded by the
National Centers for Environmental Prediction. Current development efforts are
consistent with the land surface scheme in Weather Research Forecast (WRF)
system, under the Unified Noah LSM (Chen et al. 1996; Chen et al. 1997; Koren et
al. 1999; Chen et al. 2001; Ek et al. 2003). Noah is a stand-alone, 1-D column
model which can be executed in either coupled or uncoupled mode. The model
applies finite-difference spatial discretization methods and a Crank-Nicholson
time-integration scheme to numerically integrate the governing equations of the
physical processes of the soil-vegetation-snowpack medium. Noah has been used
operationally in NCEP models since 1996, and it continues to be developed at the
University Corporation for Atmospheric Research and National Center for
Atmospheric Research, Research Application Laboratory. For more information, go
to: <[4;36mhttps://ral.ucar.edu/model/unified-noah-lsm[0m>.
Adler, R.F., G.J. Huffman, A. Chang, R. Ferraro, P. Xie, J. Janowiak, B. Rudolf,
U. Schneider, S. Curtis, D. Bolvin, A. Gruber, J. Susskind, P. Arkin, E. Nelkin
2003: The Version 2 Global Precipitation Climatology Project (GPCP) Monthly
Precipitation Analysis (1979-Present). J. Hydrometeor., 4,1147-1167.
Berg, A. A., J. S. Famiglietti, J. P. Walker, and P. R. Houser, 2003: Impact of
bias correction to reanalysis products on simulations of North American soil
moisture and hydrological fluxes, J. Geophys. Res, 108 (D16), 4490.
Chen, F., K. Mitchell, J. Schaake, Y. Xue, H. Pan, V. Koren, Y. Duan, M. Ek, and
A. Betts, Modeling of land-surface evaporation by four schemes and comparison
with FIFE observations, J. Geophys. Res.,101 (D3), 7251-7268, 1996.
Chen, F., Z. Janjic, and K. Mitchell, Impact of atmospheric surface layer
parameterization in the new land-surface scheme of the NCEP Mesoscale Eta
numerical model, Bound.-Layer Meteor., 185, 391-421, 1997.
Chen, F. and J.Dudhia, Coupling an Advanced Land Surface-Hydrology Model with
the Penn State-NCAR MM5 Modeling System. Part I: Model Implementation and
Sensitivity, Mon. Wea. Rev., 129, 569-585, 2001.
Derber, J. C., D. F. Parrish, and S. J. Lord, 1991: The new global operational
analysis system at the National Meteorological Center. Weather Forecasting, 6,
538-547.
Ek, M. B., K. E. Mitchell, Y. Lin, E. Rogers, P. Grunmann, V. Koren, G. Gayno,
and J. D. Tarpley, Implementation of Noah land surface model advances in the
National Centers for Environmental Prediction operational mesoscale Eta model,
J. Geophys. Res., 108(D22), 8851, doi:10.1029/2002JD003296, 2003.
Koren, V., J. Schaake, K. Mitchell, Q. Y. Duan, F. Chen, and J. M. Baker, A
parameterization of snowpack and frozen ground intended for NCEP weather and
climate models, J. Geophys. Res.,104, 19569-19585, 1999.
Sheffield, J., G. Goteti, and E. F. Wood, 2006: Development of a 50-yr
high-resolution global dataset of meteorological forcings for land surface
modeling, J. Climate, 19 (13), 3088-3111.
Xie P., and P. A. Arkin, 1996: Global precipitation: a 17-year monthly analysis
based on gauge observations, satellite estimates, and numerical model outputs.
Bull. Amer. Meteor. Soc., 78, 2539-2558.
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ GLDAS Noah Land Surface │ 0.25x0.25 │ -60, 90 │ -180, 180 │ 3 hour │
│ Model GLDAS_NOAH025_3H │ │ │ │ 2000-01-01 to │
│ V2.1 │ │ │ │ present │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌────────────────────────────────────────────┬───────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞════════════════════════════════════════════╪═══════════════════════════╪═════════╡
│ GLDAS_NOAH025_3H_2_1_Albedo_inst │ Albedo │ percent │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_AvgSurfT_inst │ Average surface skin │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_CanopInt_inst │ Plant canopy │ kg/m**2 │
├────────────────────────────────────────────┼─surface_water─────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_ECanop_tavg │ Canopy water evaporation │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_ESoil_tavg │ Soil evaporation │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Evap_tavg │ Evapotranspiration │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_LWdown_f_tavg │ Downward long-wave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Lwnet_tavg │ Net long-wave radiation │ W/m**2 │
│ │ flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_PotEvap_tavg │ Potential evaporation │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Psurf_f_inst │ Surface air pressure │ Pa │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qair_f_inst │ Specific humidity │ kg/kg │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qg_tavg │ Heat flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qh_tavg │ Sensible heat net flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qle_tavg │ Latent heat net flux │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qs_acc │ Storm surface runoff │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qsb_acc │ Baseflow-groundwater │ mm │
├────────────────────────────────────────────┼─runoff────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Qsm_acc │ Snow melt │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Rainf_f_tavg │ Total precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Rainf_tavg │ Rain precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_RootMoist_inst │ Root zone soil moisture │ mm │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SnowDepth_inst │ Snow depth │ m │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Snowf_tavg │ Snow precipitation rate │ mm/s │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi0_10cm_inst │ Soil moisture content │ mm │
│ │ (0-10 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi100_200cm_inst │ Soil moisture content │ mm │
│ │ (100-200 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi10_40cm_inst │ Soil moisture content │ mm │
│ │ (10-40 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilMoi40_100cm_inst │ Soil moisture content │ mm │
│ │ (40-100 cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP0_10cm_inst │ Soil temperature (0-10 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP100_200cm_inst │ Soil temperature (100-200 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP10_40cm_inst │ Soil temperature (10-40 │ K │
├────────────────────────────────────────────┼─cm)───────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SoilTMP40_100cm_inst │ Soil temperature (40-100 │ K │
│ │ cm) │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SWdown_f_tavg │ Downward shortwave │ W/m**2 │
│ │ radiation flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_SWE_inst │ Snow depth water │ mm │
├────────────────────────────────────────────┼─equivalent────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Swnet_tavg │ Net shortwave radiation │ W/m**2 │
│ │ flux │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Tair_f_inst │ Near surface air │ K │
│ │ temperature │ │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Tveg_tavg │ Transpiration │ W/m**2 │
├────────────────────────────────────────────┼───────────────────────────┼─────────┤
│ GLDAS_NOAH025_3H_2_1_Wind_f_inst │ Near surface wind speed │ m/s │
╘════════════════════════════════════════════╧═══════════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_grace#
$ tsgettoolbox ldas_grace --help
usage: tsgettoolbox ldas_grace [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
The Gravity Recovery and Climate Experiment (GRACE) twin satellites, which
orbited Earth from 2002 to 2017, made detailed measurements of Earth's gravity
field and improved investigations about Earth's water reservoirs, over land, ice
and oceans.
GRACE measured gravity by relating it to the distance between the two
satellites. When there was an increase in gravity ahead of the pair, the front
satellite sped up and the distance between the pair increased. When the
increased gravity was between the pair, their distance decreased; the opposite
occurred when there was decreased gravity ahead of, or between, the satellite
pair.
The satellites were separated by 220 km, and they could detect changes smaller
than a micrometer per second in relative velocity. These measurements, in
conjunction with other data and models, provided observations of terrestrial
water storage changes, ice-mass variations, ocean bottom pressure changes and
sea-level variations.
GRACE was a collaboration of the US and German space agencies (NASA and DLR).
The key partners were the University of Texas Center for Space Research (CSR),
the GeoForschungsZentrum (GFZ) Potsdam, and the Jet Propulsion Laboratory (JPL).
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ Groundwater and Soil │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 7 day 2002-1- │
│ Moisture Conditions from │ │ │ │ 0-04 to │
│ GRACE Data Assimilation │ │ │ │ recent │
│ GRACEDADM_CLSM0125US_7D │ │ │ │ │
│ V4.0 │ │ │ │ │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌────────────────────────────────────────┬─────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞════════════════════════════════════════╪═════════════════════════╪═════════╡
│ GRACEDADM_CLSM0125US_7D_4_0_gws_inst │ Groundwater storage │ percent │
│ │ percentile │ │
├────────────────────────────────────────┼─────────────────────────┼─────────┤
│ GRACEDADM_CLSM0125US_7D_4_0_rtzsm_inst │ Root zone soil moisture │ percent │
│ │ percentile │ │
├────────────────────────────────────────┼─────────────────────────┼─────────┤
│ GRACEDADM_CLSM0125US_7D_4_0_sfsm_inst │ Surface soil moisture │ percent │
│ │ percentile │ │
╘════════════════════════════════════════╧═════════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_merra#
$ tsgettoolbox ldas_merra --help
usage: tsgettoolbox ldas_merra [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
The Modern-Era Retrospective analysis for Research and Applications, Version 2
(MERRA-2) provides data beginning in 1980. It was introduced to replace the
original MERRA dataset because of the advances made in the assimilation system
that enable assimilation of modern hyperspectral radiance and microwave
observations, along with GPS-Radio Occultation datasets. It also uses NASA's
ozone profile observations that began in late 2004. Additional advances in both
the GEOS model and the GSI assimilation system are included in MERRA-2. Spatial
resolution remains about the same (about 50 km in the latitudinal direction) as
in MERRA. Along with the enhancements in the meteorological assimilation,
MERRA-2 takes some significant steps towards GMAO’s target of an Earth System
reanalysis. MERRA-2 is the first long-term global reanalysis to assimilate
space-based observations of aerosols and represent their interactions with other
physical processes in the climate system. MERRA-2 includes a representation of
ice sheets over (say) Greenland and Antarctica.
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ MERRA-2 2D, Instantaneous │ 0.5x0.625 │ -90, 90 │ -180, 180 │ 1 hour │
│ Land Surface Forcings │ │ │ │ 1980-01-01 to │
│ M2I1NXLFO V5.12.4 │ │ │ │ recent │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ MERRA-2 2D, Time-averaged │ 0.5x0.625 │ -90, 90 │ -180, 180 │ 1 hour │
│ Surface Flux Diagnostics │ │ │ │ 1980-01-01 to │
│ M2T1NXFLX V5.12.4 │ │ │ │ recent │
├───────────────────────────┼─────────────┼───────────┼───────────┼───────────────┤
│ MERRA-2 2D, Time-averaged │ 0.5x0.625 │ -90, 90 │ -180, 180 │ 1 hour │
│ Land Surface Forcings │ │ │ │ 1980-01-01 to │
│ M2T1NXLFO V5.12.4 │ │ │ │ recent │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌──────────────────────────────┬───────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞══════════════════════════════╪═══════════════════════════╪═════════╡
│ M2I1NXLFO_5_12_4_HLML │ Surface layer │ m │
│ │ height:instant │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2I1NXLFO_5_12_4_PS │ Surface pressure:instant │ Pa │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2I1NXLFO_5_12_4_QLML │ Surface specific │ 1 │
│ │ humidity:instant │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2I1NXLFO_5_12_4_SPEEDLML │ Surface wind │ m/s │
├──────────────────────────────┼─speed:instant─────────────┼─────────┤
│ M2I1NXLFO_5_12_4_TLML │ Surface air temperature │ K │
│ │ over land:instant │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_BSTAR │ Surface buoyancy │ m/s**2 │
│ │ scale:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_CDH │ Surface exchange │ mm/s │
│ │ coefficient for │ │
│ │ heat:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_CDM │ Surface exchange │ mm/s │
│ │ coefficient for │ │
│ │ momentum:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_CDQ │ Surface exchange │ mm/s │
│ │ coefficient for │ │
│ │ moisture:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_CN │ Surface neutral drag │ 1 │
│ │ coefficient:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_DISPH │ Zero plane displacement │ m │
│ │ height:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_EFLUX │ Total latent energy │ W/m**2 │
│ │ flux:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_EVAP │ Evaporation from │ mm/s │
│ │ turbulence:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_FRCAN │ Areal fraction of anvil │ 1 │
│ │ showers:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_FRCCN │ Areal fraction of │ 1 │
│ │ convective showers:avera- │ │
├──────────────────────────────┼─ge────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_FRCLS │ Areal fraction of │ 1 │
│ │ nonanvil large scale │ │
├──────────────────────────────┼─showers:average───────────┼─────────┤
│ M2T1NXFLX_5_12_4_FRSEAICE │ Ice covered fraction of │ 1 │
│ │ tile:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_GHTSKIN │ ground heating for skin │ W/m**2 │
│ │ temp:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_HFLUX │ Sensible heat flux from │ W/m**2 │
│ │ turbulence:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_HLML │ Surface layer │ m │
│ │ height:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_NIRDF │ Surface downwelling │ W/m**2 │
│ │ nearinfrared diffuse │ │
│ │ flux:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_NIRDR │ Surface downwelling │ W/m**2 │
│ │ nearinfrared beam │ │
│ │ flux:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PBLH │ Planetary boundary layer │ m │
│ │ height:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PGENTOT │ total column production │ mm/s │
│ │ of precipitation:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PRECANV │ Anvil precipitation:aver- │ mm/s │
├──────────────────────────────┼─age───────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PRECCON │ Convective precipitation- │ mm/s │
│ │ :average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PRECLSC │ Non-anvil large scale │ mm/s │
│ │ precipitation:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PRECSNO │ Snowfall:average │ mm/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PRECTOTCORR │ Total precipitation:aver- │ mm/s │
├──────────────────────────────┼─age───────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PRECTOT │ Total precipitation:aver- │ mm/s │
├──────────────────────────────┼─age───────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_PREVTOT │ total column re-evap/subl │ mm/s │
│ │ of precipitation:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_QLML │ Surface specific │ 1 │
│ │ humidity:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_QSH │ Effective surface │ kg/kg │
│ │ specific humidity:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_QSTAR │ Surface moisture │ kg/kg │
│ │ scale:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_RHOA │ Air density at │ kg/m**3 │
│ │ surface:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_RISFC │ Surface bulk Richardson │ 1 │
│ │ number:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_SPEEDMAX │ Surface wind speed:max │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_SPEED │ Surface wind │ m/s │
├──────────────────────────────┼─speed:average─────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TAUGWX │ Surface eastward gravity │ N/m**2 │
│ │ wave stress:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TAUGWY │ Surface northward gravity │ N/m**2 │
│ │ wave stress:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TAUX │ Eastward surface │ N/m**2 │
│ │ stress:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TAUY │ Northward surface │ N/m**2 │
│ │ stress:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TCZPBL │ Transcom planetary │ m │
│ │ boundary layer │ │
├──────────────────────────────┼─height:average────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TLML │ Surface air temperature:- │ K │
│ │ average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TSH │ Effective surface skin │ K │
│ │ temperature:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_TSTAR │ Surface temperature │ K │
│ │ scale:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_ULML │ Surface eastward │ m/s │
│ │ wind:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_USTAR │ Surface velocity │ m/s │
│ │ scale:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_VLML │ Surface northward │ m/s │
│ │ wind:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_Z0H │ Surface roughness for │ m │
│ │ heat:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXFLX_5_12_4_Z0M │ Surface roughness:average │ m │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_LWGAB │ Surface absorbed longwave │ W/m**2 │
│ │ radiation:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_PARDF │ surface downwelling par │ W/m**2 │
│ │ diffuse flux:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_PARDR │ surface downwelling par │ W/m**2 │
│ │ beam flux:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_PRECCUCORR │ liquid water convective │ mm/s │
│ │ precipitation:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_PRECLSCORR │ liquid water large scale │ mm/s │
│ │ precipitation:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_PRECSNOCORR │ Snowfall:average │ mm/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_SWGDN │ Incident shortwave │ W/m**2 │
│ │ radiation land:average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXLFO_5_12_4_SWLAND │ Net shortwave │ W/m**2 │
├──────────────────────────────┼─land:average──────────────┼─────────┤
│ M2T1NXSLV_5_12_4_CLDPRS │ Cloud top pressure │ Pa │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_CLDTMP │ Cloud top temperature │ K │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_DISPH │ Zero plane displacement │ m │
│ │ height │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_H1000 │ Height at 1000 mb │ m │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_H250 │ Height at 250 hPa │ m │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_H500 │ Height at 500 hPa │ m │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_H850 │ Height at 850 hPa │ m │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_OMEGA500 │ Omega at 500 hPa │ Pa/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_PBLTOP │ Pbltop pressure │ Pa │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_PS │ Surface pressure │ Pa │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_Q250 │ Specific humidity at 250 │ kg/kg │
│ │ hPa │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_Q500 │ Specific humidity at 500 │ kg/kg │
│ │ hPa │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_Q850 │ Specific humidity at 850 │ kg/kg │
│ │ hPa │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_QV10M │ 10-meter specific │ kg/kg │
├──────────────────────────────┼─humidity──────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_QV2M │ 2-meter specific humidity │ kg/kg │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_SLP │ Sea level pressure │ Pa │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T10M │ 10-meter air temperature │ K │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T250 │ Air temperature at 250 │ K │
├──────────────────────────────┼─hPa───────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T2M │ 2-meter air temperature │ K │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T2MDEW │ Dew point temperature at │ K │
│ │ 2 m │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T2MWET │ Wet bulb temperature at 2 │ K │
├──────────────────────────────┼─m─────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T500 │ Air temperature at 500 │ K │
├──────────────────────────────┼─hPa───────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_T850 │ Air temperature at 850 │ K │
├──────────────────────────────┼─hPa───────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TO3 │ Total column ozone │ Dobsons │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TOX │ Total column odd oxygen │ mm │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TQI │ Total precipitable ice │ mm │
│ │ water │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TQL │ Total precipitable liquid │ mm │
│ │ water │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TQV │ Total precipitable water │ mm │
│ │ vapor │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TROPPB │ Tropopause pressure based │ Pa │
│ │ on blended estimate │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TROPPT │ Tropopause pressure based │ Pa │
│ │ on thermal estimate │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TROPPV │ Tropopause pressure based │ Pa │
│ │ on EPV estimate │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TROPQ │ Tropopause specific │ kg/kg │
│ │ humidity using blended │ │
│ │ TROPP estimate │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TROPT │ Tropopause temperature │ K │
│ │ using blended TROPP │ │
│ │ estimate │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_TS │ Surface skin temperature │ K │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_U10M │ 10-meter eastward wind │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_U250 │ Eastward wind at 250 hPa │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_U2M │ 2-meter eastward wind │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_U500 │ Eastward wind at 500 hPa │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_U50M │ 50-meter eastward │ m/s │
│ │ wind:time average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_U850 │ Eastward wind at 850 hPa │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_V10M │ 10-meter northward wind │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_V250 │ Northward wind at 250 hPa │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_V2M │ 2-meter northward wind │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_V500 │ Northward wind at 500 hPa │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_V50M │ 50-meter northward │ m/s │
│ │ wind:time average │ │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_V850 │ Northward wind at 850 hPa │ m/s │
├──────────────────────────────┼───────────────────────────┼─────────┤
│ M2T1NXSLV_5_12_4_ZLCL │ Lifting condensation │ m │
╘══════════════════════════════╧═level═════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_nldas3_forcing#
$ tsgettoolbox ldas_nldas3_forcing --help
usage: tsgettoolbox ldas_nldas3_forcing [-h] [--variables VARIABLES]
[--startDate STARTDATE] [--endDate ENDDATE] [--time_interval TIME_INTERVAL]
lat lon
┌──────────────────┬───────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞══════════════════╪═══════════╪═══════════╪═══════════╪═══════════════╡
│ NLDAS V3 Forcing │ 0.01x0.01 │ 7, 72 │ -169, -52 │ 1 hr, daily, │
│ │ │ │ │ monthly │
│ │ │ │ │ 2001-01-01 to │
│ │ │ │ │ recent │
╘══════════════════╧═══════════╧═══════════╧═══════════╧═══════════════╛
Baldwin, M., and K.E. Mitchell, 1997: The NCEP hourly multi-sensor U.S.
precipitation analysis for operations and GCIP research. Preprints, 13th AMS
Conference on Hydrology, pp. 54-55, Am. Meteorol. Soc., Boston, Mass.
Berg, A.A., J.S. Famiglietti, J.P. Walker, and P.R. Houser, 2003: Impact of bias
correction to reanalysis products on simulations of North American soil moisture
and hydrological fluxes. J. Geophys. Res., 108(D16), 4490,
doi:10.1029/2002JD003334.
Cosgrove, B.A., et al., 2003: Real-time and retrospective forcing in the North
American Land Data Assimilation System (NLDAS) project. J. Geophys. Res.,
108(D22), 8842, doi:10.1029/2002JD003118.
Daly, C., R.P. Neilson, and D.L. Phillips, 1994: A statistical-topographic model
for mapping climatological precipitation over mountainous terrain. J. Appl.
Meteor., 33, 140-158, doi:10.1175/1520-0450(1994)033<0140:ASTMFM>2.0.CO;2
Fulton, R.A., J.P. Breidenbach, D.J. Seo, D.A. Miller, and T. O'Bannon, 1998:
The WSR-88D rainfall algorithm. Weather and Forecasting, 13, 377-395.
Higgins, R.W., J.E. Janowiak and Y. Yao, 1996: A gridded hourly precipitation
data base for the United States (1963-1993). NCEP/Climate Prediction Center
Atlas No. 1.
Higgins, R.W., W. Shi, E. Yarosh, and R. Joyce, 2000: Improved United States
precipitation quality control system and analysis. NCEP/Climate Prediction
Center Atlas No. 7.
Mitchell, K.E., et al., 2004: The multi-institution North American Land Data
Assimilation System (NLDAS): Utilizing multiple GCIP products and partners in a
continental distributed hydrological modeling system. J. Geophys. Res., 109,
D07S90, doi:10.1029/2003JD003823.
Mo, K.C., L.-C. Chen, S. Shukla, T.J. Bohn, and D.P. Lettenmaier, 2012:
Uncertainties in North American Land Data Assimilation Systems over the
Contiguous United States. J. Hydrometeor, 13, 996-1009,
doi:10.1175/JHM-D-11-0132.1
Pinker, R.T., et al., 2003: Surface radiation budgets in support of the GEWEX
Continental-Scale International Project (GCIP) and the GEWEX Americas Prediction
Project (GAPP), including the North American Land Data Assimilation System
(NLDAS) project. J. Geophys. Res., 108(D22), 8844, doi:10.1029/2002JD003301.
positional arguments:
lat Latitude (required): Enter single geographic latitude point. Use
positive values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
lon Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western hemisphere.
The valid range is specified in the table above.
options:
-h | --help
show this help message and exit
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
${units_table}
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--time_interval TIME_INTERVAL
The time interval of the data to retrieve. Can be either "hourly" or
"daily". Defaults to "hourly".
ldas_nldas_fora#
$ tsgettoolbox ldas_nldas_fora --help
usage: tsgettoolbox ldas_nldas_fora [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
The non-precipitation land-surface forcing fields for NLDAS-2 are derived from
the analysis fields of the NCEP North American Regional Reanalysis (NARR). NARR
consists of: 1) a retrospective dataset starting from Jan 1979, and 2) a daily
update execution at NCEP. The daily update provides a real-time NARR
continuation known as the Regional Climate Data Assimilation System, or R-CDAS.
NARR analysis fields are 32-km spatial resolution and 3-hourly temporal
frequency. Those NARR fields that are utilized to generate NLDAS-2 forcing
fields are spatially interpolated to the finer resolution of the NLDAS
1/8th-degree grid and then temporally disaggregated to the NLDAS-2 hourly
frequency. Additionally, the fields of surface pressure, surface downward
longwave radiation, near-surface air temperature and near-surface specific
humidity are adjusted vertically to account for the vertical difference between
the NARR and NLDAS fields of terrain height. This vertical adjustment applies
the traditional vertical lapse rate of 6.5 K/km for air temperature. The details
of the spatial interpolation, temporal disaggregation, and vertical adjustment
are those employed in NLDAS-1, as presented by Cosgrove et al. (2003).
The hourly land-surface forcing fields for NLDAS-2 are grouped into two GRIB
files, "File A" and "File B". This is a change from NLDAS-1, which had only one
hourly forcing file.
File A contains data for surface, 2 meter, and 10 meter heights. File B contains
data for the lowest layer of the model used for data assimilation.
The surface downward shortwave radiation field in File A is a bias-corrected
field wherein a bias-correction algorithm was applied to the NARR surface
downward shortwave radiation. This bias correction utilizes five years
(1996-2000) of the hourly 1/8th-degree GOES-based surface downward shortwave
radiation fields derived by Pinker et al. (2003).
The precipitation field in File A is not the NARR precipitation forcing, but is
rather a product of a temporal disaggregation of a gauge-only CPC analysis of
daily precipitation, performed directly on the NLDAS grid and including an
orographic adjustment based on the widely-applied PRISM climatology.
The field in File A that gives the fraction of total precipitation that is
convective is an estimate derived from the following two NARR precipitation
fields (which are provided in File B): NARR total precipitation and NARR
convective precipitation (the latter is less than or equal to the NARR total
precipitation and can be zero). The convective fraction of total precipitation
and/or the CAPE field in File A are used by some land models to estimate the
subgrid spatial variability of the total precipitation.
The potential evaporation field in File A is that computed in NARR using the
modified Penman scheme of Mahrt and Ek (1984). Potential evaporation is needed
by some land models (such as the SAC model) that require potential evaporation
as an input forcing.
Baldwin, M., and K.E. Mitchell, 1997: The NCEP hourly multi-sensor U.S.
precipitation analysis for operations and GCIP research. Preprints, 13th AMS
Conference on Hydrology, pp. 54-55, Am. Meteorol. Soc., Boston, Mass.
Berg, A.A., J.S. Famiglietti, J.P. Walker, and P.R. Houser, 2003: Impact of bias
correction to reanalysis products on simulations of North American soil moisture
and hydrological fluxes. J. Geophys. Res., 108(D16), 4490,
doi:10.1029/2002JD003334.
Cosgrove, B.A., et al., 2003: Real-time and retrospective forcing in the North
American Land Data Assimilation System (NLDAS) project. J. Geophys. Res.,
108(D22), 8842, doi:10.1029/2002JD003118.
Daly, C., R.P. Neilson, and D.L. Phillips, 1994: A statistical-topographic model
for mapping climatological precipitation over mountainous terrain. J. Appl.
Meteor., 33, 140-158, doi:10.1175/1520-0450(1994)033<0140:ASTMFM>2.0.CO;2
Fulton, R.A., J.P. Breidenbach, D.J. Seo, D.A. Miller, and T. O'Bannon, 1998:
The WSR-88D rainfall algorithm. Weather and Forecasting, 13, 377-395.
Higgins, R.W., J.E. Janowiak and Y. Yao, 1996: A gridded hourly precipitation
data base for the United States (1963-1993). NCEP/Climate Prediction Center
Atlas No. 1.
Higgins, R.W., W. Shi, E. Yarosh, and R. Joyce, 2000: Improved United States
precipitation quality control system and analysis. NCEP/Climate Prediction
Center Atlas No. 7.
Mitchell, K.E., et al., 2004: The multi-institution North American Land Data
Assimilation System (NLDAS): Utilizing multiple GCIP products and partners in a
continental distributed hydrological modeling system. J. Geophys. Res., 109,
D07S90, doi:10.1029/2003JD003823.
Mo, K.C., L.-C. Chen, S. Shukla, T.J. Bohn, and D.P. Lettenmaier, 2012:
Uncertainties in North American Land Data Assimilation Systems over the
Contiguous United States. J. Hydrometeor, 13, 996-1009,
doi:10.1175/JHM-D-11-0132.1
Pinker, R.T., et al., 2003: Surface radiation budgets in support of the GEWEX
Continental-Scale International Project (GCIP) and the GEWEX Americas Prediction
Project (GAPP), including the North American Land Data Assimilation System
(NLDAS) project. J. Geophys. Res., 108(D22), 8844, doi:10.1029/2002JD003301.
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ NLDAS Primary Forcing │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 hour │
│ Data NLDAS_FORA0125_H │ │ │ │ 1979-01-01T13 │
│ V2.0 │ │ │ │ till recent │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌──────────────────────────────────┬───────────────────────────┬──────────┐
│ LDAS "variables" string │ Description │ Units │
╞══════════════════════════════════╪═══════════════════════════╪══════════╡
│ NLDAS_FORA0125_H_2_0_CAPE │ Convective Available │ J/kg │
│ │ Potential Energy │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_CRainf_frac │ Fraction of total │ fraction │
│ │ precipitation that is │ │
│ │ convective │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_LWdown │ Surface DW longwave │ W/m**2 │
│ │ radiation flux │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_PotEvap │ Potential evaporation │ mm │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_PSurf │ Surface pressure │ Pa │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Qair │ 2-m above ground specific │ kg/kg │
│ │ humidity │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Rainf │ Precipitation hourly │ mm │
├──────────────────────────────────┼─total─────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_SWdown │ Surface DW shortwave │ W/m**2 │
│ │ radiation flux │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Tair │ 2-m above ground │ K │
│ │ temperature │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Wind_E │ 10-m above ground zonal │ m/s │
│ │ wind │ │
├──────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_FORA0125_H_2_0_Wind_N │ 10-m above ground │ m/s │
│ │ meridional wind │ │
╘══════════════════════════════════╧═══════════════════════════╧══════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_nldas_noah#
$ tsgettoolbox ldas_nldas_noah --help
usage: tsgettoolbox ldas_nldas_noah [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
The NLDAS-2 Noah land surface model simulations were forced with the NLDAS-2
Forcing Data Sets. More information can be found at
<[4;36mhttps://ldas.gsfc.nasa.gov/nldas/v2/models[0m>
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ NLDAS Noah Land Surface │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 hour │
│ Model NLDAS_NOAH0125_H │ │ │ │ 1979-01-01T13 │
╘═V002══════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌──────────────────────────────────────┬───────────────────────────┬──────────┐
│ LDAS "variables" string │ Description │ Units │
╞══════════════════════════════════════╪═══════════════════════════╪══════════╡
│ NLDAS_NOAH0125_H_2_0_ACond │ Aerodynamic conductance │ m/s │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Albedo │ Surface albedo │ percent │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_AvgSurfT │ Average surface skin │ K │
│ │ temperature │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_CanopInt │ Plant canopy surface │ mm │
├──────────────────────────────────────┼─water─────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_CCond │ Canopy conductance │ m/s │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_ECanop │ Canopy water evaporation │ W/m**2 │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_ESoil │ Direct evaporation from │ W/m**2 │
│ │ bare soil │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Evap │ Total evapotranspiration │ mm │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_GVEG │ Green vegetation │ fraction │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_LAI │ Leaf Area Index │ unitless │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_LWdown │ Surface downwards │ W/m**2 │
│ │ longwave radiation flux │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_LWnet │ Surface net longwave │ W/m**2 │
│ │ radiation flux │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_PotEvap │ Potential evapotranspira- │ W/m**2 │
│ │ tion │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qf │ Snow phase-change heat │ W/m**2 │
├──────────────────────────────────────┼─flux──────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qg │ Ground heat flux │ W/m**2 │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qh │ Sensible heat flux │ W/m**2 │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qle │ Latent heat flux │ W/m**2 │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qsb │ Subsurface runoff │ mm │
│ │ (baseflow) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qsm │ Snowmelt │ mm │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Qs │ Surface runoff (non- │ mm │
│ │ infiltrating) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Rainf │ Liquid precipitation │ mm │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCQ │ Humidity parameter in │ fraction │
│ │ canopy conductance │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCSOL │ Soil moisture parameter │ fraction │
│ │ in canopy conductance │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCS │ Solar parameter in canopy │ fraction │
│ │ conductance │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RCT │ Temperature parameter in │ fraction │
│ │ canopy conductance │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RootMoist │ Root zone soil moisture │ mm │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RSMacr │ Relative soil moisture │ fraction │
│ │ availability control │ │
├──────────────────────────────────────┼─factor────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_RSmin │ Minimal stomatal │ s/m │
├──────────────────────────────────────┼─resistance────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMAvail_0_100cm │ Soil moisture │ percent │
│ │ availability (0-100cm) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMAvail_0_200cm │ Soil moisture │ percent │
│ │ availability (0-200cm) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_0_10cm │ Liquid soil moisture │ mm │
│ │ content (0-10cm) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_100_200cm │ Liquid soil moisture │ mm │
│ │ content (100-200cm) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_10_40cm │ Liquid soil moisture │ mm │
│ │ content (10-40cm) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SMLiq_40_100cm │ Liquid soil moisture │ mm │
│ │ content (40-100cm) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SnowDepth │ Snow depth │ m │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Snowf │ Frozen precipitation │ mm │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SnowFrac │ Snow cover │ fraction │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_0_100cm │ 0-100 cm soil moisture │ mm │
│ │ content │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_0_10cm │ 0-10 cm soil moisture │ mm │
│ │ content │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_0_200cm │ 0-200 cm soil moisture │ mm │
│ │ content │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_100_200cm │ 100-200 cm soil moisture │ mm │
│ │ content │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_10_40cm │ 10-40 cm soil moisture │ mm │
│ │ content │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilM_40_100cm │ 40-100 cm soil moisture │ mm │
│ │ content │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_0_10cm │ 0-10 cm soil temperature │ K │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_100_200cm │ 100-200 cm soil │ K │
├──────────────────────────────────────┼─temperature───────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_10_40cm │ 10-40 cm soil temperature │ K │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SoilT_40_100cm │ 40-100 cm soil │ K │
├──────────────────────────────────────┼─temperature───────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_Streamflow │ Streamflow │ m**3/s │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SubSnow │ Sublimation (evaporation │ W/m**2 │
│ │ from snow) │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SWdown │ Surface downwards │ W/m**2 │
│ │ shortwave radiation flux │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SWE │ Snow Water Equivalent │ mm │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_SWnet │ Surface net shortwave │ W/m**2 │
│ │ radiation flux │ │
├──────────────────────────────────────┼───────────────────────────┼──────────┤
│ NLDAS_NOAH0125_H_2_0_TVeg │ Transpiration │ W/m**2 │
╘══════════════════════════════════════╧═══════════════════════════╧══════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_nldas_vic#
$ tsgettoolbox ldas_nldas_vic --help
usage: tsgettoolbox ldas_nldas_vic [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
The NLDAS-2 Variable Infiltration Capacity (VIC) land surface model simulations
were forced with the NLDAS-2 Forcing Data Sets. More information can be found at
<[4;36mhttps://ldas.gsfc.nasa.gov/nldas/v2/models[0m>
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ NLDAS VIC Land Surface │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 hour │
│ Model NLDAS_VIC0125_H │ │ │ │ 1979-01-01T13 │
│ V002 │ │ │ │ till recent │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌───────────────────────────────────┬───────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞═══════════════════════════════════╪═══════════════════════════╪═════════╡
│ NLDAS_VIC0125_H_2_0_Evap │ Total evapotranspiration │ mm │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_Qg │ Ground heat flux │ W/m**2 │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_Qh │ Sensible heat flux │ W/m**2 │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_Qle │ Latent heat flux │ W/m**2 │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_Qsb │ Subsurface runoff │ mm │
│ │ (baseflow) │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_Qs │ Surface runoff (non- │ mm │
│ │ infiltrating) │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_0_100cm │ 0-100 cm soil moisture │ mm │
│ │ content │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_layer1 │ VIC layer 1 soil moisture │ mm │
│ │ content │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_layer2 │ VIC layer 2 soil moisture │ mm │
│ │ content │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_layer3 │ VIC layer 3 soil moisture │ mm │
│ │ content │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilM_total │ VIC total column depth │ mm │
│ │ soil moisture content │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilT_layer1 │ VIC layer 1 soil │ K │
│ │ temperature │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilT_layer2 │ VIC layer 3 soil │ K │
│ │ temperature │ │
├───────────────────────────────────┼───────────────────────────┼─────────┤
│ NLDAS_VIC0125_H_2_0_SoilT_layer3 │ VIC layer 3 soil │ K │
│ │ temperature │ │
╘═══════════════════════════════════╧═══════════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
ldas_smerge#
$ tsgettoolbox ldas_smerge --help
usage: tsgettoolbox ldas_smerge [-h] [--lat LAT] [--lon LON]
[--variables VARIABLES] [--startDate STARTDATE] [--endDate ENDDATE]
[--variable VARIABLE]
The time zone is always UTC.
SoilMERGE (SMERGE) is a new root-zone soil moisture (RZSM) product that covers
the entire continental United States. A fundamental limiting factor that
constrains agricultural productivity is RZSM. Also delineation of RZSM is
important for drought monitoring and RZSM is considered a critical climate
variable.
This product is developed based on merging NLDAS land surface model output with
surface satellite retrievals from the European Space Agency (ESA) Climate Change
Initiative (CCI). Therefore, unlike other observational soil moisture products
SMERGE spans nearly four decades (1979 to 2019). The product has a 0.125o
spatial resolution at a daily time step.
A key initial user for SMERGE will be the USDA Northern Plains Regional Climate
Hub (NPRCH). Stakeholder input will be solicited during the initial phases of
product development. This effort will maximize the utility of SMERGE to diverse
users who have an interest in long-term analysis of RZSM to support activities
in the areas of water and land management and within the agricultural sector.
┌───────────────────────────┬─────────────┬───────────┬───────────┬───────────────┐
│ Description/Name │ Spatial │ Lat Range │ Lon Range │ Time │
╞═══════════════════════════╪═════════════╪═══════════╪═══════════╪═══════════════╡
│ Smerge-Noah-CCI root zone │ 0.125x0.125 │ 25, 53 │ -125, -67 │ 1 day 1979-0- │
│ soil moisture 0-40 cm │ │ │ │ 1-02 to │
│ SMERGE_RZSM0_40CM V2.0 │ │ │ │ recent │
╘═══════════════════════════╧═════════════╧═══════════╧═══════════╧═══════════════╛
options:
-h | --help
show this help message and exit
--lat LAT
Latitude (required): Enter single geographic latitude point. Use positive
values for the northern hemisphere and negative for the southern
hemisphere. The valid range is specified in the table above.
--lon LON
Longitude (required): Enter single geographic longitude point. Use
positive for the eastern hemisphere and negative for the western
hemisphere. The valid range is specified in the table above.
--variables VARIABLES
For the command line a comma separated string of variable codes from the
following table. Using the Python API a list of variable strings.
Valid variable names are specified in the table below.
┌───────────────────────────────┬──────────────────────────┬─────────┐
│ LDAS "variables" string │ Description │ Units │
╞═══════════════════════════════╪══════════════════════════╪═════════╡
│ SMERGE_RZSM0_40CM_2_0_CCI_ano │ CCI soil moisture │ m3/m3 │
│ │ anomalies 0-40 cm │ │
├───────────────────────────────┼──────────────────────────┼─────────┤
│ SMERGE_RZSM0_40CM_2_0_RZSM │ Average soil moisture of │ m3/m3 │
│ │ 0-40 cm layer │ │
╘═══════════════════════════════╧══════════════════════════╧═════════╛
--startDate STARTDATE
The start date of the time series.:
Example: --startDate=2001-01-01T05
If startDate and endDate are None, returns the entire series.
--endDate ENDDATE
The end date of the time series.:
Example: --endDate=2002-01-05T05
If startDate and endDate are None, returns the entire series.
--variable VARIABLE
DEPRECATED: use "variables" instead to be consistent across
"tsgettoolbox".
metdata#
$ tsgettoolbox metdata --help
usage: tsgettoolbox metdata [-h] [--variables VARIABLES]
[--start_date START_DATE] [--end_date END_DATE] lat lon
This archive contains daily surface meteorological (METDATA) data for the
Continental United States at 4-km (1/24-deg) resolution. The meteorological
variables are maximum/minimum temperature, precipitation amount and duration,
maximum/minimum relative humidity,downward shortwave solar radiation, wind speed
and direction, and specific humidity. The method utilized here combines
desirable spatial attributes of gridded climate data from PRISM and desirable
temporal attributes of regional-scale reanalysis and daily gauge-based
precipitation from NLDAS-2 to derive a spatially and temporally complete high
resolution gridded dataset of surface meteorological variables for the
continental US for 1979-present. Validation of this data suggests that it can
serve as a suitable surrogate for landscape-scale ecological modeling across
vast unmonitored areas of the US.
Whenever you publish research based on data from this archive, please reference
this data by using the phrase "daily gridded meteorological data (METDATA) for
the continental US" and by citing the article (Abatzoglou,2012). Further,
appropriately acknowledge the National Science Foundation (NSF), Idaho EPSCoR
and the individual investigators responsible for the data set.
Citation:
Abatzoglou, J.T., 2013, Development of gridded surface meteorological data for
ecological applications and modeling, International Journal of Climatology,
DOI: 10.1002/joc.3413
geospatial_bounds_crs:
EPSG:4326
Conventions:
CF-1.0
geospatial_bounds:
POLYGON((-124.7666666333333 49.400000000000000, -124.7666666333333
25.066666666666666, -67.058333300000015 25.066666666666666,
-67.058333300000015 49.400000000000000, -124.7666666333333
49.400000000000000))
geospatial_lat_min:
25.0631
geospatial_lat_max:
49.3960
geospatial_lon_min:
-124.7722
geospatial_lon_max:
-67.0648
geospatial_lon_resolution:
0.041666666666666
geospatial_lat_resolution:
0.041666666666666
geospatial_lat_units:
decimal_degrees north
geospatial_lon_units:
decimal_degrees east
coordinate_system:
EPSG:4326
author:
John Abatzoglou - University of Idaho, jabatzoglou @ uidaho.edu
date:
02 July 2019
note1:
The projection information for this file is: GCS WGS 1984.
note3:
Data in slices after last_permanent_slice (1-based) are considered provisional
and subject to change with subsequent updates
note4:
Data in slices after last_provisional_slice (1-based) are considered early and
subject to change with subsequent updates
note5:
Days correspond approximately to calendar days ending at midnight, Mountain
Standard Time (7 UTC the next calendar day)
Metadata_Conventions:
Unidata Dataset Discovery v1.0
title:
Daily Meteorological data for continental US
keywords:
daily precipitation, daily precipitation duration, daily maximum temperature,
daily minimum temperature, daily downward shortwave solar radiation, daily
specific humidity, daily maximum relative humidity, daily minimum relative
humidity, daily wind speed, daily wind direction,
ClimatologyMeteorologyAtmosphere, Gridded Meteorological Data, EPSCoR Data
id:
UofIMETDATA
naming_authority:
cida.usgs.gov
cdm_data_type:
Grid
date_created:
2012-08-16
creator_name:
Dr. John Abatzoglou
creator_url:
<[4;36mhttp://nimbus.cos.uidaho.eud/METDATA/[0m>
creator_email:
jabatzoglou @ uidaho.edu
institution:
University of Idaho
date_issued:
2012-08-16
project:
METDATA
processing_level:
Gridded Meteorogolical Data
contributors:
Dr. John Abatzoglou
time_coverage_start:
1979-01-01T00:00
time_coverage_resolution:
P1D
license:
Freely available
positional arguments:
lat The latitude of the point. North hemisphere is positive from 0 to
90. South hemisphere is negative from 0 to -90.
lon The longitude of the point. Western hemisphere (west of Greenwich
Prime Meridian) is negative 0 to -180. The eastern hemisphere (east of the
Greenwich Prime Meridian) is positive 0 to 180.
options:
-h | --help
show this help message and exit
--variables VARIABLES
At the command line can supply a comma separated list of variable names.
Using the Python API needs to be a Python list of strings.
The current list of available METDATA variables are in the following table
and you can use either the "Short" or "Long" names.
┌──────────┬─────────────────────────────────────────────────────────┬───────┐
│ Short │ Long │ Units │
╞══════════╪═════════════════════════════════════════════════════════╪═══════╡
│ pr │ precipitation_amount │ mm │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ rmax │ daily_maximum_relative_humidity │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ rmin │ daily_minimum_relative_humidity │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ sph │ daily_mean_specific_humidity │ kg/kg │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ srad │ daily_mean_shortwave_radiation_at_surface │ W/m2 │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ tmmn │ daily_minimum_temperature │ degK │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ tmmx │ daily_maximum_temperature │ degK │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ vs │ daily_mean_wind_speed │ m/s │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ bi │ daily_mean_burning_index_g │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ fm100 │ dead_fuel_moisture_100hr │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ fm1000 │ dead_fuel_moisture_1000hr │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ erc │ daily_mean_energy_release_component-g │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ pdsi │ daily_mean_palmer_drought_severity_index │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ etr │ daily_mean_reference_evapotranspiration_alfalfa │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ pet │ daily_mean_reference_evapotranspiration_grass │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ vpd │ daily_mean_vapor_pressure_deficit │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi14d │ standard_precipitation_index_14_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi30d │ standard_precipitation_index_30_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi90d │ standard_precipitation_index_90_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi180d │ standard_precipitation_index_180_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi1y │ standard_precipitation_index_1_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi2y │ standard_precipitation_index_2_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spi5y │ standard_precipitation_index_5_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei14d │ standard_precipitation_evapotranspiration_index_14_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei30d │ standard_precipitation_evapotranspiration_index_30_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei90d │ standard_precipitation_evapotranspiration_index_90_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei180d │ standard_precipitation_evapotranspiration_index_180_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei270d │ standard_precipitation_evapotranspiration_index_270_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei1y │ standard_precipitation_evapotranspiration_index_1_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei2y │ standard_precipitation_evapotranspiration_index_2_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ spei5y │ standard_precipitation_evapotranspiration_index_5_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi14d │ evaporative_drought_demand_index_14_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi30d │ evaporative_drought_demand_index_30_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi90d │ evaporative_drought_demand_index_90_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi180d │ evaporative_drought_demand_index_180_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi270d │ evaporative_drought_demand_index_270_day │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi1y │ evaporative_drought_demand_index_1_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi2y │ evaporative_drought_demand_index_2_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ eddi5y │ evaporative_drought_demand_index_5_year │ │
├──────────┼─────────────────────────────────────────────────────────┼───────┤
│ z │ daily_mean_palmer_z_index │ │
╘══════════╧═════════════════════════════════════════════════════════╧═══════╛
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
modis#
$ tsgettoolbox modis --help
<string>:1649: (ERROR/3) Unknown target name: "f".
usage: tsgettoolbox modis [-h] [--start_date START_DATE] [--end_date END_DATE]
lat lon product band
This data are derived data sets from MODIS satellite photos.
The MODIS Land Cover Type product contains five classification schemes, which
describe land cover properties derived from observations spanning a year's input
of Terra- and Aqua-MODIS data. The primary land cover scheme identifies 17 land
cover classes defined by the International Geosphere Biosphere Programme (IGBP),
which includes 11 natural vegetation classes, 3 developed and mosaicked land
classes, and three non-vegetated land classes.
The MODIS Terra + Aqua Land Cover Type Yearly L3 Global 500 m SIN Grid product
incorporates five different land cover classification schemes, derived through a
supervised decision-tree classification method.
V051 Land Cover Type products are produced with revised training data and
certain algorithm refinements. For further details, please consult the following
paper:
Friedl, M. A., Sulla-Menashe, D., Tan, B., Schneider, A., Ramankutty, N.,
Sibley, A., and Huang, X. (2010). MODIS Collection 5 global land cover:
Algorithm refinements and characterization of new datasets. Remote Sensing of
Environment, 114, 168-182.
Land Cover Datasets
┌───────────────────┬──────────┬───────────────────────────────────┐
│ Band │ Abbrev │ Description │
╞═══════════════════╪══════════╪═══════════════════════════════════╡
│ Land_Cover_Type_1 │ IGBP │ global vegetation classification │
│ │ │ scheme │
├───────────────────┼──────────┼───────────────────────────────────┤
│ Land_Cover_Type_2 │ UMD │ University of Maryland scheme │
├───────────────────┼──────────┼───────────────────────────────────┤
│ Land_Cover_Type_3 │ LAI/fPAR │ MODIS-derived scheme │
├───────────────────┼──────────┼───────────────────────────────────┤
│ Land_Cover_Type_4 │ NPP │ MODIS-derived Net Primary │
│ │ │ Production (NPP) scheme │
├───────────────────┼──────────┼───────────────────────────────────┤
│ Land_Cover_Type_5 │ PFT │ Plant Functional Type (PFT) │
╘═══════════════════╧══════════╧═scheme════════════════════════════╛
Land Cover Types Description
┌──────┬───────────┬───────────┬───────────┬───────────┬───────────┐
│ Code │ IGBP │ UMD │ LAI/fPAR │ NPP │ PFT │
╞══════╪═══════════╪═══════════╪═══════════╪═══════════╪═══════════╡
│ 0 │ Water │ Water │ Water │ Water │ Water │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 1 │ Evergreen │ Evergreen │ Grasses/ │ Evergreen │ Evergreen │
│ │ Needle │ Needle │ Cereal │ Needle │ Needle │
│ │ leaf │ leaf │ crop │ leaf │ leaf │
├──────┼─forest────┼─forest────┼───────────┼───────────┼───────────┤
│ 2 │ Evergreen │ Evergreen │ Shrub │ Evergreen │ Evergreen │
│ │ Broadleaf │ Broadleaf │ │ Broadleaf │ Broadleaf │
│ │ forest │ forest │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 3 │ Deciduous │ Deciduous │ Broadleaf │ Deciduous │ Deciduous │
│ │ Needle │ Needle │ crop │ Needle │ Needle │
│ │ leaf │ leaf │ │ leaf │ leaf │
├──────┼─forest────┼─forest────┼───────────┼───────────┼───────────┤
│ 4 │ Deciduous │ Deciduous │ Savanna │ Deciduous │ Deciduous │
│ │ Broadleaf │ Broadleaf │ │ Broadleaf │ Broadleaf │
│ │ forest │ forest │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 5 │ Mixed │ Mixed │ Evergreen │ Annual │ Shrub │
│ │ forest │ forest │ Broadleaf │ Broadleaf │ │
│ │ │ │ forest │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 6 │ Closed │ Closed │ Deciduous │ Annual │ Grassland │
│ │ shrubland │ shrubland │ Broadleaf │ grass │ │
│ │ │ │ forest │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 7 │ Open │ Open │ Evergreen │ Non- │ Cereal │
│ │ shrubland │ shrubland │ Needle │ vegetated │ crops │
│ │ │ │ leaf │ land │ │
├──────┼───────────┼───────────┼─forest────┼───────────┼───────────┤
│ 8 │ Woody │ Woody │ Deciduous │ Urban │ Broad- │
│ │ savanna │ savanna │ Needle │ │ leaf │
│ │ │ │ leaf │ │ crops │
├──────┼───────────┼───────────┼─forest────┼───────────┼───────────┤
│ 9 │ Savanna │ Savanna │ Non- │ │ Urban and │
│ │ │ │ vegetated │ │ built-up │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 10 │ Grassland │ Grassland │ Urban │ │ Snow and │
│ │ │ │ │ │ ice │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 11 │ Permanent │ │ │ │ Barren or │
│ │ wetlands │ │ │ │ sparse │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 12 │ Croplands │ Cropland │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 13 │ Urban and │ Urban and │ │ │ │
│ │ built-up │ built-up │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 14 │ Cropland │ │ │ │ │
│ │ /Natural │ │ │ │ │
│ │ mosaic │ │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 15 │ Snow and │ │ │ │ │
│ │ ice │ │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 16 │ Barren or │ Barren or │ │ │ │
│ │ sparsely │ sparsely │ │ │ │
│ │ vegetated │ vegetated │ │ │ │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 254 │ Unclassi │ Unclassi │ Unclassi │ Unclassi │ Unclassi │
│ │ fied │ fied │ fied │ fied │ fies │
├──────┼───────────┼───────────┼───────────┼───────────┼───────────┤
│ 255 │ Fill │ Fill │ Fill │ Fill │ Fill │
╘══════╧═Value═════╧═Value═════╧═Value═════╧═Value═════╧═Value═════╛
positional arguments:
lat Latitude (required): Enter single geographic point by
latitude.
lon Longitude (required): Enter single geographic point by
longitude.
product One of the following values in the 'product'
column.
┌──────────────┬──────────────────────┬───────────┬────────────┐
│ product │ Description │ Frequency │ Resolution │
│ │ │ │ (m) │
╞══════════════╪══════════════════════╪═══════════╪════════════╡
│ ECO4ESIPTJPL │ ECOSTRESS Evaporati- │ Varies │ 70 │
│ │ ve Stress Index │ │ │
│ │ PT-JPL (ESI) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ ECO4WUE │ ECOSTRESS Water Use │ Varies │ 70 │
│ │ Efficiency (WUE) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ GEDI03 │ GEDI Gridded Land │ One-time │ 1000 │
│ │ Surface Metrics │ │ │
├──────────────┼─(LSM)────────────────┼───────────┼────────────┤
│ GEDI04_B │ GEDI Gridded │ One-time │ 1000 │
│ │ Aboveground Biomass │ │ │
│ │ Density (AGBD) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD12Q1 │ MODIS/Terra+Aqua │ Yearly │ 500 │
│ │ Land Cover Type (LC) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD12Q2 │ MODIS/Terra+Aqua │ Yearly │ 500 │
│ │ Land Cover Dynamics │ │ │
├──────────────┼─(LCD)────────────────┼───────────┼────────────┤
│ MCD15A2H │ MODIS/Terra+Aqua │ 8-Day │ 500 │
│ │ Leaf Area Index/FPAR │ │ │
│ │ (LAI/FPAR) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD15A3H │ MODIS/Terra+Aqua │ 4-Day │ 500 │
│ │ Leaf Area Index/FPAR │ │ │
│ │ (LAI/FPAR) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD19A3 │ MODIS/Terra+Aqua │ 8-Day │ 1000 │
│ │ BRDF Model │ │ │
│ │ Parameters (MAIAC) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD43A │ MODIS/Terra+Aqua │ Daily │ 500 │
│ │ BRDF and Calculated │ │ │
│ │ Albedo (BRDF/MCD43A) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD43A1 │ MODIS/Terra+Aqua │ Daily │ 500 │
│ │ BRDF/Albedo Model │ │ │
│ │ Parameters (BRDF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD43A4 │ MODIS/Terra+Aqua │ Daily │ 500 │
│ │ Nadir BRDF-Adjusted │ │ │
│ │ Reflectance (NBAR) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MCD64A1 │ MODIS/Terra+Aqua │ Monthly │ 500 │
│ │ Burned Area (Burned │ │ │
│ │ Area) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD09A1 │ MODIS/Terra Surface │ 8-Day │ 500 │
│ │ Reflectance (SREF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD11A2 │ MODIS/Terra Land │ 8-Day │ 1000 │
│ │ Surface Temperature │ │ │
│ │ and Emissivity (LST) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD13Q1 │ MODIS/Terra │ 16-Day │ 250 │
│ │ Vegetation Indices │ │ │
├──────────────┼─(NDVI/EVI)───────────┼───────────┼────────────┤
│ MOD14A2 │ MODIS/Terra Thermal │ 8-Day │ 1000 │
│ │ Anomalies/Fire │ │ │
├──────────────┼─(Fire)───────────────┼───────────┼────────────┤
│ MOD15A2H │ MODIS/Terra Leaf │ 8-Day │ 500 │
│ │ Area Index/FPAR │ │ │
├──────────────┼─(LAI/FPAR)───────────┼───────────┼────────────┤
│ MOD16A2 │ MODIS/Terra Net │ 8-Day │ 500 │
│ │ Evapotranspiration │ │ │
│ │ (ET) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD17A2H │ MODIS/Terra Gross │ 8-Day │ 500 │
│ │ Primary Productivity │ │ │
│ │ (GPP) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD17A3HGF │ MODIS/Terra Net │ Yearly │ 500 │
│ │ Primary Production │ │ │
│ │ Gap-Filled (NPP) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD21A2 │ MODIS/Terra Land │ 8-Day │ 1000 │
│ │ Surface Temperature- │ │ │
│ │ /3-Band Emissivity │ │ │
│ │ (LSTE) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MOD44B │ MODIS/Terra │ Yearly │ 250 │
│ │ Vegetation │ │ │
│ │ Continuous Fields │ │ │
├──────────────┼─(VCF)────────────────┼───────────┼────────────┤
│ MYD09A1 │ MODIS/Aqua Surface │ 8-Day │ 500 │
│ │ Reflectance (SREF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MYD11A2 │ MODIS/Aqua Land │ 8-Day │ 1000 │
│ │ Surface Temperature │ │ │
│ │ and Emissivity (LST) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MYD13Q1 │ MODIS/Aqua │ 16-Day │ 250 │
│ │ Vegetation Indices │ │ │
├──────────────┼─(NDVI/EVI)───────────┼───────────┼────────────┤
│ MYD14A2 │ MODIS/Aqua Thermal │ 8-Day │ 1000 │
│ │ Anomalies/Fire │ │ │
├──────────────┼─(Fire)───────────────┼───────────┼────────────┤
│ MYD15A2H │ MODIS/Aqua Leaf Area │ 8-Day │ 500 │
│ │ Index/FPAR │ │ │
├──────────────┼─(LAI/FPAR)───────────┼───────────┼────────────┤
│ MYD16A2 │ MODIS/Aqua Net │ 8-Day │ 500 │
│ │ Evapotranspiration │ │ │
│ │ (ET) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MYD17A2H │ MODIS/Aqua Gross │ 8-Day │ 500 │
│ │ Primary Productivity │ │ │
│ │ (GPP) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MYD17A3HGF │ MODIS/Aqua Net │ Yearly │ 500 │
│ │ Primary Production │ │ │
│ │ Gap-Filled (NPP) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ MYD21A2 │ MODIS/Aqua Land │ 8-Day │ 1000 │
│ │ Surface Temperature- │ │ │
│ │ /3-Band Emissivity │ │ │
│ │ (LSTE) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ SIF005 │ SIF Estimates from │ Monthly │ 5000 │
│ │ Fused SCIAMACHY and │ │ │
│ │ GOME-2 (SIF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ SIF_ANN │ SIF Estimates from │ 16-day │ 5000 │
│ │ OCO-2 SIF and MODIS │ │ │
│ │ (SIF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ VNP09A1 │ VIIRS/S-NPP Surface │ 8-Day │ 1000 │
│ │ Reflectance (SREF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ VNP09H1 │ VIIRS/S-NPP Surface │ 8-Day │ 500 │
│ │ Reflectance (SREF) │ │ │
├──────────────┼──────────────────────┼───────────┼────────────┤
│ VNP13A1 │ VIIRS/S-NPP │ 16-Day │ 500 │
│ │ Vegetation Indices │ │ │
├──────────────┼─(NDVI/EVI)───────────┼───────────┼────────────┤
│ VNP15A2H │ VIIRS/S-NPP Leaf │ 8-Day │ 500 │
│ │ Area Index/FPAR │ │ │
├──────────────┼─(LAI/FPAR)───────────┼───────────┼────────────┤
│ VNP21A2 │ VIIRS/S-NPP Land │ 8-Day │ 1000 │
│ │ Surface Temperature │ │ │
│ │ and Emissivity │ │ │
├──────────────┼─(LSTE)───────────────┼───────────┼────────────┤
│ VNP22Q2 │ VIIRS/S-NPP Land │ Yearly │ 500 │
│ │ Cover Dynamics (LCD) │ │ │
╘══════════════╧══════════════════════╧═══════════╧════════════╛
band One of the following. The 'band' selected from the first column must
match the 'product' keyword in the table title.
ECO4ESIPTJPL
┌────────┬──────────────────────────┬──────────────┬───────────┐
│ band │ Description │ Units │ Range │
╞════════╪══════════════════════════╪══════════════╪═══════════╡
│ ESIavg │ Evaporative Stress Index │ ratio_ET/PET │ 0 to 2 │
├────────┼──────────────────────────┼──────────────┼───────────┤
│ PET │ Potential Evapotranspir- │ W/m^2 │ 0 to 2000 │
│ │ ation │ │ │
╘════════╧══════════════════════════╧══════════════╧═══════════╛
ECO4WUE
┌────────┬──────────────────────┬──────────────┬──────────┐
│ band │ Description │ Units │ Range │
╞════════╪══════════════════════╪══════════════╪══════════╡
│ WUEavg │ Water Use Efficiency │ ratio_GPP/ET │ 0 to 20 │
╘════════╧══════════════════════╧══════════════╧══════════╛
GEDI03
┌────────────────────────┬────────────────────────────┬────────┐
│ band │ Description │ Units │
╞════════════════════════╪════════════════════════════╪════════╡
│ counts │ count of valid laser │ counts │
│ │ footprints │ │
├────────────────────────┼────────────────────────────┼────────┤
│ elev_lowestmode_mean │ mean elevation of the │ meters │
│ │ lowest mode │ │
├────────────────────────┼────────────────────────────┼────────┤
│ elev_lowestmode_stddev │ stddev elevation of the │ meters │
│ │ lowest mode │ │
├────────────────────────┼────────────────────────────┼────────┤
│ rh100_mean │ mean 100th percentile of │ meters │
│ │ waveform energy relative │ │
│ │ to ground │ │
├────────────────────────┼────────────────────────────┼────────┤
│ rh100_stddev │ stddev 100th percentile of │ meters │
│ │ waveform energy relative │ │
│ │ to ground │ │
╘════════════════════════╧════════════════════════════╧════════╛
GEDI04_B
┌────────┬──────────────────────────────────┬─────────┐
│ band │ Description │ Units │
╞════════╪══════════════════════════════════╪═════════╡
│ MI │ mode of interference │ │
├────────┼──────────────────────────────────┼─────────┤
│ MU │ mean aboveground biomass density │ Mg/ha │
├────────┼──────────────────────────────────┼─────────┤
│ NC │ number of clusters │ counts │
├────────┼──────────────────────────────────┼─────────┤
│ NS │ number of samples │ counts │
├────────┼──────────────────────────────────┼─────────┤
│ PE │ standard error as a fraction of │ percent │
│ │ the estimated mean AGBD │ │
├────────┼──────────────────────────────────┼─────────┤
│ PS │ prediction stratum │ │
├────────┼──────────────────────────────────┼─────────┤
│ QF │ quality flag │ │
├────────┼──────────────────────────────────┼─────────┤
│ SE │ mean aboveground biomass density │ Mg/ha │
│ │ standard error │ │
├────────┼──────────────────────────────────┼─────────┤
│ V1 │ variance component 1 │ │
├────────┼──────────────────────────────────┼─────────┤
│ V2 │ variance component 2 │ │
╘════════╧══════════════════════════════════╧═════════╛
MCD12Q1
┌─────────────────────┬───────────────────┬─────────┬──────────┐
│ band │ Description │ Units │ Range │
╞═════════════════════╪═══════════════════╪═════════╪══════════╡
│ LC_Prop1 │ FAO-Land Cover │ class │ 1 to 43 │
│ │ Classification │ │ │
│ │ System 1 (LCCS1) │ │ │
│ │ land cover layer │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Prop1_Assessment │ LCCS1 land cover │ percent │ 0 to 100 │
│ │ layer confidence │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Prop2 │ FAO-LCCS2 land │ class │ 1 to 40 │
│ │ use layer │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Prop2_Assessment │ LCCS2 land use │ percent │ 0 to 100 │
│ │ layer confidence │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Prop3 │ FAO-LCCS3 surface │ class │ 1 to 51 │
│ │ hydrology layer │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Prop3_Assessment │ LCCS3 surface │ percent │ 0 to 100 │
│ │ hydrology layer │ │ │
│ │ confidence │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Type1 │ Land Cover Type │ class │ 1 to 17 │
│ │ 1: Annual │ │ │
│ │ International │ │ │
│ │ Geosphere- │ │ │
│ │ Biosphere │ │ │
│ │ Programme (IGBP) │ │ │
│ │ classification │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Type2 │ Land Cover Type │ class │ 0 to 15 │
│ │ 2: Annual │ │ │
│ │ University of │ │ │
│ │ Maryland (UMD) │ │ │
├─────────────────────┼─classification────┼─────────┼──────────┤
│ LC_Type3 │ Land Cover Type │ class │ 0 to 10 │
│ │ 3: Annual Leaf │ │ │
│ │ Area Index (LAI) │ │ │
│ │ classification │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Type4 │ Land Cover Type │ class │ 0 to 8 │
│ │ 4: Annual BIOME- │ │ │
│ │ Biogeochemical │ │ │
│ │ Cycles (BGC) │ │ │
│ │ classification │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LC_Type5 │ Land Cover Type │ class │ 0 to 11 │
│ │ 5: Annual Plant │ │ │
│ │ Functional Types │ │ │
│ │ classification │ │ │
├─────────────────────┼───────────────────┼─────────┼──────────┤
│ LW │ Binary land │ class │ 1 to 2 │
│ │ (class 2) / water │ │ │
│ │ (class 1) mask │ │ │
│ │ derived from │ │ │
├─────────────────────┼─MOD44W────────────┼─────────┼──────────┤
│ QC │ Product quality │ quality │ 0 to 10 │
│ │ flags │ flag │ │
╘═════════════════════╧═══════════════════╧═════════╧══════════╛
MCD12Q2
┌────────────────────────────┬─────────────┬────────────┬──────────┐
│ band │ Description │ Units │ Range │
╞════════════════════════════╪═════════════╪════════════╪══════════╡
│ Dormancy.Num_Modes_01 │ Onset │ days since │ 11138 to │
│ │ Dormancy │ 1970-01-01 │ 32766 │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ Dormancy.Num_Modes_02 │ Onset │ days since │ 11138 to │
│ │ Dormancy │ 1970-01-01 │ 32766 │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ EVI_Amplitude.Num_Modes_01 │ EVI Amplit- │ NBAR-EVI2 │ 0 to │
├────────────────────────────┼─ude─────────┼────────────┼─10000────┤
│ EVI_Amplitude.Num_Modes_02 │ EVI Amplit- │ NBAR-EVI2 │ 0 to │
├────────────────────────────┼─ude─────────┼────────────┼─10000────┤
│ EVI_Area.Num_Modes_01 │ EVI Area │ NBAR-EVI2 │ 0 to │
├────────────────────────────┼─────────────┼────────────┼─3700─────┤
│ EVI_Area.Num_Modes_02 │ EVI Area │ NBAR-EVI2 │ 0 to │
├────────────────────────────┼─────────────┼────────────┼─3700─────┤
│ EVI_Minimum.Num_Modes_01 │ Minimum EVI │ NBAR-EVI2 │ 0 to │
├────────────────────────────┼─────────────┼────────────┼─10000────┤
│ EVI_Minimum.Num_Modes_02 │ Minimum EVI │ NBAR-EVI2 │ 0 to │
├────────────────────────────┼─────────────┼────────────┼─10000────┤
│ Greenup.Num_Modes_01 │ Onset │ days since │ 11138 to │
│ │ Greenness │ 1970-01-01 │ 32766 │
│ │ Increase │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ Greenup.Num_Modes_02 │ Onset │ days since │ 11138 to │
│ │ Greenness │ 1970-01-01 │ 32766 │
│ │ Increase │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ Maturity.Num_Modes_01 │ Onset │ days since │ 11138 to │
│ │ Maturity │ 1970-01-01 │ 32766 │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ Maturity.Num_Modes_02 │ Onset │ days since │ 11138 to │
│ │ Maturity │ 1970-01-01 │ 32766 │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ MidGreendown.Num_Modes_01 │ Middle │ days since │ 11138 to │
│ │ Greenness │ 1970-01-01 │ 32766 │
│ │ Decrease │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ MidGreendown.Num_Modes_02 │ Middle │ days since │ 11138 to │
│ │ Greenness │ 1970-01-01 │ 32766 │
│ │ Decrease │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ MidGreenup.Num_Modes_01 │ Middle │ days sinc- │ 11138 to │
│ │ Greenness │ e_19 70-0- │ 32766 │
│ │ Increase │ 1-01 │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ MidGreenup.Num_Modes_02 │ Middle │ days since │ 11138 to │
│ │ Greenness │ 1970-01-01 │ 32766 │
│ │ Increase │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ NumCycles │ Number of │ │ 0 to 7 │
│ │ Cycles │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ QA_Detailed.Num_Modes_01 │ Quality │ │ 0 to │
│ │ Assessment │ │ 16383 │
│ │ Detailed │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ QA_Detailed.Num_Modes_02 │ Quality │ │ 0 to │
│ │ Assessment │ │ 16383 │
│ │ Detailed │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ QA_Overall.Num_Modes_01 │ Quality │ │ 0 to 3 │
│ │ Assessment │ │ │
│ │ Overall │ │ │
├────────────────────────────┼─────────────┼────────────┼──────────┤
│ QA_Overall.Num_Modes_02 │ Quality │ │ 0 to 3 │
│ │ Assessment │ │ │
│ │ Overall │ │ │
╘════════════════════════════╧═════════════╧════════════╧══════════╛
MCD15A2H
┌─────────────────┬───────────────────────┬─────────┬──────────┐
│ band │ Description │ Units │ Range │
╞═════════════════╪═══════════════════════╪═════════╪══════════╡
│ FparExtra_QC │ Extra detail Quality │ class │ 0 to 254 │
│ │ for LAI and FPAR │ flag │ │
├─────────────────┼───────────────────────┼─────────┼──────────┤
│ FparLai_QC │ Quality for LAI and │ class │ 0 to 254 │
│ │ FPAR │ flag │ │
├─────────────────┼───────────────────────┼─────────┼──────────┤
│ FparStdDev_500m │ Standard deviation of │ percent │ 0 to 100 │
│ │ FPAR │ │ │
├─────────────────┼───────────────────────┼─────────┼──────────┤
│ Fpar_500m │ Fraction of │ percent │ 0 to 100 │
│ │ photosynthetically │ │ │
│ │ active radiation │ │ │
├─────────────────┼───────────────────────┼─────────┼──────────┤
│ LaiStdDev_500m │ Standard deviation │ m^2/m^2 │ 0 to 100 │
│ │ for LAI │ │ │
├─────────────────┼───────────────────────┼─────────┼──────────┤
│ Lai_500m │ Leaf area index │ m^2/m^2 │ 0 to 100 │
╘═════════════════╧═══════════════════════╧═════════╧══════════╛
MCD15A3H
┌─────────────────┬──────────────────────┬─────────┬──────────┐
│ band │ Description │ Units │ Range │
╞═════════════════╪══════════════════════╪═════════╪══════════╡
│ FparExtra_QC │ Extra detail Quality │ class │ 0 to 254 │
│ │ for LAI and FPAR │ flag │ │
├─────────────────┼──────────────────────┼─────────┼──────────┤
│ FparLai_QC │ Quality for LAI and │ class │ 0 to 254 │
│ │ FPAR │ flag │ │
├─────────────────┼──────────────────────┼─────────┼──────────┤
│ FparStdDev_500m │ Standard deviation │ percent │ 0 to 100 │
│ │ of FPAR │ │ │
├─────────────────┼──────────────────────┼─────────┼──────────┤
│ Fpar_500m │ Fraction of │ percent │ 0 to 100 │
│ │ photosynthetically │ │ │
│ │ active radiation │ │ │
├─────────────────┼──────────────────────┼─────────┼──────────┤
│ LaiStdDev_500m │ Standard deviation │ m^2/m^2 │ 0 to 100 │
│ │ for LAI │ │ │
├─────────────────┼──────────────────────┼─────────┼──────────┤
│ Lai_500m │ Leaf area index │ m^2/m^2 │ 0 to 100 │
╘═════════════════╧══════════════════════╧═════════╧══════════╛
MCD19A3
┌────────────┬──────────────────────────────┬───────────┐
│ band │ Description │ Range │
╞════════════╪══════════════════════════════╪═══════════╡
│ Kgeo │ RTLS geometric kernel │ -32766 to │
│ │ parameter for bands 1-8 │ 32767 │
├────────────┼──────────────────────────────┼───────────┤
│ Kiso │ RTLS isotropic kernel │ -32766 to │
│ │ parameter for bands 1-8 │ 32767 │
├────────────┼──────────────────────────────┼───────────┤
│ Kvol │ RTLS volumetric kernel │ -32766 to │
│ │ parameter for bands 1-8 │ 32767 │
├────────────┼──────────────────────────────┼───────────┤
│ Sur_albedo │ Surface albedo for bands 1-8 │ -100 to │
│ │ │ 16000 │
├────────────┼──────────────────────────────┼───────────┤
│ UpdateDay │ Number of days since last │ 0 to 254 │
│ │ update to the current day │ │
╘════════════╧══════════════════════════════╧═══════════╛
MCD43A
┌──────────────────┬────────────────────────────┐
│ band │ Description │
╞══════════════════╪════════════════════════════╡
│ nir_actual │ Blue-sky albedo nir │
├──────────────────┼────────────────────────────┤
│ nir_black │ Black-sky albedo nir │
├──────────────────┼────────────────────────────┤
│ nir_white │ White-sky albedo nir │
├──────────────────┼────────────────────────────┤
│ shortwave_actual │ Blue-sky albedo shortwave │
├──────────────────┼────────────────────────────┤
│ shortwave_black │ Black-sky albedo shortwave │
├──────────────────┼────────────────────────────┤
│ shortwave_white │ White-sky albedo shortwave │
├──────────────────┼────────────────────────────┤
│ vis_actual │ Blue-sky albedo vis │
├──────────────────┼────────────────────────────┤
│ vis_black │ Black-sky albedo vis │
├──────────────────┼────────────────────────────┤
│ vis_white │ White-sky albedo vis │
╘══════════════════╧════════════════════════════╛
MCD43A1
┌──────────────────────────────────────────────┬─────────────┬───────┬───────┐
│ band │ Description │ Units │ Range │
╞══════════════════════════════════════════════╪═════════════╪═══════╪═══════╡
│ BDRF_Albedo_Band_Mandatory_Quality_Band1 │ Quality │ bit │ 0 to │
│ │ Band1 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_Band2 │ Quality │ bit │ 0 to │
│ │ Band2 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_Band3 │ Quality │ bit │ 0 to │
│ │ Band3 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_Band4 │ Quality │ bit │ 0 to │
│ │ Band4 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_Band5 │ Quality │ bit │ 0 to │
│ │ Band5 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_Band6 │ Quality │ bit │ 0 to │
│ │ Band6 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_Band7 │ Quality │ bit │ 0 to │
│ │ Band7 │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_nir │ Quality nir │ bit │ 0 to │
│ │ │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_shortwave │ Quality │ bit │ 0 to │
│ │ shortwave │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BDRF_Albedo_Band_Mandatory_Quality_vis │ Quality vis │ bit │ 0 to │
│ │ │ field │ 254 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band1 │ Parameters │ │ 0 to │
│ │ Band1 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band2 │ Parameters │ │ 0 to │
│ │ Band2 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band3 │ Parameters │ │ 0 to │
│ │ Band3 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band4 │ Parameters │ │ 0 to │
│ │ Band4 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band5 │ Parameters │ │ 0 to │
│ │ Band5 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band6 │ Parameters │ │ 0 to │
│ │ Band6 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_Band7 │ Parameters │ │ 0 to │
│ │ Band7 │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_nir │ Parameters │ │ 0 to │
│ │ nir │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_shortwave │ Parameters │ │ 0 to │
│ │ shortwave │ │ 32766 │
├──────────────────────────────────────────────┼─────────────┼───────┼───────┤
│ BRDF_Albedo_Parameters_vis │ Parameters │ │ 0 to │
│ │ vis │ │ 32766 │
╘══════════════════════════════════════════════╧═════════════╧═══════╧═══════╛
MCD43A4
┌──────────────────────────────────────────┬─────────────┬──────────────┬─────────┐
│ band │ Description │ Units │ Range │
╞══════════════════════════════════════════╪═════════════╪══════════════╪═════════╡
│ BRDF_Albedo_Band_Mandatory_Quality_Band1 │ Quality │ concatenated │ 0 to │
│ │ Band1 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ BRDF_Albedo_Band_Mandatory_Quality_Band2 │ Quality │ concatenated │ 0 to │
│ │ Band2 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ BRDF_Albedo_Band_Mandatory_Quality_Band3 │ Quality │ concatenated │ 0 to │
│ │ Band3 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ BRDF_Albedo_Band_Mandatory_Quality_Band4 │ Quality │ concatenated │ 0 to │
│ │ Band4 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ BRDF_Albedo_Band_Mandatory_Quality_Band5 │ Quality │ concatenated │ 0 to │
│ │ Band5 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ BRDF_Albedo_Band_Mandatory_Quality_Band6 │ Quality │ concatenated │ 0 to │
│ │ Band6 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ BRDF_Albedo_Band_Mandatory_Quality_Band7 │ Quality │ concatenated │ 0 to │
│ │ Band7 │ flags │ 254 │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band1 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band1 │ │ │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band2 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band2 │ │ │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band3 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band3 │ │ │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band4 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band4 │ │ │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band5 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band5 │ │ │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band6 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band6 │ │ │
├──────────────────────────────────────────┼─────────────┼──────────────┼─────────┤
│ Nadir_Reflectance_Band7 │ Nadir │ │ 0 to │
│ │ Reflectance │ │ 32766 │
│ │ Band7 │ │ │
╘══════════════════════════════════════════╧═════════════╧══════════════╧═════════╛
MCD64A1
┌───────────────────────┬──────────────────┬───────┬───────┐
│ band │ Description │ Units │ Range │
╞═══════════════════════╪══════════════════╪═══════╪═══════╡
│ Burn_Date │ ordinal day of │ day │ 0 to │
│ │ burn │ of │ 366 │
├───────────────────────┼──────────────────┼─year──┼───────┤
│ Burn_Date_Uncertainty │ uncertainty in │ days │ 0 to │
│ │ day of burn │ │ 100 │
├───────────────────────┼──────────────────┼───────┼───────┤
│ First_Day │ first day of │ day │ 1 to │
│ │ reliable change │ of │ 366 │
│ │ detection │ year │ │
├───────────────────────┼──────────────────┼───────┼───────┤
│ Last_Day │ last day of │ day │ 1 to │
│ │ reliable change │ of │ 366 │
│ │ detection │ year │ │
├───────────────────────┼──────────────────┼───────┼───────┤
│ QA │ quality assuran- │ bit │ 0 to │
│ │ ce indicators │ field │ 255 │
╘═══════════════════════╧══════════════════╧═══════╧═══════╛
MOD09A1
┌──────────────────────┬─────────────────────┬─────────────┬────────────┐
│ band │ Description │ Units │ Range │
╞══════════════════════╪═════════════════════╪═════════════╪════════════╡
│ sur_refl_b01 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 1 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_b02 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 2 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_b03 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 3 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_b04 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 4 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_b05 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 5 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_b06 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 6 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_b07 │ Surface reflectance │ reflectance │ -100 to │
│ │ for band 7 │ │ 16000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_day of year │ Surface reflectance │ day of year │ 0 to 366 │
│ │ day of year │ │ │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_qc_500m │ Surface reflectance │ bit field │ 0 to 4294- │
│ │ 500m quality │ │ 966531 │
│ │ control flags │ │ │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_raz │ Relative azimuth │ degree │ -18000 to │
│ │ │ │ 18000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_state_500m │ Surface reflectance │ bit field │ 0 to 57343 │
│ │ 500m state flags │ │ │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_szen │ Solar zenith │ degree │ 0 to 18000 │
├──────────────────────┼─────────────────────┼─────────────┼────────────┤
│ sur_refl_vzen │ View zenith │ degree │ 0 to 18000 │
╘══════════════════════╧═════════════════════╧═════════════╧════════════╛
MOD11A2
┌──────────────────┬────────────────────┬─────────┬─────────┐
│ band │ Description │ Range │ Units │
╞══════════════════╪════════════════════╪═════════╪═════════╡
│ Clear_sky_days │ Day clear-sky │ 1 to │ │
│ │ coverage │ 255 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Clear_sky_nights │ Night clear-sky │ 1 to │ │
│ │ coverage │ 255 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Day_view_angl │ View zenith angle │ 0 to │ degree │
│ │ of day observation │ 130 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Day_view_time │ Local time of day │ 0 to │ hrs │
│ │ observation │ 240 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Emis_31 │ Band 31 emissivity │ 1 to │ │
├──────────────────┼────────────────────┼─255─────┼─────────┤
│ Emis_32 │ Band 32 emissivity │ 1 to │ │
├──────────────────┼────────────────────┼─255─────┼─────────┤
│ LST_Day_1km │ Daytime Land │ 7500 to │ degK │
│ │ Surface Temperatu- │ 65535 │ │
├──────────────────┼─re─────────────────┼─────────┼─────────┤
│ LST_Night_1km │ Night Land Surface │ 7500 to │ degK │
│ │ Temperature │ 65535 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Night_view_angl │ View zenith angle │ 0 to │ degree │
│ │ of night observat- │ 130 │ │
├──────────────────┼─ion────────────────┼─────────┼─────────┤
│ Night_view_time │ Local time of │ 0 to │ hrs │
│ │ night observation │ 240 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ QC_Day │ Daytime LST │ 0 to │ │
│ │ Quality Indicators │ 255 │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ QC_Night │ Nighttime LST │ 0 to │ │
│ │ Quality indicators │ 255 │ │
╘══════════════════╧════════════════════╧═════════╧═════════╛
MOD13Q1
┌────────────────────────────────────────┬───────────────┬─────────────┬──────────┐
│ band │ Description │ Units │ Range │
╞════════════════════════════════════════╪═══════════════╪═════════════╪══════════╡
│ 250m_16_days_blue_reflectance │ Surface │ reflectance │ 0 to │
│ │ Reflectance │ │ 10000 │
│ │ Band 3 │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_composite_day_of_the_year │ Day of year │ day of year │ 1 to 366 │
│ │ VI pixel │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_EVI │ 16 day EVI │ │ -2000 to │
│ │ average │ │ 10000 │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_MIR_reflectance │ Surface │ reflectance │ 0 to │
│ │ Reflectance │ │ 10000 │
│ │ Band 7 │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_NDVI │ 16 day NDVI │ │ -2000 to │
│ │ average │ │ 10000 │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_NIR_reflectance │ Surface │ reflectance │ 0 to │
│ │ Reflectance │ │ 10000 │
│ │ Band 2 │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_pixel_reliability │ Quality │ rank │ 0 to 3 │
│ │ reliability │ │ │
│ │ of VI pixel │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_red_reflectance │ Surface │ reflectance │ 0 to │
│ │ Reflectance │ │ 10000 │
│ │ Band 1 │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_relative_azimuth_angle │ Relative │ degrees │ -3600 to │
│ │ azimuth angle │ │ 3600 │
│ │ of VI pixel │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_sun_zenith_angle │ Sun zenith │ degrees │ -9000 to │
│ │ angle of VI │ │ 9000 │
│ │ pixel │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_view_zenith_angle │ View zenith │ degrees │ -9000 to │
│ │ angle of VI │ │ 9000 │
│ │ Pixel │ │ │
├────────────────────────────────────────┼───────────────┼─────────────┼──────────┤
│ 250m_16_days_VI_Quality │ VI quality │ bit field │ 0 to │
│ │ indicators │ │ 65534 │
╘════════════════════════════════════════╧═══════════════╧═════════════╧══════════╛
MOD14A2
┌──────────┬───────────────┬────────────┬─────────┐
│ band │ Description │ Units │ Range │
╞══════════╪═══════════════╪════════════╪═════════╡
│ FireMask │ fire mask │ class flag │ 1 to 9 │
├──────────┼───────────────┼────────────┼─────────┤
│ QA │ pixel quality │ bit field │ 0 to 6 │
╘══════════╧═══════════════╧════════════╧═════════╛
MOD15A2H
┌─────────────────┬──────────────────────────┬─────────┬───────┐
│ band │ Description │ Units │ Range │
╞═════════════════╪══════════════════════════╪═════════╪═══════╡
│ FparExtra_QC │ Extra detail Quality for │ class │ 0 to │
│ │ LAI and FPAR │ flag │ 254 │
├─────────────────┼──────────────────────────┼─────────┼───────┤
│ FparLai_QC │ Quality for LAI and FPAR │ class │ 0 to │
│ │ │ flag │ 254 │
├─────────────────┼──────────────────────────┼─────────┼───────┤
│ FparStdDev_500m │ Standard deviation for │ percent │ 0 to │
│ │ FPAR │ │ 100 │
├─────────────────┼──────────────────────────┼─────────┼───────┤
│ Fpar_500m │ Fraction of photosynthe- │ percent │ 0 to │
│ │ tically active radiation │ │ 100 │
│ │ │ │ │
├─────────────────┼──────────────────────────┼─────────┼───────┤
│ LaiStdDev_500m │ Standard deviation for │ m^2/m^2 │ 0 to │
│ │ LAI │ │ 100 │
├─────────────────┼──────────────────────────┼─────────┼───────┤
│ Lai_500m │ Leaf area index │ m^2/m^2 │ 0 to │
│ │ │ │ 100 │
╘═════════════════╧══════════════════════════╧═════════╧═══════╛
MOD16A2
┌────────────┬──────────────────────────┬─────────────┬────────┐
│ band │ Description │ Units │ Range │
╞════════════╪══════════════════════════╪═════════════╪════════╡
│ ET_500m │ Evapotranspiration │ kg/m^2/8day │ -32767 │
│ │ │ │ to 32- │
├────────────┼──────────────────────────┼─────────────┼─700────┤
│ ET_QC_500m │ QC for ET/LE │ │ 0 to │
├────────────┼──────────────────────────┼─────────────┼─254────┤
│ LE_500m │ Latent heat flux (LE) │ J/m^2/day │ -32767 │
│ │ │ │ to 32- │
├────────────┼──────────────────────────┼─────────────┼─700────┤
│ PET_500m │ Potential evapotranspir- │ kg/m^2/8day │ -32767 │
│ │ ation │ │ to 32- │
├────────────┼──────────────────────────┼─────────────┼─700────┤
│ PLE_500m │ Potential latent heat │ J/m^2/day │ -32767 │
│ │ flux (LE) │ │ to 32- │
╘════════════╧══════════════════════════╧═════════════╧═700════╛
MOD17A2H
┌─────────────┬────────────────────────┬──────────────┬────────┐
│ band │ Description │ Units │ Range │
╞═════════════╪════════════════════════╪══════════════╪════════╡
│ Gpp_500m │ Gross Primary │ kgC/m^2/8day │ 0 to │
│ │ Production │ │ 30000 │
├─────────────┼────────────────────────┼──────────────┼────────┤
│ PsnNet_500m │ Net Photosynthesis │ kgC/m^2/8day │ -30000 │
│ │ │ │ to 30- │
├─────────────┼────────────────────────┼──────────────┼─000────┤
│ Psn_QC_500m │ Quality Control bits │ │ 0 to │
╘═════════════╧════════════════════════╧══════════════╧═254════╛
MOD17A3HGF
┌─────────────┬──────────────────────────┬────────────┬────────┐
│ band │ Description │ Units │ Range │
╞═════════════╪══════════════════════════╪════════════╪════════╡
│ Npp_500m │ Net Primary Productivity │ kg_C/m^2 │ -30000 │
│ │ │ │ to 32- │
├─────────────┼──────────────────────────┼────────────┼─700────┤
│ Npp_QC_500m │ Quality Control Bits │ percentage │ 0 to │
╘═════════════╧══════════════════════════╧════════════╧═100════╛
MOD21A2
┌──────────────────┬─────────────────────────────┬───────┬────────┐
│ band │ Description │ Range │ Units │
╞══════════════════╪═════════════════════════════╪═══════╪════════╡
│ Emis_29 │ Band 29 emissivity │ 1 to │ │
│ │ │ 255 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ Emis_31 │ Band 31 emissivity │ 1 to │ │
│ │ │ 255 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ Emis_32 │ Band 32 emissivity │ 1 to │ │
│ │ │ 255 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ LST_Day_1KM │ 8-day daytime 1km grid │ 7500 │ degK │
│ │ Land- surface Temperature │ to │ │
├──────────────────┼─────────────────────────────┼─65535─┼────────┤
│ LST_Night_1KM │ 8-day nighttime 1km grid │ 7500 │ degK │
│ │ Land- surface Temperature │ to │ │
├──────────────────┼─────────────────────────────┼─65535─┼────────┤
│ QC_Day │ Quality control for daytime │ 0 to │ │
│ │ LST and emissivity │ 255 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ QC_Night │ Quality control for │ 0 to │ │
│ │ nighttime LST and │ 255 │ │
├──────────────────┼─emissivity──────────────────┼───────┼────────┤
│ View_Angle_Day │ Average view zenith angle │ 0 to │ degree │
│ │ of daytime temperature │ 130 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ View_Angle_Night │ Average view zenith angle │ 0 to │ degree │
│ │ of nighttime temperature │ 130 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ View_Time_Day │ Average time of daytime │ 0 to │ hrs │
│ │ observation │ 240 │ │
├──────────────────┼─────────────────────────────┼───────┼────────┤
│ View_Time_Night │ Average time of nighttime │ 0 to │ hrs │
│ │ observation │ 240 │ │
╘══════════════════╧═════════════════════════════╧═══════╧════════╛
MOD44B
┌────────────────────────────┬───────────────────────┬─────────┬───────┐
│ band │ Description │ Units │ Range │
╞════════════════════════════╪═══════════════════════╪═════════╪═══════╡
│ Cloud │ Cloud cover │ bit │ 0 to │
│ │ indicators │ field │ 255 │
├────────────────────────────┼───────────────────────┼─────────┼───────┤
│ Percent_NonTree_Vegetation │ Percent nontree │ percent │ 0 to │
│ │ vegetation │ │ 100 │
├────────────────────────────┼───────────────────────┼─────────┼───────┤
│ Percent_NonVegetated │ Percent non-vegetated │ percent │ 0 to │
│ │ │ │ 100 │
├────────────────────────────┼───────────────────────┼─────────┼───────┤
│ Percent_NonVegetated_SD │ percent non-vegetated │ percent │ 0 to │
│ │ SD │ │ 10000 │
├────────────────────────────┼───────────────────────┼─────────┼───────┤
│ Percent_Tree_Cover │ Percent tree cover │ percent │ 0 to │
│ │ │ │ 100 │
├────────────────────────────┼───────────────────────┼─────────┼───────┤
│ Percent_Tree_Cover_SD │ percent tree cover SD │ percent │ 0 to │
│ │ │ │ 10000 │
├────────────────────────────┼───────────────────────┼─────────┼───────┤
│ Quality │ Quality Control │ bit │ 0 to │
│ │ indicators │ field │ 255 │
╘════════════════════════════╧═══════════════════════╧═════════╧═══════╛
MYD09A1
┌──────────────────────┬────────────────────┬─────────────┬────────────┐
│ band │ Description │ Units │ Range │
╞══════════════════════╪════════════════════╪═════════════╪════════════╡
│ sur_refl_b01 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 1 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_b02 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 2 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_b03 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 3 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_b04 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 4 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_b05 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 5 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_b06 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 6 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_b07 │ Surface reflectan- │ reflectance │ -100 to │
│ │ ce for band 7 │ │ 16000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_day of year │ Surface reflectan- │ day of year │ 0 to 366 │
│ │ ce day of year │ │ │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_qc_500m │ Surface reflectan- │ bit field │ 0 to 4294- │
│ │ ce 500m quality │ │ 966531 │
│ │ control flags │ │ │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_raz │ Relative azimuth │ degree │ -18000 to │
│ │ │ │ 18000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_state_500m │ Surface reflectan- │ bit field │ 0 to 57343 │
│ │ ce 500m state │ │ │
├──────────────────────┼─flags──────────────┼─────────────┼────────────┤
│ sur_refl_szen │ Solar zenith │ degree │ 0 to 18000 │
├──────────────────────┼────────────────────┼─────────────┼────────────┤
│ sur_refl_vzen │ View zenith │ degree │ 0 to 18000 │
╘══════════════════════╧════════════════════╧═════════════╧════════════╛
MYD11A2
┌──────────────────┬─────────────────────────┬─────────┬────────┐
│ band │ Description │ Range │ Units │
╞══════════════════╪═════════════════════════╪═════════╪════════╡
│ Clear_sky_days │ Day clear-sky coverage │ 1 to │ │
├──────────────────┼─────────────────────────┼─255─────┼────────┤
│ Clear_sky_nights │ Night clear-sky │ 1 to │ │
├──────────────────┼─coverage────────────────┼─255─────┼────────┤
│ Day_view_angl │ View zenith angle of │ 0 to │ degree │
│ │ day observation │ 130 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ Day_view_time │ Local time of day │ 0 to │ hrs │
│ │ observation │ 240 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ Emis_31 │ Band 31 emissivity │ 1 to │ │
├──────────────────┼─────────────────────────┼─255─────┼────────┤
│ Emis_32 │ Band 32 emissivity │ 1 to │ │
├──────────────────┼─────────────────────────┼─255─────┼────────┤
│ LST_Day_1km │ Daytime Land Surface │ 7500 to │ degK │
│ │ Temperature │ 65535 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ LST_Night_1km │ Night Land Surface │ 7500 to │ degK │
│ │ Temperature │ 65535 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ Night_view_angl │ View zenith angle of │ 0 to │ degree │
│ │ night observation │ 130 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ Night_view_time │ Local time of night │ 0 to │ hrs │
│ │ observation │ 240 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ QC_Day │ Daytime LST Quality │ 0 to │ │
│ │ Indicators │ 255 │ │
├──────────────────┼─────────────────────────┼─────────┼────────┤
│ QC_Night │ Nighttime LST Quality │ 0 to │ │
│ │ indicators │ 255 │ │
╘══════════════════╧═════════════════════════╧═════════╧════════╛
MYD13Q1
┌────────────────────────────────────────┬────────────────────┬─────────────┬───────┐
│ band │ Description │ Units │ Range │
╞════════════════════════════════════════╪════════════════════╪═════════════╪═══════╡
│ 250m_16_days_blue_reflectance │ Surface Reflectan- │ reflectance │ 0 to │
│ │ ce Band 3 │ │ 10000 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_composite_day_of_the_year │ Day of year VI │ day of year │ 1 to │
│ │ pixel │ │ 366 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_EVI │ 16 day EVI average │ │ -2000 │
│ │ │ │ to │
│ │ │ │ 10000 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_MIR_reflectance │ Surface Reflectan- │ reflectance │ 0 to │
│ │ ce Band 7 │ │ 10000 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_NDVI │ 16 day NDVI │ │ -2000 │
│ │ average │ │ to │
│ │ │ │ 10000 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_NIR_reflectance │ Surface Reflectan- │ reflectance │ 0 to │
│ │ ce Band 2 │ │ 10000 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_pixel_reliability │ Quality reliabili- │ rank │ 0 to │
│ │ ty of VI pixel │ │ 3 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_red_reflectance │ Surface Reflectan- │ reflectance │ 0 to │
│ │ ce Band 1 │ │ 10000 │
├────────────────────────────────────────┼────────────────────┼─────────────┼───────┤
│ 250m_16_days_relative_azimuth_angle │ Relative azimuth │ degrees │ -3600 │
│ │ angle of VI pixel │ │ to │
├────────────────────────────────────────┼────────────────────┼─────────────┼─3600──┤
│ 250m_16_days_sun_zenith_angle │ Sun zenith angle │ degrees │ -9000 │
│ │ of VI pixel │ │ to │
├────────────────────────────────────────┼────────────────────┼─────────────┼─9000──┤
│ 250m_16_days_view_zenith_angle │ View zenith angle │ degrees │ -9000 │
│ │ of VI Pixel │ │ to │
├────────────────────────────────────────┼────────────────────┼─────────────┼─9000──┤
│ 250m_16_days_VI_Quality │ VI quality │ bit field │ 0 to │
│ │ indicators │ │ 65534 │
╘════════════════════════════════════════╧════════════════════╧═════════════╧═══════╛
MYD14A2
┌──────────┬───────────────┬────────────┬─────────┐
│ band │ Description │ Units │ Range │
╞══════════╪═══════════════╪════════════╪═════════╡
│ FireMask │ fire mask │ class flag │ 1 to 9 │
├──────────┼───────────────┼────────────┼─────────┤
│ QA │ pixel quality │ bit field │ 0 to 6 │
╘══════════╧═══════════════╧════════════╧═════════╛
MYD15A2H
┌─────────────────┬────────────────────────────┬─────────┬───────┐
│ band │ Description │ Units │ Range │
╞═════════════════╪════════════════════════════╪═════════╪═══════╡
│ FparExtra_QC │ Extra detail Quality for │ class │ 0 to │
│ │ LAI and FPAR │ flag │ 254 │
├─────────────────┼────────────────────────────┼─────────┼───────┤
│ FparLai_QC │ Quality for LAI and FPAR │ class │ 0 to │
│ │ │ flag │ 254 │
├─────────────────┼────────────────────────────┼─────────┼───────┤
│ FparStdDev_500m │ Standard deviation for │ percent │ 0 to │
│ │ FPAR │ │ 100 │
├─────────────────┼────────────────────────────┼─────────┼───────┤
│ Fpar_500m │ Fraction of photosyntheti- │ percent │ 0 to │
│ │ cally active radiation │ │ 100 │
│ │ │ │ │
├─────────────────┼────────────────────────────┼─────────┼───────┤
│ LaiStdDev_500m │ Standard deviation for LAI │ m^2/m^2 │ 0 to │
│ │ │ │ 100 │
├─────────────────┼────────────────────────────┼─────────┼───────┤
│ Lai_500m │ Leaf area index │ m^2/m^2 │ 0 to │
│ │ │ │ 100 │
╘═════════════════╧════════════════════════════╧═════════╧═══════╛
MYD16A2
┌────────────┬────────────────────────────┬─────────────┬────────┐
│ band │ Description │ Units │ Range │
╞════════════╪════════════════════════════╪═════════════╪════════╡
│ ET_500m │ Evapotranspiration │ kg/m^2/8day │ -32767 │
│ │ │ │ to 32- │
├────────────┼────────────────────────────┼─────────────┼─700────┤
│ ET_QC_500m │ QC for ET/LE │ │ 0 to │
├────────────┼────────────────────────────┼─────────────┼─254────┤
│ LE_500m │ Latent heat flux (LE) │ J/m^2/day │ -32767 │
│ │ │ │ to 32- │
├────────────┼────────────────────────────┼─────────────┼─700────┤
│ PET_500m │ Potential evapotranspirat- │ kg/m^2/8day │ -32767 │
│ │ ion │ │ to 32- │
├────────────┼────────────────────────────┼─────────────┼─700────┤
│ PLE_500m │ Potential latent heat flux │ J/m^2/day │ -32767 │
│ │ (LE) │ │ to 32- │
╘════════════╧════════════════════════════╧═════════════╧═700════╛
MYD17A2H
┌─────────────┬────────────────────────┬──────────────┬────────┐
│ band │ Description │ Units │ Range │
╞═════════════╪════════════════════════╪══════════════╪════════╡
│ Gpp_500m │ Gross Primary │ kgC/m^2/8day │ 0 to │
│ │ Production │ │ 30000 │
├─────────────┼────────────────────────┼──────────────┼────────┤
│ PsnNet_500m │ Net Photosynthesis │ kgC/m^2/8day │ -30000 │
│ │ │ │ to 30- │
├─────────────┼────────────────────────┼──────────────┼─000────┤
│ Psn_QC_500m │ Quality Control bits │ │ 0 to │
╘═════════════╧════════════════════════╧══════════════╧═254════╛
MYD17A3HGF
┌─────────────┬────────────────────────┬────────────┬────────┐
│ band │ Description │ Units │ Range │
╞═════════════╪════════════════════════╪════════════╪════════╡
│ Npp_500m │ Net Primary │ kg_C/m^2 │ -30000 │
│ │ Productivity │ │ to 32- │
├─────────────┼────────────────────────┼────────────┼─700────┤
│ Npp_QC_500m │ Quality Control Bits │ percentage │ 0 to │
╘═════════════╧════════════════════════╧════════════╧═100════╛
MYD21A2
┌──────────────────┬────────────────────────────────┬─────────┬────────┐
│ band │ Description │ Range │ Units │
╞══════════════════╪════════════════════════════════╪═════════╪════════╡
│ Emis_29 │ Band 29 emissivity │ 1 to │ │
├──────────────────┼────────────────────────────────┼─255─────┼────────┤
│ Emis_31 │ Band 31 emissivity │ 1 to │ │
├──────────────────┼────────────────────────────────┼─255─────┼────────┤
│ Emis_32 │ Band 32 emissivity │ 1 to │ │
├──────────────────┼────────────────────────────────┼─255─────┼────────┤
│ LST_Day_1KM │ 8-day daytime 1km grid Land- │ 7500 to │ degK │
│ │ surface Temperature │ 65535 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ LST_Night_1KM │ 8-day nighttime 1km grid Land- │ 7500 to │ degK │
│ │ surface Temperature │ 65535 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ QC_Day │ Quality control for daytime │ 0 to │ │
│ │ LST and emissivity │ 255 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ QC_Night │ Quality control for nighttime │ 0 to │ │
│ │ LST and emissivity │ 255 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ View_Angle_Day │ Average view zenith angle of │ 0 to │ degree │
│ │ daytime temperature │ 130 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ View_Angle_Night │ Average view zenith angle of │ 0 to │ degree │
│ │ nighttime temperature │ 130 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ View_Time_Day │ Average time of daytime │ 0 to │ hrs │
│ │ observation │ 240 │ │
├──────────────────┼────────────────────────────────┼─────────┼────────┤
│ View_Time_Night │ Average time of nighttime │ 0 to │ hrs │
│ │ observation │ 240 │ │
╘══════════════════╧════════════════════════════════╧═════════╧════════╛
SIF005
┌───────────────────────┬────────────────────────────────┬─────────────┐
│ band │ Description │ Units │
╞═══════════════════════╪════════════════════════════════╪═════════════╡
│ EVI_Quality │ MODIS enhanced vegetation │ bit field │
│ │ index quality flag │ │
├───────────────────────┼────────────────────────────────┼─────────────┤
│ SIF_740_daily_corr │ daily corrected SIF at 740nm │ mW/m2/nm/sr │
├───────────────────────┼────────────────────────────────┼─────────────┤
│ SIF_740_daily_corr_SD │ uncertainty of daily corrected │ mW/m2/nm/sr │
│ │ SIF at 740nm │ │
╘═══════════════════════╧════════════════════════════════╧═════════════╛
SIF_ANN
┌─────────┬────────────────────────────────┬─────────────┐
│ band │ Description │ Units │
╞═════════╪════════════════════════════════╪═════════════╡
│ sif_ann │ mean solar-induced chlorophyll │ mW/m2/nm/sr │
│ │ fluorescence modeled by an ANN │ │
╘═════════╧════════════════════════════════╧═════════════╛
VNP09A1
┌─────────────────────────┬──────────────────────────────┬─────────────┬────────────┐
│ band │ Description │ Units │ Range │
╞═════════════════════════╪══════════════════════════════╪═════════════╪════════════╡
│ RelativeAzimuth │ Relative azimuth │ degree │ -18000 to │
│ │ │ │ 18000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SensorZenith │ View zenith │ degree │ 0 to 18000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SolarZenith │ Solar zenith │ degree │ 0 to 18000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_day of year │ Surface reflectance day of │ day of year │ 1 to 366 │
│ │ year │ │ │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M1 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M1 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M10 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M10 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M11 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M11 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M2 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M2 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M3 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M3 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M4 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M4 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M5 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M5 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M7 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M7 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_M8 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ M8 │ │ 16000 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_QC │ Surface reflectance quality │ bit field │ 0 to 2147- │
│ │ control flags │ │ 483647 │
├─────────────────────────┼──────────────────────────────┼─────────────┼────────────┤
│ SurfReflect_State │ Surface reflectance state │ bit field │ 0 to 13311 │
│ │ flags │ │ │
╘═════════════════════════╧══════════════════════════════╧═════════════╧════════════╛
VNP09H1
┌────────────────────────┬────────────────────────────────┬─────────────┬─────────┐
│ band │ Description │ Units │ Range │
╞════════════════════════╪════════════════════════════════╪═════════════╪═════════╡
│ SurfReflect_I1 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ I1 │ │ 16000 │
├────────────────────────┼────────────────────────────────┼─────────────┼─────────┤
│ SurfReflect_I2 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ I2 │ │ 16000 │
├────────────────────────┼────────────────────────────────┼─────────────┼─────────┤
│ SurfReflect_I3 │ Surface reflectance for band │ reflectance │ -100 to │
│ │ I3 │ │ 16000 │
├────────────────────────┼────────────────────────────────┼─────────────┼─────────┤
│ SurfReflect_QC_500m │ Surface reflectance 250m │ bit field │ 0 to │
│ │ quality control flags │ │ 32767 │
├────────────────────────┼────────────────────────────────┼─────────────┼─────────┤
│ SurfReflect_State_500m │ Surface reflectance 250m state │ bit field │ 0 to │
│ │ flags │ │ 13311 │
╘════════════════════════╧════════════════════════════════╧═════════════╧═════════╛
VNP13A1
┌─────────────────────────────────────────┬───────────────────────────────┬─────────────┬───────────┐
│ band │ Description │ Units │ Range │
╞═════════════════════════════════════════╪═══════════════════════════════╪═════════════╪═══════════╡
│ 500_m_16_days_blue_reflectance │ Blue band (M3 478-498 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_composite_day_of_the_year │ Day of the year │ day of year │ 1 to 366 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_EVI │ 16 day EVI average │ │ -10000 to │
│ │ │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_EVI2 │ 16 day EVI2 average │ │ -10000 to │
│ │ │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_green_reflectance │ Green band (M4 545-565 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_NDVI │ 16 day NDVI average │ │ -10000 to │
│ │ │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_NIR_reflectance │ NIR band (I2 846-885 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_pixel_reliability │ Quality reliability │ rank │ 0 to 11 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_red_reflectance │ Red band (I1 600-680 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_relative_azimuth_angle │ Relative azimuth angle │ degrees │ -18000 to │
│ │ │ │ 18000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_sun_zenith_angle │ Sun zenith angle │ degrees │ 0 to │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼─18000─────┤
│ 500_m_16_days_SWIR1_reflectance │ SWIR1 band (M8 1230-1250 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_SWIR2_reflectance │ SWIR2 band (M10 1580-1640 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_SWIR3_reflectance │ SWIR3 band (M11 2225-2275 nm) │ reflectance │ 0 to │
│ │ reflectance │ │ 10000 │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼───────────┤
│ 500_m_16_days_view_zenith_angle │ View zenith angle │ degrees │ 0 to │
├─────────────────────────────────────────┼───────────────────────────────┼─────────────┼─18000─────┤
│ 500_m_16_days_VI_Quality │ VI quality indicators │ bit field │ 0 to │
╘═════════════════════════════════════════╧═══════════════════════════════╧═════════════╧═65534═════╛
VNP15A2H
┌──────────────┬────────────────────────────┬──────────┬─────────┐
│ band │ Description │ Units │ Range │
╞══════════════╪════════════════════════════╪══════════╪═════════╡
│ Fpar │ Fraction of photosyntheti- │ fraction │ 0 to │
│ │ cally active radiation │ │ 100 │
│ │ │ │ │
├──────────────┼────────────────────────────┼──────────┼─────────┤
│ FparExtra_QC │ Extra detail Quality for │ class │ 0 to │
│ │ LAI and FPAR │ flag │ 254 │
├──────────────┼────────────────────────────┼──────────┼─────────┤
│ FparLai_QC │ Quality for LAI and FPAR │ class │ 0 to │
├──────────────┼────────────────────────────┼─flag─────┼─254─────┤
│ FparStdDev │ Standard deviation for │ fraction │ 0 to │
├──────────────┼─FPAR───────────────────────┼──────────┼─100─────┤
│ Lai │ Leaf area index │ m^2/m^2 │ 0 to │
├──────────────┼────────────────────────────┼──────────┼─100─────┤
│ LaiStdDev │ Standard deviation for LAI │ m^2/m^2 │ 0 to │
╘══════════════╧════════════════════════════╧══════════╧═100═════╛
VNP21A2
┌──────────────────┬────────────────────┬─────────┬─────────┐
│ band │ Description │ Units │ Range │
╞══════════════════╪════════════════════╪═════════╪═════════╡
│ Emis_14 │ Average Band 14 │ │ 1 to │
│ │ emissivity │ │ 255 │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Emis_15 │ Average Band 15 │ │ 1 to │
│ │ emissivity │ │ 255 │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ Emis_16 │ Average Band 16 │ │ 1 to │
│ │ emissivity │ │ 255 │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ LST_Day_1KM │ Daytime Land- │ degK │ 7500 to │
│ │ surface Temperatu- │ │ 65535 │
├──────────────────┼─re─────────────────┼─────────┼─────────┤
│ LST_Night_1KM │ Nighttime Land- │ degK │ 7500 to │
│ │ surface Temperatu- │ │ 65535 │
├──────────────────┼─re─────────────────┼─────────┼─────────┤
│ QC_Day │ Quality control │ │ 1 to │
│ │ for daytime LST │ │ 255 │
│ │ and emissivity │ │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ QC_Night │ Quality control │ │ 1 to │
│ │ for nighttime LST │ │ 255 │
│ │ and emissivity │ │ │
├──────────────────┼────────────────────┼─────────┼─────────┤
│ View_Angle_Day │ Average view │ degree │ 0 to │
│ │ zenith angle of │ │ 130 │
│ │ daytime temperatu- │ │ │
├──────────────────┼─re─────────────────┼─────────┼─────────┤
│ View_Angle_Night │ Average view │ degree │ 0 to │
│ │ zenith angle of │ │ 130 │
│ │ nighttime │ │ │
├──────────────────┼─temperature────────┼─────────┼─────────┤
│ View_Time_Day │ Average time of │ hrs │ 0 to │
│ │ daytime observati- │ │ 240 │
├──────────────────┼─on─────────────────┼─────────┼─────────┤
│ View_Time_Night │ Average time of │ hrs │ 0 to │
│ │ nighttime │ │ 240 │
│ │ observation │ │ │
╘══════════════════╧════════════════════╧═════════╧═════════╛
VNP22Q2
┌──────────────────────────────────────────────┬────────────────────┬──────────┬─────────┐
│ band │ Description │ Units │ Range │
╞══════════════════════════════════════════════╪════════════════════╪══════════╪═════════╡
│ Cycle_1.Date_Mid_Greenup_Phase_1 │ Date at a mid- │ day of │ 1 to │
│ │ greenup phase │ year │ 32766 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Date_Mid_Senescence_Phase_1 │ Date at a mid- │ day of │ 1 to │
│ │ senescence phase │ year │ 32766 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.EVI2_Growing_Season_Area_1 │ Integrated EVI2 │ EVI2 │ 1 to │
│ │ during a growing │ │ 32766 │
│ │ season │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.EVI2_Onset_Greenness_Increase_1 │ EVI2 value at │ EVI2 │ 1 to │
│ │ greenup onset │ │ 10000 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.EVI2_Onset_Greenness_Maximum_1 │ EVI2 value at │ EVI2 │ 1 to │
│ │ maturity onset │ │ 10000 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.GLSP_QC_1 │ Global Land │ │ 0 to │
│ │ Surface Phenology │ │ 100 │
│ │ Quality Control │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Greenness_Agreement_Growing_Season_1 │ EVI2 agreement │ │ 0 to │
│ │ between modeled │ │ 100 │
│ │ values and raw │ │ │
│ │ observations │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Growing_Season_Length_1 │ Growing Season │ number │ 1 to │
│ │ Length │ of days │ 366 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Onset_Greenness_Decrease_1 │ Date at which │ day of │ 1 to │
│ │ canopy greenness │ year │ 32766 │
│ │ begins to decrease │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Onset_Greenness_Increase_1 │ Date of onset of │ day of │ 1 to │
│ │ greenness increase │ year │ 32766 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Onset_Greenness_Maximum_1 │ Date at which │ day of │ 1 to │
│ │ canopy greenness │ year │ 32766 │
│ │ approaches its │ │ │
├──────────────────────────────────────────────┼─seasonal maximum───┼──────────┼─────────┤
│ Cycle_1.Onset_Greenness_Minimum_1 │ Date at which │ day of │ 1 to │
│ │ canopy greenness │ year │ 32766 │
│ │ reaches a minimum │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.PGQ_Growing_Season_1 │ Proportion of good │ │ 1 to │
│ │ quality observati- │ │ 100 │
│ │ ons during a │ │ │
│ │ growing season │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.PGQ_Onset_Greenness_Decrease_1 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ senescence onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.PGQ_Onset_Greenness_Increase_1 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ greenup onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.PGQ_Onset_Greenness_Maximum_1 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ maturity onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.PGQ_Onset_Greenness_Minimum_1 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ dormancy onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Rate_Greenness_Decrease_1 │ Rates of change in │ EVI2/day │ 1 to │
│ │ EVI2 values during │ │ 32766 │
│ │ a senesce phase │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_1.Rate_Greenness_Increase_1 │ Rates of change in │ EVI2/day │ 1 to │
│ │ EVI2 values during │ │ 32766 │
│ │ a greenup phase │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Date_Mid_Greenup_Phase_2 │ Date at a mid- │ day of │ 1 to │
│ │ greenup phase │ year │ 32766 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Date_Mid_Senescence_Phase_2 │ Date at a mid- │ day of │ 1 to │
│ │ senescence phase │ year │ 32766 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.EVI2_Growing_Season_Area_2 │ Integrated EVI2 │ EVI2 │ 1 to │
│ │ during a growing │ │ 32766 │
│ │ season │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.EVI2_Onset_Greenness_Increase_2 │ EVI2 value at │ EVI2 │ 1 to │
│ │ greenup onset │ │ 10000 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.EVI2_Onset_Greenness_Maximum_2 │ EVI2 value at │ EVI2 │ 1 to │
│ │ maturity onset │ │ 10000 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.GLSP_QC_2 │ Global Land │ │ 0 to │
│ │ Surface Phenology │ │ 100 │
│ │ Quality Control │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Greenness_Agreement_Growing_Season_2 │ EVI2 agreement │ │ 0 to │
│ │ between modeled │ │ 100 │
│ │ values and raw │ │ │
│ │ observations │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Growing_Season_Length_2 │ Growing Season │ number_o │ 1 to │
│ │ Length │ f_ days │ 366 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Onset_Greenness_Decrease_2 │ Date at which │ day of │ 1 to │
│ │ canopy greenness │ year │ 32766 │
│ │ begins to decrease │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Onset_Greenness_Increase_2 │ Date of onset of │ day of │ 1 to │
│ │ greenness increase │ year │ 32766 │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Onset_Greenness_Maximum_2 │ Date at which │ day of │ 1 to │
│ │ canopy greenness │ year │ 32766 │
│ │ approaches its │ │ │
├──────────────────────────────────────────────┼─seasonal maximum───┼──────────┼─────────┤
│ Cycle_2.Onset_Greenness_Minimum_2 │ Date at which │ day of │ 1 to │
│ │ canopy greenness │ year │ 32766 │
│ │ reaches a minimum │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.PGQ_Growing_Season_2 │ Proportion of good │ │ 1 to │
│ │ quality observati- │ │ 100 │
│ │ ons during a │ │ │
│ │ growing season │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.PGQ_Onset_Greenness_Decrease_2 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ senescence onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.PGQ_Onset_Greenness_Increase_2 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ greenup onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.PGQ_Onset_Greenness_Maximum_2 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ maturity onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.PGQ_Onset_Greenness_Minimum_2 │ Proportion of good │ │ 1 to │
│ │ quality around │ │ 100 │
│ │ dormancy onset │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Rate_Greenness_Decrease_2 │ Rates of change in │ EVI2/day │ 1 to │
│ │ EVI2 values during │ │ 32766 │
│ │ a senesce phase │ │ │
├──────────────────────────────────────────────┼────────────────────┼──────────┼─────────┤
│ Cycle_2.Rate_Greenness_Increase_2 │ Rates of change in │ EVI2/day │ 1 to │
│ │ EVI2 values during │ │ 32766 │
│ │ a greenup phase │ │ │
╘══════════════════════════════════════════════╧════════════════════╧══════════╧═════════╛
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
[1mDocutils System Messages[0m
Unknown target name: "f".
ncei_annual#
$ tsgettoolbox ncei_annual --help
usage: tsgettoolbox ncei_annual [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags. For the ANNUAL
dataset, the flags are:
'Measurement','Quality','Days','Units'
The flags are described in the following tables.
More info: <[4;36mhttp://www1.ncdc.noaa.gov/pub/data/cdo/documentation/ANNUAL_-
documentation.pdf[0m>
Measurement flag
┌───────┬─────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═══════╪═════════════════════════════════════════════════════════════╡
│ A │ Accumulated amount. This value is a total that may include │
│ │ data from a previous month or months (TPCP) │
├───────┼─────────────────────────────────────────────────────────────┤
│ B │ Adjusted Total. Monthly value totals based on proportional │
│ │ available data across the entire month. (CLDD, HTDD. │
├───────┼─────────────────────────────────────────────────────────────┤
│ E │ An estimated monthly or annual total │
├───────┼─────────────────────────────────────────────────────────────┤
│ I │ Monthly means or totals based on incomplete time series. 1 │
│ │ to 9 days are missing. (MMNT,MMXP, MMXT, MNTM, TPCP, TSNW). │
├───────┼─────────────────────────────────────────────────────────────┤
│ M │ Used to indicate data element missing. │
├───────┼─────────────────────────────────────────────────────────────┤
│ S │ Precipitation for the amount is continuing to be │
│ │ accumulated. Total will be included in a subsequent value │
│ │ (TPCP). Example: Days 1-20 had 1.35 in of precipitation, │
│ │ then a period of accumulation began. The element TPCP would │
│ │ then be 00135S and the total accumulated amount value │
│ │ appears in a subsequent monthly value. If TPCP = 0 there │
│ │ was no precipitation measured during the month. flag 1 is │
│ │ set to "S" and the total accumulated amount appears in a │
├───────┼─subsequent monthly value.───────────────────────────────────┤
│ T │ Trace of precipitation, snowfall, or snow depth. The │
│ │ precipitation data value will = "00000". (EMXP, MXSD, TPCP, │
│ │ TSNW). │
├───────┼─────────────────────────────────────────────────────────────┤
│ + │ The phenomena in question occurred on several days. The │
│ │ date in the DAY field is the last day of occurrence. │
├───────┼─────────────────────────────────────────────────────────────┤
│ Blank │ No report. │
╘═══════╧═════════════════════════════════════════════════════════════╛
Quality flag
┌──────┬──────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════╡
│ A │ Accumulated amount │
├──────┼──────────────────────────────────────┤
│ E │ Estimated value │
├──────┼──────────────────────────────────────┤
│ + │ Value occurred on more than one day, │
│ │ last date of occurrence is used │
╘══════╧══════════════════════════════════════╛
Number of days flag
Number of days is given as 00 when all days in the month are considered in
computing data value or otherwise the maximum number of consecutive days in the
month considered in computing the data value.
Units flag
┌──────┬──────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ C │ Whole degree C │
├──────┼──────────────────────────────────────────────────────────────┤
│ D │ Whole F Degree Day │
├──────┼──────────────────────────────────────────────────────────────┤
│ F │ Whole degree F │
├──────┼──────────────────────────────────────────────────────────────┤
│ HI │ Hundredths of in │
├──────┼──────────────────────────────────────────────────────────────┤
│ I │ Whole in │
├──────┼──────────────────────────────────────────────────────────────┤
│ M │ Whole miles │
├──────┼──────────────────────────────────────────────────────────────┤
│ MH │ Miles per hour │
├──────┼──────────────────────────────────────────────────────────────┤
│ MM │ mm │
├──────┼──────────────────────────────────────────────────────────────┤
│ NA │ No units applicable (dimensionless) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TC │ Tenths of degrees C │
├──────┼──────────────────────────────────────────────────────────────┤
│ TF │ Tenths of degrees F │
├──────┼──────────────────────────────────────────────────────────────┤
│ TI │ Tenths of in │
├──────┼──────────────────────────────────────────────────────────────┤
│ TM │ Tenths of mm │
├──────┼──────────────────────────────────────────────────────────────┤
│ 1 │ Soils, degrees F, soil depths in in and hundredths │
├──────┼──────────────────────────────────────────────────────────────┤
│ 2 │ Soils, degrees C, soil depth in whole cm │
├──────┼──────────────────────────────────────────────────────────────┤
│ 3 │ Soils, degrees C, soil, soil depth in in and hundredths │
├──────┼──────────────────────────────────────────────────────────────┤
│ 4 │ Soils, degrees F, soil depth in whole cm │
├──────┼──────────────────────────────────────────────────────────────┤
│ 5 │ Soils, If the soil station closed during the current month, │
│ │ '5' indicates the station has closed. │
╘══════╧══════════════════════════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_ghcnd#
$ tsgettoolbox ncei_ghcnd --help
usage: tsgettoolbox ncei_ghcnd [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
Requires registration and free API key.
If you use this data, please read
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/readme.txt[0m> about "How to
cite".
GHCN (Global Historical Climatology Network)-Daily is an integrated database
of daily climate summaries from land surface stations across the globe. Like
its monthly counterpart (GHCN-Monthly), GHCN-Daily is comprised of daily
climate records from numerous sources that have been integrated and
subjected to a common suite of quality assurance reviews.
GHCN-Daily now contains records from over 75000 stations in 180 countries and
territories. Numerous daily variables are provided, including maximum and
minimum temperature, total daily precipitation, snowfall, and snow depth;
however, about two thirds of the stations report precipitation only. Both
the record length and period of record vary by station and cover intervals
ranging from less than year to more than 175 years.
The dataset is regularly reconstructed (usually every weekend) from its
20-plus data source components to ensure that GHCN-Daily is generally in
sync with its growing list of constituent sources. During this process,
quality assurance checks are applied to the full dataset. On most weekdays,
GHCN-Daily station data are updated when possible from a variety of data
streams, which also undergo a suite of quality checks.
Some of the data provided here are based on data exchanged under the World
Meteorological Organization (WMO) World Weather Watch Program according to
WMO Resolution 40 (Cg-XII). This allows WMO member countries to place
restrictions on the use or re-export of their data for commercial purposes
outside of the receiving country. Those countries' data summaries and
products which are available here are intended for free and unrestricted use
in research, education, and other non-commercial activities. For non-U.S.
locations' data, the data or any derived product shall not be provided to
other users or be used for the re-export of commercial services.
The five core values are:
┌──────┬────────────────────────────┐
│ Code │ Description │
╞══════╪════════════════════════════╡
│ TMAX │ Temperature MAX (degree C) │
├──────┼────────────────────────────┤
│ TMIN │ Temperature MIN (degree C) │
├──────┼────────────────────────────┤
│ PRCP │ PReCiPitation (mm) │
├──────┼────────────────────────────┤
│ SNOW │ SNOWfall (mm) │
├──────┼────────────────────────────┤
│ SNWD │ SNoW Depth (mm) │
╘══════╧════════════════════════════╛
Other possible data collected:
┌──────┬──────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ ACMC │ Average cloudiness midnight to midnight from 30-second │
│ │ ceilometer data (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACMH │ Average cloudiness midnight to midnight from manual │
│ │ observations (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSC │ Average cloudiness sunrise to sunset from 30-second │
│ │ ceilometer data (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSH │ Average cloudiness sunrise to sunset from manual │
│ │ observations (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ AWDR │ Average daily wind direction (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ AWND │ Average daily wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAEV │ Number of days included in the multiday evaporation total │
│ │ (MDEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAPR │ Number of days included in the multiday precipitation total │
│ │ (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DASF │ Number of days included in the multiday snowfall total │
├──────┼─(MDSF)───────────────────────────────────────────────────────┤
│ DATN │ Number of days included in the multiday minimum temperature │
│ │ (MDTN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DATX │ Number of days included in the multiday maximum temperature │
│ │ (MDTX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAWM │ Number of days included in the multiday wind movement (MDWM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DWPR │ Number of days with non-zero precipitation included in │
│ │ multiday precipitation total (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ EVAP │ Evaporation of water from evaporation pan (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FMTM │ Time of fastest mile or fastest 1-minute wind (hours and │
│ │ minutes, i.e., HHMM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGB │ Base of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGT │ Top of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRTH │ Thickness of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ GAHT │ Difference between river and gauge height (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDEV │ Multiday evaporation total (use with DAEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDPR │ Multiday precipitation total (mm; use with DAPR and DWPR, if │
│ │ available) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDSF │ Multiday snowfall total │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTN │ Multiday minimum temperature (degrees C; use with DATN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTX │ Multiday maximum temperature (degrees C; use with DATX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDWM │ Multiday wind movement (km) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MNPN │ Daily minimum temperature of water in an evaporation pan │
│ │ (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MXPN │ Daily maximum temperature of water in an evaporation pan │
│ │ (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ PGTM │ Peak gust time (hours and minutes, i.e., HHMM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ PSUN │ Daily percent of possible sunshine (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TAVG │ Average temperature (degrees C) [Note that TAVG from source │
│ │ 'S' corresponds to an average for the period ending at 2400 │
│ │ UTC rather than local midnight] │
├──────┼──────────────────────────────────────────────────────────────┤
│ THIC │ Thickness of ice on water (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TOBS │ Temperature at the time of observation (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TSUN │ Daily total sunshine (minutes) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF1 │ Direction of fastest 1-minute wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF2 │ Direction of fastest 2-minute wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF5 │ Direction of fastest 5-second wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFG │ Direction of peak wind gust (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFI │ Direction of highest instantaneous wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFM │ Fastest mile wind direction (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDMV │ 24-hour wind movement (km) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESD │ Water equivalent of snow on the ground (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESF │ Water equivalent of snowfall (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF1 │ Fastest 1-minute wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF2 │ Fastest 2-minute wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF5 │ Fastest 5-second wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFG │ Peak gust wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFI │ Highest instantaneous wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFM │ Fastest mile wind speed (meters per second) │
╘══════╧══════════════════════════════════════════════════════════════╛
SNXY and SXXY Table
┌───────┬─────────────────────────────────────────────────────────────┐
│ SNXY │ Minimum soil temperature (degrees C) where 'X' corresponds │
│ │ to a code for ground cover and 'Y' corresponds to a code │
│ │ for soil depth. │
╞═══════╪═════════════════════════════════════════════════════════════╡
│ │ Ground cover codes include the following: │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 0 │ unknown │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 1 │ grass │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 2 │ fallow │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 3 │ bare ground │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 4 │ brome grass │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 5 │ sod │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 6 │ straw mulch │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 7 │ grass muck │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 8 │ bare muck │
├───────┼─────────────────────────────────────────────────────────────┤
│ │ Depth codes include the following: │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 1 │ 5 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 2 │ 10 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 3 │ 20 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 4 │ 50 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 5 │ 100 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 6 │ 150 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 7 │ 180 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ SXXY │ Maximum soil temperature (degrees C) where the second 'X' │
│ │ corresponds to a code for ground cover and 'Y' corresponds │
│ │ to a code for soil depth. See SNXY for ground cover and │
│ │ depth codes. │
╘═══════╧═════════════════════════════════════════════════════════════╛
WTXX and WVXX Table
┌──────┬──────────────────────────────────────────────────────────────┐
│ XX │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ 01 │ Fog, ice fog, or freezing fog (may include heavy fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 02 │ Heavy fog or heaving freezing fog (not always distinguished │
│ │ from fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 03 │ Thunder │
├──────┼──────────────────────────────────────────────────────────────┤
│ 04 │ Ice pellets, sleet, snow pellets, or small hail │
├──────┼──────────────────────────────────────────────────────────────┤
│ 05 │ Hail (may include small hail) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 06 │ Glaze or rime │
├──────┼──────────────────────────────────────────────────────────────┤
│ 07 │ Dust, volcanic ash, blowing dust, blowing sand, or blowing │
│ │ obstruction │
├──────┼──────────────────────────────────────────────────────────────┤
│ 08 │ Smoke or haze │
├──────┼──────────────────────────────────────────────────────────────┤
│ 09 │ Blowing or drifting snow │
├──────┼──────────────────────────────────────────────────────────────┤
│ 11 │ High or damaging winds │
├──────┼──────────────────────────────────────────────────────────────┤
│ 12 │ Blowing spray │
├──────┼──────────────────────────────────────────────────────────────┤
│ 13 │ Mist │
├──────┼──────────────────────────────────────────────────────────────┤
│ 14 │ Drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ 15 │ Freezing drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ 16 │ Rain (may include freezing rain, drizzle, and freezing │
│ │ drizzle) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 17 │ Freezing rain │
├──────┼──────────────────────────────────────────────────────────────┤
│ 18 │ Snow, snow pellets, snow grains, or ice crystals │
├──────┼──────────────────────────────────────────────────────────────┤
│ 19 │ Unknown source of precipitation │
├──────┼──────────────────────────────────────────────────────────────┤
│ 21 │ Ground fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ 22 │ Ice fog or freezing fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ WVXX │ Weather in the Vicinity where XX has one of the following │
│ │ values described above: 01, 03, 07, 18, and 20 │
╘══════╧══════════════════════════════════════════════════════════════╛
For every datatype and record there is a set of meta-data flags. For the GHCNDMS
dataset, the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_ghcnd_ftp#
$ tsgettoolbox ncei_ghcnd_ftp --help
usage: tsgettoolbox ncei_ghcnd_ftp [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
If you use this data, please read
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/readme.txt[0m> about "How to
cite".
GHCN (Global Historical Climatology Network)-Daily is an integrated database
of daily climate summaries from land surface stations across the globe. Like
its monthly counterpart (GHCN-Monthly), GHCN-Daily is comprised of daily
climate records from numerous sources that have been integrated and
subjected to a common suite of quality assurance reviews.
GHCN-Daily now contains records from over 75000 stations in 180 countries and
territories. Numerous daily variables are provided, including maximum and
minimum temperature, total daily precipitation, snowfall, and snow depth;
however, about two thirds of the stations report precipitation only. Both
the record length and period of record vary by station and cover intervals
ranging from less than year to more than 175 years.
The dataset is regularly reconstructed (usually every weekend) from its
20-plus data source components to ensure that GHCN-Daily is generally in
sync with its growing list of constituent sources. During this process,
quality assurance checks are applied to the full dataset. On most weekdays,
GHCN-Daily station data are updated when possible from a variety of data
streams, which also undergo a suite of quality checks.
Some of the data provided here are based on data exchanged under the World
Meteorological Organization (WMO) World Weather Watch Program according to
WMO Resolution 40 (Cg-XII). This allows WMO member countries to place
restrictions on the use or re-export of their data for commercial purposes
outside of the receiving country. Those countries' data summaries and
products which are available here are intended for free and unrestricted use
in research, education, and other non-commercial activities. For non-U.S.
locations' data, the data or any derived product shall not be provided to
other users or be used for the re-export of commercial services.
The five core values are:
┌──────┬────────────────────────────┐
│ Code │ Description │
╞══════╪════════════════════════════╡
│ TMAX │ Temperature MAX (degree C) │
├──────┼────────────────────────────┤
│ TMIN │ Temperature MIN (degree C) │
├──────┼────────────────────────────┤
│ PRCP │ PReCiPitation (mm) │
├──────┼────────────────────────────┤
│ SNOW │ SNOWfall (mm) │
├──────┼────────────────────────────┤
│ SNWD │ SNoW Depth (mm) │
╘══════╧════════════════════════════╛
Other possible data collected:
┌──────┬──────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ ACMC │ Average cloudiness midnight to midnight from 30-second │
│ │ ceilometer data (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACMH │ Average cloudiness midnight to midnight from manual │
│ │ observations (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSC │ Average cloudiness sunrise to sunset from 30-second │
│ │ ceilometer data (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSH │ Average cloudiness sunrise to sunset from manual │
│ │ observations (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ AWDR │ Average daily wind direction (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ AWND │ Average daily wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAEV │ Number of days included in the multiday evaporation total │
│ │ (MDEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAPR │ Number of days included in the multiday precipitation total │
│ │ (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DASF │ Number of days included in the multiday snowfall total │
├──────┼─(MDSF)───────────────────────────────────────────────────────┤
│ DATN │ Number of days included in the multiday minimum temperature │
│ │ (MDTN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DATX │ Number of days included in the multiday maximum temperature │
│ │ (MDTX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAWM │ Number of days included in the multiday wind movement (MDWM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DWPR │ Number of days with non-zero precipitation included in │
│ │ multiday precipitation total (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ EVAP │ Evaporation of water from evaporation pan (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FMTM │ Time of fastest mile or fastest 1-minute wind (hours and │
│ │ minutes, i.e., HHMM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGB │ Base of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGT │ Top of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRTH │ Thickness of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ GAHT │ Difference between river and gauge height (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDEV │ Multiday evaporation total (use with DAEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDPR │ Multiday precipitation total (mm; use with DAPR and DWPR, if │
│ │ available) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDSF │ Multiday snowfall total │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTN │ Multiday minimum temperature (degrees C; use with DATN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTX │ Multiday maximum temperature (degrees C; use with DATX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDWM │ Multiday wind movement (km) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MNPN │ Daily minimum temperature of water in an evaporation pan │
│ │ (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MXPN │ Daily maximum temperature of water in an evaporation pan │
│ │ (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ PGTM │ Peak gust time (hours and minutes, i.e., HHMM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ PSUN │ Daily percent of possible sunshine (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TAVG │ Average temperature (degrees C) [Note that TAVG from source │
│ │ 'S' corresponds to an average for the period ending at 2400 │
│ │ UTC rather than local midnight] │
├──────┼──────────────────────────────────────────────────────────────┤
│ THIC │ Thickness of ice on water (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TOBS │ Temperature at the time of observation (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TSUN │ Daily total sunshine (minutes) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF1 │ Direction of fastest 1-minute wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF2 │ Direction of fastest 2-minute wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF5 │ Direction of fastest 5-second wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFG │ Direction of peak wind gust (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFI │ Direction of highest instantaneous wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFM │ Fastest mile wind direction (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDMV │ 24-hour wind movement (km) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESD │ Water equivalent of snow on the ground (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESF │ Water equivalent of snowfall (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF1 │ Fastest 1-minute wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF2 │ Fastest 2-minute wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF5 │ Fastest 5-second wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFG │ Peak gust wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFI │ Highest instantaneous wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFM │ Fastest mile wind speed (meters per second) │
╘══════╧══════════════════════════════════════════════════════════════╛
SNXY and SXXY Table
┌───────┬─────────────────────────────────────────────────────────────┐
│ SNXY │ Minimum soil temperature (degrees C) where 'X' corresponds │
│ │ to a code for ground cover and 'Y' corresponds to a code │
│ │ for soil depth. │
╞═══════╪═════════════════════════════════════════════════════════════╡
│ │ Ground cover codes include the following: │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 0 │ unknown │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 1 │ grass │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 2 │ fallow │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 3 │ bare ground │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 4 │ brome grass │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 5 │ sod │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 6 │ straw mulch │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 7 │ grass muck │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 8 │ bare muck │
├───────┼─────────────────────────────────────────────────────────────┤
│ │ Depth codes include the following: │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 1 │ 5 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 2 │ 10 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 3 │ 20 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 4 │ 50 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 5 │ 100 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 6 │ 150 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 7 │ 180 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ SXXY │ Maximum soil temperature (degrees C) where the second 'X' │
│ │ corresponds to a code for ground cover and 'Y' corresponds │
│ │ to a code for soil depth. See SNXY for ground cover and │
│ │ depth codes. │
╘═══════╧═════════════════════════════════════════════════════════════╛
WTXX and WVXX Table
┌──────┬──────────────────────────────────────────────────────────────┐
│ XX │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ 01 │ Fog, ice fog, or freezing fog (may include heavy fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 02 │ Heavy fog or heaving freezing fog (not always distinguished │
│ │ from fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 03 │ Thunder │
├──────┼──────────────────────────────────────────────────────────────┤
│ 04 │ Ice pellets, sleet, snow pellets, or small hail │
├──────┼──────────────────────────────────────────────────────────────┤
│ 05 │ Hail (may include small hail) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 06 │ Glaze or rime │
├──────┼──────────────────────────────────────────────────────────────┤
│ 07 │ Dust, volcanic ash, blowing dust, blowing sand, or blowing │
│ │ obstruction │
├──────┼──────────────────────────────────────────────────────────────┤
│ 08 │ Smoke or haze │
├──────┼──────────────────────────────────────────────────────────────┤
│ 09 │ Blowing or drifting snow │
├──────┼──────────────────────────────────────────────────────────────┤
│ 11 │ High or damaging winds │
├──────┼──────────────────────────────────────────────────────────────┤
│ 12 │ Blowing spray │
├──────┼──────────────────────────────────────────────────────────────┤
│ 13 │ Mist │
├──────┼──────────────────────────────────────────────────────────────┤
│ 14 │ Drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ 15 │ Freezing drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ 16 │ Rain (may include freezing rain, drizzle, and freezing │
│ │ drizzle) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 17 │ Freezing rain │
├──────┼──────────────────────────────────────────────────────────────┤
│ 18 │ Snow, snow pellets, snow grains, or ice crystals │
├──────┼──────────────────────────────────────────────────────────────┤
│ 19 │ Unknown source of precipitation │
├──────┼──────────────────────────────────────────────────────────────┤
│ 21 │ Ground fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ 22 │ Ice fog or freezing fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ WVXX │ Weather in the Vicinity where XX has one of the following │
│ │ values described above: 01, 03, 07, 18, and 20 │
╘══════╧══════════════════════════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_ghcndms#
$ tsgettoolbox ncei_ghcndms --help
usage: tsgettoolbox ncei_ghcndms [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags.
GHCNDMS Meta-Data Flags
┌─────────────────────┬───────────────────────────────────────────────┐
│ Total Missing │ Defined as total number of days │
│ │ observation/element is missing in that month. │
│ │ This can be taken as a measure of quality or │
│ │ completeness as the higher the number of days │
│ │ sampled in the month, the more representative │
│ │ the value is for the entire month. │
├─────────────────────┼───────────────────────────────────────────────┤
│ Consecutive Missing │ Defined as the maximum number of consecutive │
│ │ days in the month that an observation/element │
│ │ is missing. │
╘═════════════════════╧═══════════════════════════════════════════════╛
The following table lists the datatypes available for the 'ghcndms' dataset. Not
all datatypes are available for all stations.
┌──────┬──────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ ACMC │ Average cloudiness midnight to midnight from 30-second │
│ │ ceilometer data │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACMH │ Average cloudiness midnight to midnight from manual │
│ │ observations │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSC │ Average cloudiness sunrise to sunset from 30-second │
│ │ ceilometer data │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSH │ Average cloudiness sunrise to sunset from manual │
├──────┼─observations─────────────────────────────────────────────────┤
│ AWND │ Average wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAEV │ Number of days included in the multiday evaporation total │
│ │ (MDEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAPR │ Number of days included in the multiday precipitation total │
│ │ (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DASF │ Number of days included in the multiday snow fall total │
├──────┼─(MDSF)───────────────────────────────────────────────────────┤
│ DATN │ Number of days included in the multiday minimum temperature │
│ │ (MDTN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DATX │ Number of days included in the multiday maximum temperature │
│ │ (MDTX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAWM │ Number of days included in the multiday wind movement (MDWM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DWPR │ Number of days with non-zero precipitation included in │
│ │ multiday precipitation total (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ EVAP │ Evaporation of water from evaporation pan │
├──────┼──────────────────────────────────────────────────────────────┤
│ FMTM │ Time of fastest mile or fastest 1-minute wind │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGB │ Base of frozen ground layer │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGT │ Top of frozen ground layer │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRTH │ Thickness of frozen ground layer │
├──────┼──────────────────────────────────────────────────────────────┤
│ GAHT │ Difference between river and gauge height │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDEV │ Multiday evaporation total (use with DAEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDPR │ Multiday precipitation total (use with DAPR and DWPR, if │
│ │ available) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDSF │ Multiday snowfall total │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTN │ Multiday minimum temperature (use with DATN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTX │ Multiday maximum temperature (use with DATX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDWM │ Multiday wind movement │
├──────┼──────────────────────────────────────────────────────────────┤
│ MNPN │ Daily minimum temperature of water in an evaporation pan │
├──────┼──────────────────────────────────────────────────────────────┤
│ MXPN │ Daily maximum temperature of water in an evaporation pan │
├──────┼──────────────────────────────────────────────────────────────┤
│ PGTM │ Peak gust time │
├──────┼──────────────────────────────────────────────────────────────┤
│ PRCP │ Precipitation │
├──────┼──────────────────────────────────────────────────────────────┤
│ PSUN │ Daily percent of possible sunshine for the period │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN01 │ Minimum soil temperature with unknown cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN02 │ Minimum soil temperature with unknown cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN03 │ Minimum soil temperature with unknown cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN11 │ Minimum soil temperature with grass cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN12 │ Minimum soil temperature with grass cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN13 │ Minimum soil temperature with grass cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN14 │ Minimum soil temperature with grass cover at 50 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN21 │ Minimum soil temperature with fallow cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN22 │ Minimum soil temperature with fallow cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN23 │ Minimum soil temperature with fallow cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN31 │ Minimum soil temperature with bare ground cover at 5 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SN32 │ Minimum soil temperature with bare ground cover at 10 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SN33 │ Minimum soil temperature with bare ground cover at 20 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SN34 │ Minimum soil temperature with bare ground cover at 50 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SN35 │ Minimum soil temperature with bare ground cover at 100 cm │
│ │ depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN36 │ Minimum soil temperature with bare ground cover at 150 cm │
│ │ depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN51 │ Minimum soil temperature with sod cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN52 │ Minimum soil temperature with sod cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN53 │ Minimum soil temperature with sod cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN54 │ Minimum soil temperature with sod cover at 50 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN55 │ Minimum soil temperature with sod cover at 100 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN56 │ Minimum soil temperature with sod cover at 150 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN57 │ Minimum soil temperature with sod cover at 180 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN61 │ Minimum soil temperature with straw multch cover at 5 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SN72 │ Minimum soil temperature with grass muck cover at 10 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SN81 │ Minimum soil temperature with bare muck cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN82 │ Minimum soil temperature with bare muck cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SN83 │ Minimum soil temperature with bare muck cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SNOW │ Snowfall │
├──────┼──────────────────────────────────────────────────────────────┤
│ SNWD │ Snow depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX01 │ Maximum soil temperature with unknown cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX02 │ Maximum soil temperature with unknown cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX03 │ Maximum soil temperature with unknown cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX11 │ Maximum soil temperature with grass cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX12 │ Maximum soil temperature with grass cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX13 │ Maximum soil temperature with grass cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX14 │ Maximum soil temperature with grass cover at 50 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX15 │ Maximum soil temperature with grass cover at 100 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX17 │ Maximum soil temperature with grass cover at 180 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX21 │ Maximum soil temperature with fallow cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX22 │ Maximum soil temperature with fallow cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX23 │ Maximum soil temperature with fallow cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX31 │ Maximum soil temperature with bare ground cover at 5 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SX32 │ Maximum soil temperature with bare ground cover at 10 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SX33 │ Maximum soil temperature with bare ground cover at 20 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SX34 │ Maximum soil temperature with bare ground cover at 50 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SX35 │ Maximum soil temperature with bare ground cover at 100 cm │
│ │ depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX36 │ Maximum soil temperature with bare ground cover at 150 cm │
│ │ depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX51 │ Maximum soil temperature with sod cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX52 │ Maximum soil temperature with sod cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX53 │ Maximum soil temperature with sod cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX54 │ Maximum soil temperature with sod cover at 50 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX55 │ Maximum soil temperature with sod cover at 100 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX56 │ Maximum soil temperature with sod cover at 150 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX57 │ Maximum soil temperature with sod cover at 180 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX61 │ Maximum soil temperature with straw mulch cover at 5 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SX72 │ Maximum soil temperature with grass muck cover at 10 cm │
├──────┼─depth────────────────────────────────────────────────────────┤
│ SX81 │ Maximum soil temperature with bare muck cover at 5 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX82 │ Maximum soil temperature with bare muck cover at 10 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ SX83 │ Maximum soil temperature with bare muck cover at 20 cm depth │
├──────┼──────────────────────────────────────────────────────────────┤
│ TAVG │ Average Temperature. │
├──────┼──────────────────────────────────────────────────────────────┤
│ THIC │ Thickness of ice on water │
├──────┼──────────────────────────────────────────────────────────────┤
│ TMAX │ Maximum temperature │
├──────┼──────────────────────────────────────────────────────────────┤
│ TMIN │ Minimum temperature │
├──────┼──────────────────────────────────────────────────────────────┤
│ TOBS │ Temperature at the time of observation │
├──────┼──────────────────────────────────────────────────────────────┤
│ TSUN │ Total sunshine for the period │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF1 │ Direction of fastest 1-minute wind │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF2 │ Direction of fastest 2-minute wind │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF5 │ Direction of fastest 5-second wind │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFG │ Direction of peak wind gust │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFI │ Direction of highest instantaneous wind │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFM │ Fastest mile wind direction │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDMV │ Total wind movement │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESD │ Water equivalent of snow on the ground │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESF │ Water equivalent of snowfall │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF1 │ Fastest 1-minute wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF2 │ Fastest 2-minute wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF5 │ Fastest 5-second wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFG │ Peak gust wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFI │ Highest instantaneous wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFM │ Fastest mile wind speed │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT01 │ Fog, ice fog, or freezing fog (may include heavy fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT02 │ Heavy fog or heaving freezing fog (not always distinguished │
│ │ from fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT03 │ Thunder │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT04 │ Ice pellets, sleet, snow pellets, or small hail │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT05 │ Hail (may include small hail) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT06 │ Glaze or rime │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT07 │ Dust, volcanic ash, blowing dust, blowing sand, or blowing │
│ │ obstruction │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT08 │ Smoke or haze │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT09 │ Blowing or drifting snow │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT10 │ Tornado, waterspout, or funnel cloud │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT11 │ High or damaging winds │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT12 │ Blowing spray │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT13 │ Mist │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT14 │ Drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT15 │ Freezing drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT16 │ Rain (may include freezing rain, drizzle, and freezing │
│ │ drizzle) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT17 │ Freezing rain │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT18 │ Snow, snow pellets, snow grains, or ice crystals │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT19 │ Unknown source of precipitation │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT21 │ Ground fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ WT22 │ Ice fog or freezing fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ WV01 │ Fog, ice fog, or freezing fog (may include heavy fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WV03 │ Thunder │
├──────┼──────────────────────────────────────────────────────────────┤
│ WV07 │ Ash, dust, sand, or other blowing obstruction │
├──────┼──────────────────────────────────────────────────────────────┤
│ WV18 │ Snow or ice crystals │
├──────┼──────────────────────────────────────────────────────────────┤
│ WV20 │ Rain or snow shower │
╘══════╧══════════════════════════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_gsod#
$ tsgettoolbox ncei_gsod --help
usage: tsgettoolbox ncei_gsod [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
National Centers for Environmental Information (NCEI) Global Summary of the
MONTH (GSOM) <[4;36mhttps://gis.ncdc.noaa.gov/all-records/catalog/search/resou-
rce/details.page[0m> Cite this dataset when used as a source: Lawrimore, Jay (2016).
Global Summary of the Month, Version 1.0. [indicate subset used]. NOAA National
Centers for Environmental Information. DOI:10.7289/V5QV3JJ5
National Centers for Environmental Information (NCEI) Global Summary of the YEAR
(GSOY) <[4;36mhttps://gis.ncdc.noaa.gov/all-records/catalog/search/resource/de-
tails.page?id=gov.noaa.ncei:C00947[0m> Cite this dataset when used as a source: Lawrimore,
Jay (2016). Global Summary of the Year, Version 1.0. [indicate subset used].
NOAA National Centers for Environmental Information
Requires registration and free API key.
NCEI cannot assume liability for any damages caused by any errors or omissions
in the data, nor as a result of the failure of the data to function on a
particular system. NCEI makes no warranty, expressed or implied, nor does the
fact of distribution constitute such a warranty. NCEI can only certify that the
data it distributes are an authentic copy of the records that were accepted for
inclusion in the NCEI archives.
The global summaries data set contains a monthly (GSOM) resolution of
meteorological elements (max temp, snow, etc) from 1763 to present with updates
weekly. The major parameters are: monthly mean maximum, mean minimum and mean
temperatures; monthly total precipitation and snowfall; departure from normal of
the mean temperature and total precipitation; monthly heating and cooling degree
days; number of days that temperatures and precipitation are above or below
certain thresholds; and extreme daily temperature and precipitation amounts. The
primary source data set source is the Global Historical Climatology Network
(GHCN)-Daily Data set. The global summaries data set also contains a yearly
(GSOY) resolution of meteorological elements. See associated resources for more
information. This data is not to be confused with "GHCN-Monthly", "Annual
Summaries" or "ncei Summary of the Month". There are unique elements that are
produced globally within the GSOM and GSOY data files. There are also bias
corrected temperature data in GHCN-Monthly, which will not be available in GSOM
and GSOY. The GSOM and GSOY data set is going to replace the legacy DSI-3220 and
expand to include non-U.S. (a.k.a. global) stations. DSI-3220 only included
National Weather Service (NWS) COOP Published, or "Published in CD", sites. For
every datatype and record there is a set of meta-data flags.
For the GHCNDMS dataset the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_gsom#
$ tsgettoolbox ncei_gsom --help
usage: tsgettoolbox ncei_gsom [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
National Centers for Environmental Information (NCEI) Global Summary of the
MONTH (GSOM) <[4;36mhttps://gis.ncdc.noaa.gov/all-records/catalog/search/resou-
rce/details.page[0m> Cite this dataset when used as a source: Lawrimore, Jay (2016).
Global Summary of the Month, Version 1.0. [indicate subset used]. NOAA National
Centers for Environmental Information. DOI:10.7289/V5QV3JJ5
National Centers for Environmental Information (NCEI) Global Summary of the YEAR
(GSOY) <[4;36mhttps://gis.ncdc.noaa.gov/all-records/catalog/search/resource/de-
tails.page?id=gov.noaa.ncei:C00947[0m> Cite this dataset when used as a source: Lawrimore,
Jay (2016). Global Summary of the Year, Version 1.0. [indicate subset used].
NOAA National Centers for Environmental Information
Requires registration and free API key.
NCEI cannot assume liability for any damages caused by any errors or omissions
in the data, nor as a result of the failure of the data to function on a
particular system. NCEI makes no warranty, expressed or implied, nor does the
fact of distribution constitute such a warranty. NCEI can only certify that the
data it distributes are an authentic copy of the records that were accepted for
inclusion in the NCEI archives.
The global summaries data set contains a monthly (GSOM) resolution of
meteorological elements (max temp, snow, etc) from 1763 to present with updates
weekly. The major parameters are: monthly mean maximum, mean minimum and mean
temperatures; monthly total precipitation and snowfall; departure from normal of
the mean temperature and total precipitation; monthly heating and cooling degree
days; number of days that temperatures and precipitation are above or below
certain thresholds; and extreme daily temperature and precipitation amounts. The
primary source data set source is the Global Historical Climatology Network
(GHCN)-Daily Data set. The global summaries data set also contains a yearly
(GSOY) resolution of meteorological elements. See associated resources for more
information. This data is not to be confused with "GHCN-Monthly", "Annual
Summaries" or "ncei Summary of the Month". There are unique elements that are
produced globally within the GSOM and GSOY data files. There are also bias
corrected temperature data in GHCN-Monthly, which will not be available in GSOM
and GSOY. The GSOM and GSOY data set is going to replace the legacy DSI-3220 and
expand to include non-U.S. (a.k.a. global) stations. DSI-3220 only included
National Weather Service (NWS) COOP Published, or "Published in CD", sites. For
every datatype and record there is a set of meta-data flags.
For the GHCNDMS dataset the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_gsoy#
$ tsgettoolbox ncei_gsoy --help
usage: tsgettoolbox ncei_gsoy [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
National Centers for Environmental Information (NCEI) Global Summary of the YEAR
(GSOY) <[4;36mhttps://gis.ncdc.noaa.gov/all-records/catalog/search/resource/de-
tails.page?id=gov.noaa.ncei:C00947[0m> Cite this dataset when used as a source: Lawrimore,
Jay (2016). Global Summary of the Year, Version 1.0. [indicate subset used].
NOAA National Centers for Environmental Information. DOI:10.7289/V5QV3JJ5
Requires registration and free API key.
NCEI cannot assume liability for any damages caused by any errors or omissions
in the data, nor as a result of the failure of the data to function on a
particular system. NCEI makes no warranty, expressed or implied, nor does the
fact of distribution constitute such a warranty. NCEI can only certify that the
data it distributes are an authentic copy of the records that were accepted for
inclusion in the NCEI archives.
The global summaries data set contains a monthly (GSOM) resolution of
meteorological elements (max temp, snow, etc) from 1763 to present with updates
weekly. The major parameters are: monthly mean maximum, mean minimum and mean
temperatures; monthly total precipitation and snowfall; departure from normal of
the mean temperature and total precipitation; monthly heating and cooling degree
days; number of days that temperatures and precipitation are above or below
certain thresholds; and extreme daily temperature and precipitation amounts. The
primary source data set source is the Global Historical Climatology Network
(GHCN)-Daily Data set. The global summaries data set also contains a yearly
(GSOY) resolution of meteorological elements. See associated resources for more
information. This data is not to be confused with "GHCN-Monthly", "Annual
Summaries" or "ncei Summary of the Month". There are unique elements that are
produced globally within the GSOM and GSOY data files. There are also bias
corrected temperature data in GHCN-Monthly, which will not be available in GSOM
and GSOY. The GSOM and GSOY data set is going to replace the legacy DSI-3220 and
expand to include non-U.S. (a.k.a. global) stations. DSI-3220 only included
National Weather Service (NWS) COOP Published, or "Published in CD", sites. For
every datatype and record there is a set of meta-data flags.
For the GHCNDMS dataset the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_ish#
$ tsgettoolbox ncei_ish --help
usage: tsgettoolbox ncei_ish [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
If you use this data, please read
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/readme.txt[0m> about "How to
cite".
GHCN (Global Historical Climatology Network)-Daily is an integrated database
of daily climate summaries from land surface stations across the globe. Like
its monthly counterpart (GHCN-Monthly), GHCN-Daily is comprised of daily
climate records from numerous sources that have been integrated and
subjected to a common suite of quality assurance reviews.
GHCN-Daily now contains records from over 75000 stations in 180 countries and
territories. Numerous daily variables are provided, including maximum and
minimum temperature, total daily precipitation, snowfall, and snow depth;
however, about two thirds of the stations report precipitation only. Both
the record length and period of record vary by station and cover intervals
ranging from less than year to more than 175 years.
The dataset is regularly reconstructed (usually every weekend) from its
20-plus data source components to ensure that GHCN-Daily is generally in
sync with its growing list of constituent sources. During this process,
quality assurance checks are applied to the full dataset. On most weekdays,
GHCN-Daily station data are updated when possible from a variety of data
streams, which also undergo a suite of quality checks.
Some of the data provided here are based on data exchanged under the World
Meteorological Organization (WMO) World Weather Watch Program according to
WMO Resolution 40 (Cg-XII). This allows WMO member countries to place
restrictions on the use or re-export of their data for commercial purposes
outside of the receiving country. Those countries' data summaries and
products which are available here are intended for free and unrestricted use
in research, education, and other non-commercial activities. For non-U.S.
locations' data, the data or any derived product shall not be provided to
other users or be used for the re-export of commercial services.
The five core values are:
┌──────┬────────────────────────────┐
│ Code │ Description │
╞══════╪════════════════════════════╡
│ TMAX │ Temperature MAX (degree C) │
├──────┼────────────────────────────┤
│ TMIN │ Temperature MIN (degree C) │
├──────┼────────────────────────────┤
│ PRCP │ PReCiPitation (mm) │
├──────┼────────────────────────────┤
│ SNOW │ SNOWfall (mm) │
├──────┼────────────────────────────┤
│ SNWD │ SNoW Depth (mm) │
╘══════╧════════════════════════════╛
Other possible data collected:
┌──────┬──────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ ACMC │ Average cloudiness midnight to midnight from 30-second │
│ │ ceilometer data (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACMH │ Average cloudiness midnight to midnight from manual │
│ │ observations (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSC │ Average cloudiness sunrise to sunset from 30-second │
│ │ ceilometer data (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ ACSH │ Average cloudiness sunrise to sunset from manual │
│ │ observations (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ AWDR │ Average daily wind direction (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ AWND │ Average daily wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAEV │ Number of days included in the multiday evaporation total │
│ │ (MDEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAPR │ Number of days included in the multiday precipitation total │
│ │ (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DASF │ Number of days included in the multiday snowfall total │
├──────┼─(MDSF)───────────────────────────────────────────────────────┤
│ DATN │ Number of days included in the multiday minimum temperature │
│ │ (MDTN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DATX │ Number of days included in the multiday maximum temperature │
│ │ (MDTX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DAWM │ Number of days included in the multiday wind movement (MDWM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ DWPR │ Number of days with non-zero precipitation included in │
│ │ multiday precipitation total (MDPR) │
├──────┼──────────────────────────────────────────────────────────────┤
│ EVAP │ Evaporation of water from evaporation pan (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FMTM │ Time of fastest mile or fastest 1-minute wind (hours and │
│ │ minutes, i.e., HHMM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGB │ Base of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRGT │ Top of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ FRTH │ Thickness of frozen ground layer (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ GAHT │ Difference between river and gauge height (cm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDEV │ Multiday evaporation total (use with DAEV) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDPR │ Multiday precipitation total (mm; use with DAPR and DWPR, if │
│ │ available) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDSF │ Multiday snowfall total │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTN │ Multiday minimum temperature (degrees C; use with DATN) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDTX │ Multiday maximum temperature (degrees C; use with DATX) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MDWM │ Multiday wind movement (km) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MNPN │ Daily minimum temperature of water in an evaporation pan │
│ │ (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ MXPN │ Daily maximum temperature of water in an evaporation pan │
│ │ (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ PGTM │ Peak gust time (hours and minutes, i.e., HHMM) │
├──────┼──────────────────────────────────────────────────────────────┤
│ PSUN │ Daily percent of possible sunshine (percent) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TAVG │ Average temperature (degrees C) [Note that TAVG from source │
│ │ 'S' corresponds to an average for the period ending at 2400 │
│ │ UTC rather than local midnight] │
├──────┼──────────────────────────────────────────────────────────────┤
│ THIC │ Thickness of ice on water (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TOBS │ Temperature at the time of observation (degrees C) │
├──────┼──────────────────────────────────────────────────────────────┤
│ TSUN │ Daily total sunshine (minutes) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF1 │ Direction of fastest 1-minute wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF2 │ Direction of fastest 2-minute wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDF5 │ Direction of fastest 5-second wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFG │ Direction of peak wind gust (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFI │ Direction of highest instantaneous wind (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDFM │ Fastest mile wind direction (degrees) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WDMV │ 24-hour wind movement (km) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESD │ Water equivalent of snow on the ground (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WESF │ Water equivalent of snowfall (mm) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF1 │ Fastest 1-minute wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF2 │ Fastest 2-minute wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSF5 │ Fastest 5-second wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFG │ Peak gust wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFI │ Highest instantaneous wind speed (meters per second) │
├──────┼──────────────────────────────────────────────────────────────┤
│ WSFM │ Fastest mile wind speed (meters per second) │
╘══════╧══════════════════════════════════════════════════════════════╛
SNXY and SXXY Table
┌───────┬─────────────────────────────────────────────────────────────┐
│ SNXY │ Minimum soil temperature (degrees C) where 'X' corresponds │
│ │ to a code for ground cover and 'Y' corresponds to a code │
│ │ for soil depth. │
╞═══════╪═════════════════════════════════════════════════════════════╡
│ │ Ground cover codes include the following: │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 0 │ unknown │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 1 │ grass │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 2 │ fallow │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 3 │ bare ground │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 4 │ brome grass │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 5 │ sod │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 6 │ straw mulch │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 7 │ grass muck │
├───────┼─────────────────────────────────────────────────────────────┤
│ X = 8 │ bare muck │
├───────┼─────────────────────────────────────────────────────────────┤
│ │ Depth codes include the following: │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 1 │ 5 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 2 │ 10 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 3 │ 20 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 4 │ 50 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 5 │ 100 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 6 │ 150 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ Y = 7 │ 180 cm │
├───────┼─────────────────────────────────────────────────────────────┤
│ SXXY │ Maximum soil temperature (degrees C) where the second 'X' │
│ │ corresponds to a code for ground cover and 'Y' corresponds │
│ │ to a code for soil depth. See SNXY for ground cover and │
│ │ depth codes. │
╘═══════╧═════════════════════════════════════════════════════════════╛
WTXX and WVXX Table
┌──────┬──────────────────────────────────────────────────────────────┐
│ XX │ Description │
╞══════╪══════════════════════════════════════════════════════════════╡
│ 01 │ Fog, ice fog, or freezing fog (may include heavy fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 02 │ Heavy fog or heaving freezing fog (not always distinguished │
│ │ from fog) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 03 │ Thunder │
├──────┼──────────────────────────────────────────────────────────────┤
│ 04 │ Ice pellets, sleet, snow pellets, or small hail │
├──────┼──────────────────────────────────────────────────────────────┤
│ 05 │ Hail (may include small hail) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 06 │ Glaze or rime │
├──────┼──────────────────────────────────────────────────────────────┤
│ 07 │ Dust, volcanic ash, blowing dust, blowing sand, or blowing │
│ │ obstruction │
├──────┼──────────────────────────────────────────────────────────────┤
│ 08 │ Smoke or haze │
├──────┼──────────────────────────────────────────────────────────────┤
│ 09 │ Blowing or drifting snow │
├──────┼──────────────────────────────────────────────────────────────┤
│ 11 │ High or damaging winds │
├──────┼──────────────────────────────────────────────────────────────┤
│ 12 │ Blowing spray │
├──────┼──────────────────────────────────────────────────────────────┤
│ 13 │ Mist │
├──────┼──────────────────────────────────────────────────────────────┤
│ 14 │ Drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ 15 │ Freezing drizzle │
├──────┼──────────────────────────────────────────────────────────────┤
│ 16 │ Rain (may include freezing rain, drizzle, and freezing │
│ │ drizzle) │
├──────┼──────────────────────────────────────────────────────────────┤
│ 17 │ Freezing rain │
├──────┼──────────────────────────────────────────────────────────────┤
│ 18 │ Snow, snow pellets, snow grains, or ice crystals │
├──────┼──────────────────────────────────────────────────────────────┤
│ 19 │ Unknown source of precipitation │
├──────┼──────────────────────────────────────────────────────────────┤
│ 21 │ Ground fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ 22 │ Ice fog or freezing fog │
├──────┼──────────────────────────────────────────────────────────────┤
│ WVXX │ Weather in the Vicinity where XX has one of the following │
│ │ values described above: 01, 03, 07, 18, and 20 │
╘══════╧══════════════════════════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_normal_ann#
$ tsgettoolbox ncei_normal_ann --help
usage: tsgettoolbox ncei_normal_ann [-h] stationid
Requires registration and free API key.
The 1981-2010 Normals comprise all climate normals using the thirty year period
of temperature, degree days, precipitation, snowfall, snow depth, wind, etc.
Data is organized into hourly, daily, monthly, seasonal and annual. This
document describes the elements and layout of the Seasonal and Annual Normals
which are derived from a composite of climate records from numerous sources that
were merged and then subjected to a suite of quality assurance reviews.
flags accompany every normals value and indicate the completeness of the data
record used to compute each value, accounting for methodological differences for
different product classes. There are six flag options described generally below.
Due to methodological differences, the flags are applied somewhat differently
between the temperature-based normals and the precipitation-based normals. For
the precipitation-based and hourly normals, the following flags were assigned
independently for each normals value reported based on number of years available
for that individual calculation. For temperature-based normals, strong
precedence is given to the monthly normals of maximum and minimum temperature or
derived from the flags for these two variables.
┌───────┬─────────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═══════╪═════════════════════════════════════════════════════════════╡
│ C │ complete (all 30 years used) │
├───────┼─────────────────────────────────────────────────────────────┤
│ S │ standard (no more than 5 years missing and no more than 3 │
│ │ consecutive years missing among the sufficiently complete │
│ │ years) │
├───────┼─────────────────────────────────────────────────────────────┤
│ R │ representative (observed record utilized incomplete, but │
│ │ value was scaled or based on filled values to be │
│ │ representative of the full period of record) │
├───────┼─────────────────────────────────────────────────────────────┤
│ P │ provisional (at least 10 years used, but not sufficiently │
│ │ complete to be labeled as standard or representative). Also │
│ │ used for parameter values on February 29 as well as for │
│ │ interpolated daily precipitation, snowfall, and snow depth │
│ │ percentiles. │
├───────┼─────────────────────────────────────────────────────────────┤
│ Q │ quasi-normal (at least 2 years per month, but not │
│ │ sufficiently complete to be labeled as provisional or any │
│ │ other higher flag code. The associated value was computed │
│ │ using a pseudo-normals approach or derived from monthly │
│ │ pseudo-normals. │
├───────┼─────────────────────────────────────────────────────────────┤
│ Blank │ the data value is reported as a special value (see section │
│ │ B under III. Additional Information below). │
╘═══════╧═════════════════════════════════════════════════════════════╛
Note: flags Q and R aren't applicable to average number of days with different
precipitation, snowfall, and snow depth threshold exceedance;
precipitation/snowfall/snow probabilities of occurrence. Further, Q flags are
not applicable for standard deviations.
The following table lists the datatypes available for the annual dataset. Not
all of these are available at all stations.
┌─────────────────────────┬───────────────────────────────────────────┐
│ Code │ Description │
╞═════════════════════════╪═══════════════════════════════════════════╡
│ ANN-CLDD-BASExx │ Average annual cooling degree days where │
│ │ xx is the base in degree F. 'xx' can be │
│ │ one of 45, 50, 57, 60, 65, 70, 72 │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-CLDD-NORMAL │ Average annual cooling degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-DUTR-NORMAL │ Average annual diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-GRDD-BASExx │ Average annual growing degree days where │
│ │ xx is the base in degree F. 'xx' can be │
│ │ one of 40, 45, 50, 55, 57, 60, 65, 70, │
├─────────────────────────┼─72.───────────────────────────────────────┤
│ ANN-GRDD-TB4886 │ Average annual growing degree days with │
│ │ truncated bases 48F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-GRDD-TB5086 │ Average annual growing degree days with │
│ │ truncated bases 50F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-BASE40 │ Average annual heating degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-BASE45 │ Average annual heating degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-BASE50 │ Average annual heating degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-BASE55 │ Average annual heating degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-BASE57 │ Average annual heating degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-BASE60 │ Average annual heating degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-HTDD-NORMAL │ Average annual heating degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-PRCP-AVGNDS-GE001HI │ Average number of days during the year │
│ │ with precipitation >= 0.01 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-PRCP-AVGNDS-GE010HI │ Average number of days during the year │
│ │ with precipitation >= 0.10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-PRCP-AVGNDS-GE050HI │ Average number of days during the year │
│ │ with precipitation >= 0.50 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-PRCP-AVGNDS-GE100HI │ Average number of days during the year │
│ │ with precipitation >= 1.00 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-PRCP-NORMAL │ Average annual precipitation totals │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNOW-AVGNDS-GE001TI │ Average number of days during the year │
│ │ with snowfall >= 0.1 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNOW-AVGNDS-GE010TI │ Average number of days during the year │
│ │ with snowfall >= 1.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNOW-AVGNDS-GE030TI │ Average number of days during the year │
│ │ with snowfall >= 3.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNOW-AVGNDS-GE050TI │ Average number of days during the year │
│ │ with snowfall >= 5.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNOW-AVGNDS-GE100TI │ Average number of days during the year │
│ │ with snowfall >= 10.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNOW-NORMAL │ Average annual snowfall totals │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNWD-AVGNDS-GE001WI │ Average number of days during the year │
│ │ with snow depth >= 1 inch │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNWD-AVGNDS-GE003WI │ Average number of days during the year │
│ │ with snow depth >= 3 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNWD-AVGNDS-GE005WI │ Average number of days during the year │
│ │ with snow depth >=5 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-SNWD-AVGNDS-GE010WI │ Average number of days during the year │
│ │ with snow depth >=10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TAVG-NORMAL │ Average annual average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH040 │ Average number of days per year where │
│ │ tmax is greater than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH050 │ Average number of days per year where │
│ │ tmax is greater than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH060 │ Average number of days per year where │
│ │ tmax is greater than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH070 │ Average number of days per year where │
│ │ tmax is greater than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH080 │ Average number of days per year where │
│ │ tmax is greater than or equal to 80F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH090 │ Average number of days per year where │
│ │ tmax is greater than or equal to 90F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-GRTH100 │ Average number of days per year where │
│ │ tmax is greater than or equal to 100F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-AVGNDS-LSTH032 │ Average number of days per year where │
│ │ tmax is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMAX-NORMAL │ Average annual maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH000 │ Average number of days per year where │
│ │ tmin is less than or equal to 0F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH010 │ Average number of days per year where │
│ │ tmin is less than or equal to 10F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH020 │ Average number of days per year where │
│ │ tmin is less than or equal to 20F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH032 │ Average number of days per year where │
│ │ tmin is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH040 │ Average number of days per year where │
│ │ tmin is less than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH050 │ Average number of days per year where │
│ │ tmin is less than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH060 │ Average number of days per year where │
│ │ tmin is less than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-AVGNDS-LSTH070 │ Average number of days per year where │
│ │ tmin is less than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-NORMAL │ Average annual minimum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP10 │ 10 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP20 │ 20 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP30 │ 30 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP40 │ 40 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP50 │ 50 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP60 │ 60 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP70 │ 70 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP80 │ 80 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T16FP90 │ 90 percent probability date of first 16F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP10 │ 10 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP20 │ 20 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP30 │ 30 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP40 │ 40 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP50 │ 50 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP60 │ 60 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP70 │ 70 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP80 │ 80 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T20FP90 │ 90 percent probability date of first 20F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP10 │ 10 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP20 │ 20 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP30 │ 30 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP40 │ 40 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP50 │ 50 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP60 │ 60 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP70 │ 70 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP80 │ 80 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T24FP90 │ 90 percent probability date of first 24F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP10 │ 10 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP20 │ 20 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP30 │ 30 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP40 │ 40 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP50 │ 50 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP60 │ 60 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP70 │ 70 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP80 │ 80 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T28FP90 │ 90 percent probability date of first 28F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP10 │ 10 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP20 │ 20 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP30 │ 30 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP40 │ 40 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP50 │ 50 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP60 │ 60 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP70 │ 70 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP80 │ 80 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T32FP90 │ 90 percent probability date of first 32F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP10 │ 10 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP20 │ 20 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP30 │ 30 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP40 │ 40 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP50 │ 50 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP60 │ 60 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP70 │ 70 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP80 │ 80 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBFST-T36FP90 │ 90 percent probability date of first 36F │
│ │ occurrence or earlier │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP10 │ 10 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP20 │ 20 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP30 │ 30 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP40 │ 40 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP50 │ 50 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP60 │ 60 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP70 │ 70 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP80 │ 80 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T16FP90 │ 90 percent probability of 16F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP10 │ 10 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP20 │ 20 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP30 │ 30 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP40 │ 40 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP50 │ 50 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP60 │ 60 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP70 │ 70 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP80 │ 80 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T20FP90 │ 90 percent probability of 20F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP10 │ 10 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP20 │ 20 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP30 │ 30 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP40 │ 40 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP50 │ 50 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP60 │ 60 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP70 │ 70 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP80 │ 80 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T24FP90 │ 90 percent probability of 24F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP10 │ 10 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP20 │ 20 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP30 │ 30 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP40 │ 40 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP50 │ 50 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP60 │ 60 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP70 │ 70 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP80 │ 80 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T28FP90 │ 90 percent probability of 28F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP10 │ 10 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP20 │ 20 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP30 │ 30 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP40 │ 40 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP50 │ 50 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP60 │ 60 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP70 │ 70 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP80 │ 80 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T32FP90 │ 90 percent probability of 32F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP10 │ 10 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP20 │ 20 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP30 │ 30 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP40 │ 40 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP50 │ 50 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP60 │ 60 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP70 │ 70 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP80 │ 80 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBGSL-T36FP90 │ 90 percent probability of 36F growing │
│ │ season length or longer │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP10 │ 10 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP20 │ 20 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP30 │ 30 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP40 │ 40 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP50 │ 50 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP60 │ 60 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP70 │ 70 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP80 │ 80 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T16FP90 │ 90 percent probability date of last 16F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP10 │ 10 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP20 │ 20 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP30 │ 30 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP40 │ 40 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP50 │ 50 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP60 │ 60 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP70 │ 70 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP80 │ 80 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T20FP90 │ 90 percent probability date of last 20F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP10 │ 10 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP20 │ 20 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP30 │ 30 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP40 │ 40 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP50 │ 50 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP60 │ 60 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP70 │ 70 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP80 │ 80 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T24FP90 │ 90 percent probability date of last 24F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP10 │ 10 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP20 │ 20 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP30 │ 30 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP40 │ 40 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP50 │ 50 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP60 │ 60 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP70 │ 70 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP80 │ 80 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T28FP90 │ 90 percent probability date of last 28F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP10 │ 10 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP20 │ 20 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP30 │ 30 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP40 │ 40 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP50 │ 50 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP60 │ 60 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP70 │ 70 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP80 │ 80 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T32FP90 │ 90 percent probability date of last 32F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP10 │ 10 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP20 │ 20 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP30 │ 30 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP40 │ 40 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP50 │ 50 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP60 │ 60 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP70 │ 70 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP80 │ 80 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBLST-T36FP90 │ 90 percent probability date of last 36F │
│ │ occurrence or later │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBOCC-LSTH016 │ probability of 16F or below at least once │
│ │ in the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBOCC-LSTH020 │ probability of 20F or below at least once │
│ │ in the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBOCC-LSTH024 │ probability of 24F or below at least once │
│ │ in the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBOCC-LSTH028 │ probability of 28F or below at least once │
│ │ in the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBOCC-LSTH032 │ probability of 32F or below at least once │
│ │ in the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ ANN-TMIN-PRBOCC-LSTH036 │ probability of 36F or below at least once │
│ │ in the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE45 │ Average winter cooling degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE50 │ Average winter cooling degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE55 │ Average winter cooling degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE57 │ Average winter cooling degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE60 │ Average winter cooling degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE70 │ Average winter cooling degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-BASE72 │ Average winter cooling degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-CLDD-NORMAL │ Average winter cooling degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-DUTR-NORMAL │ Average winter diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE40 │ Average winter growing degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE45 │ Average winter growing degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE50 │ Average winter growing degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE55 │ Average winter growing degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE57 │ Average winter growing degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE60 │ Average winter growing degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE65 │ Average winter growing degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE70 │ Average winter growing degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-BASE72 │ Average winter growing degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-TB4886 │ Average winter growing degree days with │
│ │ truncated bases 48F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-GRDD-TB5086 │ Average winter growing degree days with │
│ │ truncated bases 50F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-BASE40 │ Average winter heating degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-BASE45 │ Average winter heating degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-BASE50 │ Average winter heating degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-BASE55 │ Average winter heating degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-BASE57 │ Average winter heating degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-BASE60 │ Average winter heating degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-HTDD-NORMAL │ Average winter heating degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-PRCP-AVGNDS-GE001HI │ Average number of days during December- │
│ │ February with precipitation >= 0.01 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-PRCP-AVGNDS-GE010HI │ Average number of days during December- │
│ │ February with precipitation >= 0.10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-PRCP-AVGNDS-GE050HI │ Average number of days during December- │
│ │ February with precipitation >= 0.50 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-PRCP-AVGNDS-GE100HI │ Average number of days during December- │
│ │ February with precipitation >= 1.00 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-PRCP-NORMAL │ Average seasonal precipitation totals for │
│ │ December- February │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNOW-AVGNDS-GE001TI │ Average number of days during December- │
│ │ February with snowfall >= 0.1 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNOW-AVGNDS-GE010TI │ Average number of days during December- │
│ │ February with snowfall >= 1.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNOW-AVGNDS-GE030TI │ Average number of days during December- │
│ │ February with snowfall >= 3.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNOW-AVGNDS-GE050TI │ Average number of days during December- │
│ │ February with snowfall >= 5.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNOW-AVGNDS-GE100TI │ Average number of days during December- │
│ │ February with snowfall >= 10.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNOW-NORMAL │ Average seasonal snowfall totals for │
│ │ December- February │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNWD-AVGNDS-GE001WI │ Average number of days during December- │
│ │ February with snow depth >= 1 inch │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNWD-AVGNDS-GE003WI │ Average number of days during December- │
│ │ February with snow depth >= 3 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNWD-AVGNDS-GE005WI │ Average number of days during December- │
│ │ February with snow depth >= 5 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-SNWD-AVGNDS-GE010WI │ Average number of days during December- │
│ │ February with snow depth >= 10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TAVG-NORMAL │ Average winter average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH040 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH050 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH060 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH070 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH080 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 80F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH090 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 90F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-GRTH100 │ Average number of days per winter where │
│ │ tmax is greater than or equal to 100F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-AVGNDS-LSTH032 │ Average number of days per winter where │
│ │ tmax is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMAX-NORMAL │ Average winter maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH000 │ Average number of days per winter where │
│ │ tmin is less than or equal to 0F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH010 │ Average number of days per winter where │
│ │ tmin is less than or equal to 10F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH020 │ Average number of days per winter where │
│ │ tmin is less than or equal to 20F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH032 │ Average number of days per winter where │
│ │ tmin is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH040 │ Average number of days per winter where │
│ │ tmin is less than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH050 │ Average number of days per winter where │
│ │ tmin is less than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH060 │ Average number of days per winter where │
│ │ tmin is less than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-AVGNDS-LSTH070 │ Average number of days per winter where │
│ │ tmin is less than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DJF-TMIN-NORMAL │ Average winter minimum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE45 │ Average summer cooling degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE50 │ Average summer cooling degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE55 │ Average summer cooling degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE57 │ Average summer cooling degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE60 │ Average summer cooling degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE70 │ Average summer cooling degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-BASE72 │ Average summer cooling degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-CLDD-NORMAL │ Average summer cooling degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-DUTR-NORMAL │ Average summer diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE40 │ Average summer growing degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE45 │ Average summer growing degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE50 │ Average summer growing degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE55 │ Average summer growing degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE57 │ Average summer growing degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE60 │ Average summer growing degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE65 │ Average summer growing degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE70 │ Average summer growing degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-BASE72 │ Average summer growing degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-TB4886 │ Average summer growing degree days with │
│ │ truncated bases 48F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-GRDD-TB5086 │ Average summer growing degree days with │
│ │ truncated bases 50F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-BASE40 │ Average summer heating degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-BASE45 │ Average summer heating degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-BASE50 │ Average summer heating degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-BASE55 │ Average summer heating degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-BASE57 │ Average summer heating degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-BASE60 │ Average summer heating degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-HTDD-NORMAL │ Average summer heating degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-PRCP-AVGNDS-GE001HI │ Average number of days during June-August │
│ │ with precipitation >= 0.01 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-PRCP-AVGNDS-GE010HI │ Average number of days during June-August │
│ │ with precipitation >= 0.10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-PRCP-AVGNDS-GE050HI │ Average number of days during June-August │
│ │ with precipitation >= 0.50 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-PRCP-AVGNDS-GE100HI │ Average number of days during June-August │
│ │ with precipitation >= 1.00 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-PRCP-NORMAL │ Average seasonal precipitation totals for │
│ │ June- August │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNOW-AVGNDS-GE001TI │ Average number of days during June-August │
│ │ with snowfall >= 0.1 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNOW-AVGNDS-GE010TI │ Average number of days during June-August │
│ │ with snowfall >= 1.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNOW-AVGNDS-GE030TI │ Average number of days during June-August │
│ │ with snowfall >= 3.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNOW-AVGNDS-GE050TI │ Average number of days during June-August │
│ │ with snowfall >= 5.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNOW-AVGNDS-GE100TI │ Average number of days during June-August │
│ │ with snowfall >= 10.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNOW-NORMAL │ Average seasonal snowfall totals for │
│ │ June- August │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNWD-AVGNDS-GE001WI │ Average number of days during June-August │
│ │ with snow depth >= 1 inch │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNWD-AVGNDS-GE003WI │ Average number of days during June-August │
│ │ with snow depth >= 3 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNWD-AVGNDS-GE005WI │ Average number of days during June-August │
│ │ with snow depth >= 5 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-SNWD-AVGNDS-GE010WI │ Average number of days during June-August │
│ │ with snow depth >= 10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TAVG-NORMAL │ Average summer average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH040 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH050 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH060 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH070 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH080 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 80F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH090 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 90F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-GRTH100 │ Average number of days per summer where │
│ │ tmax is greater than or equal to 100F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-AVGNDS-LSTH032 │ Average number of days per summer where │
│ │ tmax is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMAX-NORMAL │ Average summer maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH000 │ Average number of days per summer where │
│ │ tmin is less than or equal to 0F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH010 │ Average number of days per summer where │
│ │ tmin is less than or equal to 10F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH020 │ Average number of days per summer where │
│ │ tmin is less than or equal to 20F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH032 │ Average number of days per summer where │
│ │ tmin is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH040 │ Average number of days per summer where │
│ │ tmin is less than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH050 │ Average number of days per summer where │
│ │ tmin is less than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH060 │ Average number of days per summer where │
│ │ tmin is less than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-AVGNDS-LSTH070 │ Average number of days per summer where │
│ │ tmin is less than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ JJA-TMIN-NORMAL │ Average summer minimum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE45 │ Average spring cooling degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE50 │ Average spring cooling degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE55 │ Average spring cooling degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE57 │ Average spring cooling degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE60 │ Average spring cooling degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE70 │ Average spring cooling degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-BASE72 │ Average spring cooling degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-CLDD-NORMAL │ Average spring cooling degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-DUTR-NORMAL │ Average spring diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE40 │ Average spring growing degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE45 │ Average spring growing degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE50 │ Average spring growing degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE55 │ Average spring growing degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE57 │ Average spring growing degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE60 │ Average spring growing degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE65 │ Average spring growing degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE70 │ Average spring growing degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-BASE72 │ Average spring growing degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-TB4886 │ Average summer growing degree days with │
│ │ truncated bases 48F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-GRDD-TB5086 │ Average summer growing degree days with │
│ │ truncated bases 50F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-BASE40 │ Average spring heating degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-BASE45 │ Average spring heating degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-BASE50 │ Average spring heating degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-BASE55 │ Average spring heating degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-BASE57 │ Average spring heating degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-BASE60 │ Average spring heating degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-HTDD-NORMAL │ Average spring heating degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-PRCP-AVGNDS-GE001HI │ Average number of days during March-May │
│ │ with precipitation >= 0.01 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-PRCP-AVGNDS-GE010HI │ Average number of days during March-May │
│ │ with precipitation >= a 0.10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-PRCP-AVGNDS-GE050HI │ Average number of days during March-May │
│ │ with precipitation >= 0.50 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-PRCP-AVGNDS-GE100HI │ Average number of days during March-May │
│ │ with precipitation >= 1.00 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-PRCP-NORMAL │ Average seasonal precipitation totals for │
│ │ March- May │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNOW-AVGNDS-GE001TI │ Average number of days during March-May │
│ │ with snowfall >= 0.1 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNOW-AVGNDS-GE010TI │ Average number of days during March-May │
│ │ with snowfall >= 1.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNOW-AVGNDS-GE030TI │ Average number of days during March-May │
│ │ with snowfall >= 3.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNOW-AVGNDS-GE050TI │ Average number of days during March-May │
│ │ with snowfall >= 5.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNOW-AVGNDS-GE100TI │ Average number of days during March-May │
│ │ with snowfall >= 10.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNOW-NORMAL │ Average seasonal snowfall totals for │
│ │ March- May │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNWD-AVGNDS-GE001WI │ Average number of days during March-May │
│ │ with snow depth >= 1 inch │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNWD-AVGNDS-GE003WI │ Average number of days during March-May │
│ │ with snow depth >= 3 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNWD-AVGNDS-GE005WI │ Average number of days during March-May │
│ │ with snow depth >= 5 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-SNWD-AVGNDS-GE010WI │ Average number of days during March-May │
│ │ with snow depth >= 10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TAVG-NORMAL │ Average spring average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH040 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH050 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH060 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH070 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH080 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 80F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH090 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 90F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-GRTH100 │ Average number of days per spring where │
│ │ tmax is greater than or equal to 100F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-AVGNDS-LSTH032 │ Average number of days per spring where │
│ │ tmax is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMAX-NORMAL │ Average spring maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH000 │ Average number of days per spring where │
│ │ tmin is less than or equal to 0F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH010 │ Average number of days per spring where │
│ │ tmin is less than or equal to 10F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH020 │ Average number of days per spring where │
│ │ tmin is less than or equal to 20F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH032 │ Average number of days per spring where │
│ │ tmin is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH040 │ Average number of days per spring where │
│ │ tmin is less than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH050 │ Average number of days per spring where │
│ │ tmin is less than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH060 │ Average number of days per spring where │
│ │ tmin is less than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-AVGNDS-LSTH070 │ Average number of days per spring where │
│ │ tmin is less than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ MAM-TMIN-NORMAL │ Average spring minimum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE45 │ Average autumn cooling degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE50 │ Average autumn cooling degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE55 │ Average autumn cooling degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE57 │ Average autumn cooling degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE60 │ Average autumn cooling degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE70 │ Average autumn cooling degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-BASE72 │ Average autumn cooling degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-CLDD-NORMAL │ Average autumn cooling degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-DUTR-NORMAL │ Average autumn diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE40 │ Average fall growing degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE45 │ Average fall growing degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE50 │ Average fall growing degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE55 │ Average fall growing degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE57 │ Average fall growing degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE60 │ Average fall growing degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE65 │ Average fall growing degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE70 │ Average fall growing degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-BASE72 │ Average fall growing degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-TB4886 │ Average summer growing degree days with │
│ │ truncated bases 48F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-GRDD-TB5086 │ Average summer growing degree days with │
│ │ truncated bases 50F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-BASE40 │ Average autumn heating degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-BASE45 │ Average autumn heating degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-BASE50 │ Average autumn heating degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-BASE55 │ Average autumn heating degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-BASE57 │ Average autumn heating degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-BASE60 │ Average autumn heating degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-HTDD-NORMAL │ Average autumn heating degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-PRCP-AVGNDS-GE001HI │ Average number of days during September- │
│ │ November with precipitation >= 0.01 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-PRCP-AVGNDS-GE010HI │ Average number of days during September- │
│ │ November with precipitation >= 0.10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-PRCP-AVGNDS-GE050HI │ Average number of days during September- │
│ │ November with precipitation >= 0.50 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-PRCP-AVGNDS-GE100HI │ Average number of days during September- │
│ │ November with precipitation >= 1.00 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-PRCP-NORMAL │ Average seasonal precipitation totals for │
│ │ September- November │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNOW-AVGNDS-GE001TI │ Average number of days during September- │
│ │ November with snowfall >= 0.1 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNOW-AVGNDS-GE010TI │ Average number of days during September- │
│ │ November with snowfall >= 1.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNOW-AVGNDS-GE030TI │ Average number of days during September- │
│ │ November with snowfall >= 3.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNOW-AVGNDS-GE050TI │ Average number of days during September- │
│ │ November with snowfall >= 5.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNOW-AVGNDS-GE100TI │ Average number of days during September- │
│ │ November with snowfall >= 10.0 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNOW-NORMAL │ Average seasonal snowfall totals for │
│ │ September- November │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNWD-AVGNDS-GE001WI │ Average number of days during September- │
│ │ November with snow depth >= 1 inch │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNWD-AVGNDS-GE003WI │ Average number of days during September- │
│ │ November with snow depth >= 3 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNWD-AVGNDS-GE005WI │ Average number of days during September- │
│ │ November with snow depth >= 5 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-SNWD-AVGNDS-GE010WI │ Average number of days during September- │
│ │ November with snow depth >= 10 in │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TAVG-NORMAL │ Average autumn average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH040 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH050 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH060 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH070 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH080 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 80F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH090 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 90F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-GRTH100 │ Average number of days per autumn where │
│ │ tmax is greater than or equal to 100F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-AVGNDS-LSTH032 │ Average number of days per autumn where │
│ │ tmax is less than or equal to 32F │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMAX-NORMAL │ Average autumn maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMIN-AVGNDS-LSTHxxx │ Average number of days per autumn where │
│ │ tmin is less than or equal to 'xxx' │
│ │ degree F. Where 'xxx' is one of 000, 010, │
│ │ 020, 032, 040, 050, 060, 070 │
├─────────────────────────┼───────────────────────────────────────────┤
│ SON-TMIN-NORMAL │ Average autumn minimum temperature │
╘═════════════════════════╧═══════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
ncei_normal_dly#
$ tsgettoolbox ncei_normal_dly --help
usage: tsgettoolbox ncei_normal_dly [-h] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags. For the GHCNDMS
dataset, the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
The following table lists the datatypes available for the annual dataset. Not
all datatypes are available for all stations.
┌─────────────────────────┬───────────────────────────────────────────┐
│ Code │ Description │
╞═════════════════════════╪═══════════════════════════════════════════╡
│ DLY-CLDD-BASE45 │ Average daily cooling degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-BASE50 │ Average daily cooling degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-BASE55 │ Average daily cooling degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-BASE57 │ Average daily cooling degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-BASE60 │ Average daily cooling degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-BASE70 │ Average daily cooling degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-BASE72 │ Average daily cooling degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-CLDD-NORMAL │ Average daily cooling degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-DUTR-NORMAL │ Average daily diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-DUTR-STDDEV │ Long-term standard deviations of daily │
│ │ diurnal temperature range │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE40 │ Average daily growing degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE45 │ Average daily growing degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE50 │ Average daily growing degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE55 │ Average daily growing degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE57 │ Average daily growing degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE60 │ Average daily growing degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE65 │ Average daily growing degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE70 │ Average daily growing degree days with │
│ │ base 70F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-BASE72 │ Average daily growing degree days with │
│ │ base 72F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-TB4886 │ Average daily growing degree days with │
│ │ truncated bases 48F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-GRDD-TB5086 │ Average daily growing degree days with │
│ │ truncated bases 50F and 86F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-BASE40 │ Average daily heating degree days with │
│ │ base 40F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-BASE45 │ Average daily heating degree days with │
│ │ base 45F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-BASE50 │ Average daily heating degree days with │
│ │ base 50F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-BASE55 │ Average daily heating degree days with │
│ │ base 55F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-BASE57 │ Average daily heating degree days with │
│ │ base 57F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-BASE60 │ Average daily heating degree days with │
│ │ base 60F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-HTDD-NORMAL │ Average daily heating degree days with │
│ │ base 65F │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-25PCTL │ 25th percentiles of daily nonzero │
│ │ precipitation totals for 29-day windows │
│ │ centered on each day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-50PCTL │ 50th percentiles of daily nonzero │
│ │ precipitation totals for 29-day windows │
│ │ centered on each day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-75PCTL │ 75th percentiles of daily nonzero │
│ │ precipitation totals for 29-day windows │
│ │ centered on each day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-PCTALL-GE001HI │ Probability of precipitation >= 0.01 in │
│ │ for 29-day windows centered on each day │
│ │ of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-PCTALL-GE010HI │ Probability of precipitation >= 0.10 in │
│ │ for 29-day windows centered on each day │
│ │ of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-PCTALL-GE050HI │ Probability of precipitation >= 0.50 in │
│ │ for 29-day windows centered on each day │
│ │ of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-PRCP-PCTALL-GE100HI │ Probability of precipitation >= 1.00 in │
│ │ for 29-day windows centered on each day │
│ │ of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-25PCTL │ 25th percentiles of daily nonzero │
│ │ snowfall totals for 29-day windows │
│ │ centered on each day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-50PCTL │ 50th percentiles of daily nonzero │
│ │ snowfall totals for 29-day windows │
│ │ centered on each day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-75PCTL │ 75th percentiles of daily nonzero │
│ │ snowfall totals for 29-day windows │
│ │ centered on each day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-PCTALL-GE001TI │ Probability of snowfall >= 0.1 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-PCTALL-GE010TI │ Probability of snowfall >= 1.0 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-PCTALL-GE030TI │ Probability of snowfall >= 3.0 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-PCTALL-GE050TI │ Probability of snowfall >= 5.0 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNOW-PCTALL-GE100TI │ Probability of snowfall >= 10 in for │
│ │ 29-day windows centered on each day of │
├─────────────────────────┼─the year──────────────────────────────────┤
│ DLY-SNWD-25PCTL │ 25th percentiles of daily nonzero snow │
│ │ depth for 29-day windows centered on each │
│ │ day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNWD-50PCTL │ 50th percentiles of daily nonzero snow │
│ │ depth for 29-day windows centered on each │
│ │ day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNWD-75PCTL │ 75th percentiles of daily nonzero snow │
│ │ depth for 29-day windows centered on each │
│ │ day of the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNWD-PCTALL-GE001WI │ Probability of snow depth >= 1 inch for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNWD-PCTALL-GE003WI │ Probability of snow depth >= 3 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNWD-PCTALL-GE005WI │ Probability of snow depth >= 5 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-SNWD-PCTALL-GE010WI │ Probability of snow depth >= 10 in for │
│ │ 29-day windows centered on each day of │
│ │ the year │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-TAVG-NORMAL │ Average daily average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-TAVG-STDDEV │ Long-term standard deviations of daily │
│ │ average temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-TMAX-NORMAL │ Average daily maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-TMAX-STDDEV │ Long-term standard deviations of daily │
│ │ maximum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-TMIN-NORMAL │ Average daily minimum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ DLY-TMIN-STDDEV │ Long-term standard deviations of daily │
│ │ minimum temperature │
├─────────────────────────┼───────────────────────────────────────────┤
│ MTD-PRCP-NORMAL │ Average month-to-date precipitation │
├─────────────────────────┼─totals────────────────────────────────────┤
│ MTD-SNOW-NORMAL │ Average month-to-date snowfall totals │
├─────────────────────────┼───────────────────────────────────────────┤
│ YTD-PRCP-NORMAL │ Average year-to-date precipitation totals │
├─────────────────────────┼───────────────────────────────────────────┤
│ YTD-SNOW-NORMAL │ Average year-to-date snowfall totals │
╘═════════════════════════╧═══════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
ncei_normal_hly#
$ tsgettoolbox ncei_normal_hly --help
usage: tsgettoolbox ncei_normal_hly [-h] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags. For the GHCNDMS
dataset, the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
The following table lists the datatypes available for the annual dataset. Not
all datatypes are available for all stations.
┌─────────────────┬────────────────────────────────────────┐
│ Code │ Description │
╞═════════════════╪════════════════════════════════════════╡
│ HLY-CLDH-NORMAL │ Cooling degree hours │
├─────────────────┼────────────────────────────────────────┤
│ HLY-CLOD-PCTBKN │ Clouds broken percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-CLOD-PCTCLR │ Clouds clear percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-CLOD-PCTFEW │ Clouds few percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-CLOD-PCTOVC │ Clouds overcast percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-CLOD-PCTSCT │ Clouds scattered percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-DEWP-10PCTL │ Dew point 10th percentile │
├─────────────────┼────────────────────────────────────────┤
│ HLY-DEWP-90PCTL │ Dew point 90th percentile │
├─────────────────┼────────────────────────────────────────┤
│ HLY-DEWP-NORMAL │ Dew point mean │
├─────────────────┼────────────────────────────────────────┤
│ HLY-HIDX-NORMAL │ Heat index mean │
├─────────────────┼────────────────────────────────────────┤
│ HLY-HTDH-NORMAL │ Heating degree hours │
├─────────────────┼────────────────────────────────────────┤
│ HLY-PRES-10PCTL │ Sea level pressure 10th percentile │
├─────────────────┼────────────────────────────────────────┤
│ HLY-PRES-90PCTL │ Sea level pressure 90th percentile │
├─────────────────┼────────────────────────────────────────┤
│ HLY-PRES-NORMAL │ Sea level pressure mean │
├─────────────────┼────────────────────────────────────────┤
│ HLY-TEMP-10PCTL │ Temperature 10th percentile │
├─────────────────┼────────────────────────────────────────┤
│ HLY-TEMP-90PCTL │ Temperature 90th percentile │
├─────────────────┼────────────────────────────────────────┤
│ HLY-TEMP-NORMAL │ Temperature mean │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WCHL-NORMAL │ Wind chill mean │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-1STDIR │ Prevailing wind direction (1-8) │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-1STPCT │ Prevailing wind percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-2NDDIR │ Secondary wind direction (1-8) │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-2NDPCT │ Secondary wind percentage │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-AVGSPD │ Average wind speed │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-PCTCLM │ Percentage calm │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-VCTDIR │ Mean wind vector direction │
├─────────────────┼────────────────────────────────────────┤
│ HLY-WIND-VCTSPD │ Mean wind vector magnitude │
╘═════════════════╧════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
ncei_normal_mly#
$ tsgettoolbox ncei_normal_mly --help
usage: tsgettoolbox ncei_normal_mly [-h] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags. For the GHCNDMS
dataset, the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
The following table lists the datatypes available for the annual dataset. Not
all of the datatypes are available for all stations.
┌──────────────────────┬────────────────────────────────────────┐
│ Code │ Description │
╞══════════════════════╪════════════════════════════════════════╡
│ MLY-CLDD-BASE45 │ Average monthly cooling degree days │
│ │ with base 45F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-BASE50 │ Average monthly cooling degree days │
│ │ with base 50F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-BASE55 │ Average monthly cooling degree days │
│ │ with base 55F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-BASE57 │ Average monthly cooling degree days │
│ │ with base 57F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-BASE60 │ Average monthly cooling degree days │
│ │ with base 60F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-BASE70 │ Average monthly cooling degree days │
│ │ with base 70F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-BASE72 │ Average monthly cooling degree days │
│ │ with base 72F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-CLDD-NORMAL │ Average monthly cooling degree days │
│ │ with base 65F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-DUTR-NORMAL │ Average monthly diurnal temperature │
│ │ range │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-DUTR-STDDEV │ Long-term standard deviations of │
│ │ monthly diurnal temperature range │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE40 │ Average monthly growing degree days │
│ │ with base 40F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE45 │ Average monthly growing degree days │
│ │ with base 45F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE50 │ Average monthly growing degree days │
│ │ with base 50F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE55 │ Average monthly growing degree days │
│ │ with base 55F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE57 │ Average monthly growing degree days │
│ │ with base 57F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE60 │ Average monthly growing degree days │
│ │ with base 60F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE65 │ Average monthly growing degree days │
│ │ with base 65F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE70 │ Average monthly growing degree days │
│ │ with base 70F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-BASE72 │ Average monthly growing degree days │
│ │ with base 72F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-TB4886 │ Average monthly growing degree days │
│ │ with truncated bases 48F and 86F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-GRDD-TB5086 │ Average monthly growing degree days │
│ │ with truncated bases 50F and 86F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-BASE40 │ Average monthly heating degree days │
│ │ with base 40F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-BASE45 │ Average monthly heating degree days │
│ │ with base 45F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-BASE50 │ Average monthly heating degree days │
│ │ with base 50F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-BASE55 │ Average monthly heating degree days │
│ │ with base 55F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-BASE57 │ Average monthly heating degree days │
│ │ with base 57F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-BASE60 │ Average monthly heating degree days │
│ │ with base 60F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-HTDD-NORMAL │ Average monthly heating degree days │
│ │ with base 65F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-25PCTL │ 25th percentiles of monthly │
│ │ precipitation totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-50PCTL │ 50th percentiles of monthly │
│ │ precipitation totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-75PCTL │ 75th percentiles of monthly │
│ │ precipitation totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-AVGNDS- │ Average number of days per month with │
│ GE001HI │ precipitation >= 0.01 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-AVGNDS- │ Average number of days per month with │
│ GE010HI │ precipitation >= 0.10 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-AVGNDS- │ Average number of days per month with │
│ GE050HI │ precipitation >= 0.50 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-AVGNDS- │ Average number of days per month with │
│ GE100HI │ precipitation >= 1.00 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-PRCP-NORMAL │ Average monthly precipitation totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-25PCTL │ 25th percentiles of monthly snowfall │
│ │ totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-50PCTL │ 50th percentiles of monthly snowfall │
│ │ totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-75PCTL │ 75th percentiles of monthly snowfall │
│ │ totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-AVGNDS- │ Average number of days per month with │
│ GE001TI │ Snowfall >= 0.1 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-AVGNDS- │ Average number of days per month with │
│ GE010TI │ Snowfall >= 1.0 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-AVGNDS- │ Average number of days per month with │
│ GE030TI │ Snowfall >= 3.0 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-AVGNDS- │ Average number of days per month with │
│ GE050TI │ Snowfall >= 5.0 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-AVGNDS- │ Average number of days per month with │
│ GE100TI │ Snowfall >= 10.0 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNOW-NORMAL │ Average monthly snowfall totals │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNWD-AVGNDS- │ Average number of days per month with │
│ GE001WI │ snow depth >= 1 inch │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNWD-AVGNDS- │ Average number of days per month with │
│ GE003WI │ snow depth >= 3 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNWD-AVGNDS- │ Average number of days per month with │
│ GE005WI │ snow depth >= 5 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-SNWD-AVGNDS- │ Average number of days per month with │
│ GE010WI │ snow depth >= 10 in │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TAVG-NORMAL │ Average monthly average temperature │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TAVG-STDDEV │ Long-term standard deviations of │
│ │ monthly average temperature │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH040 │ tmax is greater than or equal to 40F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH050 │ tmax is greater than or equal to 50F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH060 │ tmax is greater than or equal to 60F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH070 │ tmax is greater than or equal to 70F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH080 │ tmax is greater than or equal to 80F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH090 │ tmax is greater than or equal to 90F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ GRTH100 │ tmax is greater than or equal to 100F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-AVGNDS- │ Average number of days per month where │
│ LSTH032 │ tmax is less than or equal to 32F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-NORMAL │ Average monthly maximum temperature │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMAX-STDDEV │ Long-term standard deviations of │
│ │ monthly maximum temperature │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH000 │ tmin is less than or equal to 0F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH010 │ tmin is less than or equal to 10F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH020 │ tmin is less than or equal to 20F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH032 │ tmin is less than or equal to 32F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH040 │ tmin is less than or equal to 40F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH050 │ tmin is less than or equal to 50F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH060 │ tmin is less than or equal to 60F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-AVGNDS- │ Average number of days per month where │
│ LSTH070 │ tmin is less than or equal to 70F │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-NORMAL │ Average monthly minimum temperature │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-PRBOCC- │ probability of 16F or below at least │
│ LSTH016 │ once in the month │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-PRBOCC- │ probability of 20F or below at least │
│ LSTH020 │ once in the month │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-PRBOCC- │ probability of 24F or below at least │
│ LSTH024 │ once in the month │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-PRBOCC- │ probability of 28F or below at least │
│ LSTH028 │ once in the month │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-PRBOCC- │ probability of 32F or below at least │
│ LSTH032 │ once in the month │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-PRBOCC- │ probability of 36F or below at least │
│ LSTH036 │ once in the month │
├──────────────────────┼────────────────────────────────────────┤
│ MLY-TMIN-STDDEV │ Long-term standard deviations of │
│ │ monthly minimum temperature │
╘══════════════════════╧════════════════════════════════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
ncei_precip_15#
$ tsgettoolbox ncei_precip_15 --help
usage: tsgettoolbox ncei_precip_15 [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags. For the GHCNDMS
dataset, the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
The following table lists the datatypes available for the annual dataset. Not
all datatypes are available for all stations.
┌──────┬───────────────┐
│ Code │ Description │
╞══════╪═══════════════╡
│ QGAG │ Precipitation │
├──────┼───────────────┤
│ QPCP │ Precipitation │
╘══════╧═══════════════╛
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ncei_precip_hly#
$ tsgettoolbox ncei_precip_hly --help
usage: tsgettoolbox ncei_precip_hly [-h] [--start_date START_DATE]
[--end_date END_DATE] stationid
Requires registration and free API key.
For every datatype and record there is a set of meta-data flags. For the GHCNDMS
dataset, the flags are:
'Total Missing','Consecutive Missing'
Total Missing:
Defined as total number of days observation/element is missing in that month.
This can be taken as a measure of quality or completeness as the higher the
number of days sampled in the month, the more representative the value is for
the entire month.
Consecutive Missing:
Defined as the maximum number of consecutive days in the month that an
observation/element is missing.
positional arguments:
stationid The station id. from the first column of
<[4;36mhttps://www.ncei.noaa.gov/pub/data/ghcn/daily/ghcnd-stations.txt[0m>
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
ndbc#
$ tsgettoolbox ndbc --help
usage: tsgettoolbox ndbc [-h] [--endUTC ENDUTC] station table startUTC
Download historical data from the National Data Buoy Center.
The Active Station List is available at <[4;36mhttp://www.ndbc.noaa.gov/active-
stations.xml[0m>
When accessing Historical data files, the measurements are generally in metric
units, as described below, and cannot be changed.
Historical files show times in UTC only.
positional arguments:
station Five-digit WMO Station Identifier, used since 1976. ID's can be
reassigned to future deployments within the same 1 degree square.
table The 'table' option is one of the
following:
┌────────┬────────────────────────────────┐
│ table │ Description │
╞════════╪════════════════════════════════╡
│ adcp │ Ocean Current data │
├────────┼────────────────────────────────┤
│ cwind │ Continuous Wind Data │
├────────┼────────────────────────────────┤
│ ocean │ Oceanographic Data │
├────────┼────────────────────────────────┤
│ srad │ Solar Radiation Data │
├────────┼────────────────────────────────┤
│ stdmet │ Standard Meteorology Table │
├────────┼────────────────────────────────┤
│ supl │ Supplemental Measurements Data │
├────────┼────────────────────────────────┤
│ wlevel │ Water Level Data │
╘════════╧════════════════════════════════╛
'adcp' Ocean Current Data
┌─────────────────┬───────────────────────────────────────────────┐
│ Variable │ Description │
╞═════════════════╪═══════════════════════════════════════════════╡
│ DEP01,DEP02,... │ The distance from the sea surface to the │
│ │ middle of the depth cells, or bins, measured │
│ │ in meters. │
├─────────────────┼───────────────────────────────────────────────┤
│ DIR01,DIR02,... │ The direction the ocean current is flowing │
│ │ toward. 0-360 degrees, 360 is due north, 0 │
│ │ means no measurable current. │
├─────────────────┼───────────────────────────────────────────────┤
│ SPD01,SPD02,... │ The speed of the ocean current measured in │
│ │ cm/s. │
╘═════════════════╧═══════════════════════════════════════════════╛
'cwind' Continuous Winds
┌───────┬─────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═══════╪═════════════════════════════════════════════════════════╡
│ WDIR │ Ten-minute average wind direction measurements in │
│ │ degrees clockwise from true North. (DIR in Historical │
├───────┼─files)──────────────────────────────────────────────────┤
│ WSPD │ Ten-minute average wind speed values in m/s. (SPD in │
│ │ Historical files) │
├───────┼─────────────────────────────────────────────────────────┤
│ GDR │ Direction, in degrees clockwise from true North, of the │
│ │ GST, reported at the last hourly 10-minute segment. │
├───────┼─────────────────────────────────────────────────────────┤
│ GST │ Maximum 5-second peak gust during the measurement hour, │
│ │ reported at the last hourly 10-minute segment. │
├───────┼─────────────────────────────────────────────────────────┤
│ GTIME │ The minute of the hour that the GSP occurred, reported │
│ │ at the last hourly 10-minute segment. │
╘═══════╧═════════════════════════════════════════════════════════╛
'ocean' Oceanographic Data
┌───────────┬─────────────────────────────────────────────────────┐
│ Code │ Description │
╞═══════════╪═════════════════════════════════════════════════════╡
│ DEPTH │ Depth (meters) at which measurements are taken. │
├───────────┼─────────────────────────────────────────────────────┤
│ OTMP │ The direct measurement (Celsius) of the Ocean │
│ │ Temperature (as opposed to the indirect measurement │
│ │ (see WTMP above)). │
├───────────┼─────────────────────────────────────────────────────┤
│ COND │ Conductivity is a measure of the electrical │
│ │ conductivity properties of seawater in milliSiemens │
│ │ per centimeter. │
├───────────┼─────────────────────────────────────────────────────┤
│ SAL │ Salinity is computed by a known functional │
│ │ relationship between the measured electrical │
│ │ conductivity of seawater (CON), temperature (OTMP) │
│ │ and pressure. Salinity is computed using the │
│ │ Practical Salinity Scale of 1978 (PSS78) and │
│ │ reported in Practical Salinity Units. │
├───────────┼─────────────────────────────────────────────────────┤
│ O2PERCENT │ Dissolved oxygen as a percentage. │
├───────────┼─────────────────────────────────────────────────────┤
│ O2PPM │ Dissolved oxygen in parts per million. │
├───────────┼─────────────────────────────────────────────────────┤
│ CLCON │ Chlorophyll concentration in micrograms per liter │
│ │ (ug/l). │
├───────────┼─────────────────────────────────────────────────────┤
│ TURB │ Turbidity is an expression of the optical property │
│ │ that causes light to be scattered and absorbed │
│ │ rather than transmitted in straight lines through │
│ │ the sample (APHA 1980). Units are Formazine │
│ │ Turbidity Units (FTU). │
├───────────┼─────────────────────────────────────────────────────┤
│ PH │ A measure of the acidity or alkalinity of the │
│ │ seawater. │
├───────────┼─────────────────────────────────────────────────────┤
│ EH │ Redox (oxidation and reduction) potential of │
│ │ seawater in millivolts. │
╘═══════════╧═════════════════════════════════════════════════════╛
'srad' Shortwave Radiation
┌───────┬─────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═══════╪═════════════════════════════════════════════════════════╡
│ SRAD1 │ Average shortwave radiation in watts per square meter │
│ SWRAD │ for the preceding hour. Sample frequency is 2 times per │
│ │ second (2 Hz). If present, SRAD1 is from a LI-COR │
│ │ LI-200 pyranometer sensor, and SWRAD is from an Eppley │
│ │ PSP Precision Spectral Pyranometer. │
├───────┼─────────────────────────────────────────────────────────┤
│ LWRAD │ Average downwelling longwave radiation in watts per │
│ │ square meter for the preceding hour. Sample frequency │
│ │ is 2 times per second (2 Hz). If present, LWRAD is from │
│ │ an Eppley PIR Precision Infrared Radiometer. │
╘═══════╧═════════════════════════════════════════════════════════╛
'stdmet' Standard Meteorology Table
┌──────┬──────────────────────────────────────────────────────────┐
│ Code │ Description │
╞══════╪══════════════════════════════════════════════════════════╡
│ WDIR │ Wind direction (the direction the wind is coming from in │
│ │ degrees clockwise from true N) during the same period │
│ │ used for WSPD. See Wind Averaging Methods │
├──────┼──────────────────────────────────────────────────────────┤
│ WSPD │ Wind speed (m/s) averaged over an eight-minute period │
│ │ for buoys and a two-minute period for land stations. │
│ │ Reported Hourly. See Wind Averaging Methods. │
├──────┼──────────────────────────────────────────────────────────┤
│ GST │ Peak 5 or 8 second gust speed (m/s) measured during the │
│ │ eight-minute or two-minute period. The 5 or 8 second │
│ │ period can be determined by payload, See the Sensor │
│ │ Reporting, Sampling, and Accuracy section. │
├──────┼──────────────────────────────────────────────────────────┤
│ WVHT │ Significant wave height (meters) is calculated as the │
│ │ average of the highest one-third of all of the wave │
│ │ heights during the 20-minute sampling period. See the │
│ │ Wave Measurements section. │
├──────┼──────────────────────────────────────────────────────────┤
│ DPD │ Dominant wave period (seconds) is the period with the │
│ │ maximum wave energy. See the Wave Measurements section. │
├──────┼──────────────────────────────────────────────────────────┤
│ APD │ Average wave period (seconds) of all waves during the │
│ │ 20-minute period. See the Wave Measurements section. │
├──────┼──────────────────────────────────────────────────────────┤
│ MWD │ The direction from which the waves at the dominant │
│ │ period (DPD) are coming. The units are degrees from true │
│ │ North increasing clockwise, with North as 0 (zero) │
│ │ degree East as 90 degrees. See the Wave Measurements │
├──────┼─section.─────────────────────────────────────────────────┤
│ PRES │ Sea level pressure (hPa). For C-MAN sites and Great │
│ │ Lakes buoys, the recorded pressure is reduced to sea │
│ │ level using the method described in NWS Technical │
│ │ Procedure Bulletin 291 (11/14/80). ( labeled BAR in │
├──────┼─Historical files)────────────────────────────────────────┤
│ ATMP │ Air temperature (Celsius). For sensor heights on buoys, │
│ │ see Hull Descriptions. For sensor heights at C-MAN │
│ │ stations, see C-MAN Sensor Locations │
├──────┼──────────────────────────────────────────────────────────┤
│ WTMP │ Sea surface temperature (Celsius). For buoys the depth │
│ │ is referenced to the hull's waterline. For fixed │
│ │ platforms it varies with tide, but is referenced to, or │
│ │ near Mean Lower Low Water (MLLW). │
├──────┼──────────────────────────────────────────────────────────┤
│ DEWP │ Dewpoint temperature taken at the same height as the air │
│ │ temperature measurement. │
├──────┼──────────────────────────────────────────────────────────┤
│ VIS │ Station visibility (nautical miles). Note that buoy │
│ │ stations are limited to reports from 0 to 1.6 nmi. │
├──────┼──────────────────────────────────────────────────────────┤
│ PTDY │ Pressure Tendency is the direction (plus or minus) and │
│ │ the amount of pressure change (hPa)for a three hour │
│ │ period ending at the time of observation. (not in │
│ │ Historical files) │
├──────┼──────────────────────────────────────────────────────────┤
│ TIDE │ The water level in feet above or below Mean Lower Low │
│ │ Water (MLLW). │
╘══════╧══════════════════════════════════════════════════════════╛
'supl' Supplemental Measurements Data
┌───────┬─────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═══════╪═════════════════════════════════════════════════════════╡
│ PRES │ Lowest recorded 1 minute atmospheric pressure for the │
│ │ hour to the nearest 0.1 hPa. │
├───────┼─────────────────────────────────────────────────────────┤
│ PTIME │ The time at which PRES occurred (hour and minute). │
├───────┼─────────────────────────────────────────────────────────┤
│ WSPD │ Highest recorded 1 minute wind speed for the hour to │
│ │ the nearest 0.1 m/s. │
├───────┼─────────────────────────────────────────────────────────┤
│ WDIR │ WSPD corresponding direction to the nearest degree. │
├───────┼─────────────────────────────────────────────────────────┤
│ WTIME │ The time at which WSPD occurred (hour and minute). │
╘═══════╧═════════════════════════════════════════════════════════╛
'wlevel' Water Level
┌────────┬────────────────────────────────────────────────────────┐
│ Code │ Description │
╞════════╪════════════════════════════════════════════════════════╡
│ WLEVEL │ Six-minute water levels representing the height, in │
│ │ feet, of the water above or below Mean Lower Low Water │
│ │ (MLLW), offset by 10 ft. to prevent negative values. │
│ │ Please subtract 10 ft. from every value to obtain the │
│ │ true water level value, in reference to MLLW. │
╘════════╧════════════════════════════════════════════════════════╛
startUTC an ISO 8601 date/time string
(only seconds are optional)
options:
-h | --help
show this help message and exit
--endUTC ENDUTC
[optional, default to None implies now]
an ISO 8601 date/time string. (only seconds are optional)
nwis#
$ tsgettoolbox nwis --help
<string>:49: (WARNING/2) Option list ends without a blank line; unexpected unindent.
usage: tsgettoolbox nwis [-h] [--sites SITES] [--stateCd STATECD] [--huc HUC]
[--bBox BBOX] [--countyCd COUNTYCD] [--parameterCd PARAMETERCD] [--period
PERIOD] [--startDT STARTDT] [--endDT ENDDT] [--siteType SITETYPE]
[--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD] [--siteStatus
SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX] [--drainAreaMin
DRAINAREAMIN] [--drainAreaMax DRAINAREAMAX] [--aquiferCd AQUIFERCD]
[--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX] [--database DATABASE] [--statReportType STATREPORTTYPE]
[--statType STATTYPE] [--missingData MISSINGDATA] [--statYearType
STATYEARTYPE]
This "nwis" function has been split up into individual functions for each source
database. This allows for keywords and output to be tailored to each specific
web service.
┌───────────────────┬───────────────────────────────┐
│ New Function │ Database Name and Description │
╞═══════════════════╪═══════════════════════════════╡
│ nwis_iv │ Instantaneous Value sub-daily │
│ │ interval data starting in │
├───────────────────┼─2007──────────────────────────┤
│ nwis_dv │ Daily Values database │
├───────────────────┼───────────────────────────────┤
│ nwis_stat │ daily/monthly/annual │
├───────────────────┼─statistics────────────────────┤
│ nwis_site │ Site metadata │
├───────────────────┼───────────────────────────────┤
│ nwis_measurements │ Field measurements │
├───────────────────┼───────────────────────────────┤
│ nwis_peak │ Peak flow and stage │
├───────────────────┼───────────────────────────────┤
│ nwis_gwlevels │ Ground water levels │
╘═══════════════════╧═══════════════════════════════╛
This function/sub-command will continue to work, however you should change all
scripts to use the split out functions.
options:
-h | --help
show this help message and exit
Option list ends without a blank line; unexpected unindent.
--sites SITES --stateCd STATECD --huc HUC --bBox BBOX --countyCd COUNTYCD
--parameterCd PARAMETERCD --period PERIOD --startDT STARTDT --endDT ENDDT
--siteType SITETYPE --modifiedSince MODIFIEDSINCE --agencyCd AGENCYCD
--siteStatus SITESTATUS --altMin ALTMIN --altMax ALTMAX --drainAreaMin
DRAINAREAMIN --drainAreaMax DRAINAREAMAX --aquiferCd AQUIFERCD
--localAquiferCd LOCALAQUIFERCD --wellDepthMin WELLDEPTHMIN --wellDepthMax
WELLDEPTHMAX --holeDepthMin HOLEDEPTHMIN --holeDepthMax HOLEDEPTHMAX
--database DATABASE --statReportType STATREPORTTYPE --statType STATTYPE
--missingData MISSINGDATA --statYearType STATYEARTYPE
nwis_dv#
$ tsgettoolbox nwis_dv --help
usage: tsgettoolbox nwis_dv [-h] [--sites SITES] [--stateCd STATECD]
[--huc HUC] [--bBox BBOX] [--countyCd COUNTYCD] [--agencyCd AGENCYCD]
[--altMax ALTMAX] [--altMin ALTMIN] [--aquiferCd AQUIFERCD] [--drainAreaMax
DRAINAREAMAX] [--drainAreaMin DRAINAREAMIN] [--holeDepthMax HOLEDEPTHMAX]
[--holeDepthMin HOLEDEPTHMIN] [--localAquiferCd LOCALAQUIFERCD]
[--modifiedSince MODIFIEDSINCE] [--parameterCd PARAMETERCD] [--siteStatus
SITESTATUS] [--siteType SITETYPE] [--wellDepthMax WELLDEPTHMAX]
[--wellDepthMin WELLDEPTHMIN] [--startDT STARTDT] [--endDT ENDDT] [--period
PERIOD] [--include_codes] [--statisticsCd STATISTICSCD]
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mResults[0m
The column name in the resulting table is made up of
"agencyCd_siteno_parameterCd", for example "USGS_02248380_00010". The agency
and parameter codes are described in the agencyCd and parameterCd options
below.
If include_codes option is used, there will also be columns representing the
data quality codes named "agencyCd_siteno_parameterCd_cd".
┌─────────┬────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═════════╪════════════════════════════════════════════════════════╡
│ e │ Value has been edited or estimated by USGS personnel │
│ │ and is write protected │
├─────────┼────────────────────────────────────────────────────────┤
│ & │ Value was computed from affected unit values │
├─────────┼────────────────────────────────────────────────────────┤
│ E │ Value was computed from estimated unit values. │
├─────────┼────────────────────────────────────────────────────────┤
│ A │ Approved for publication -- Processing and review │
│ │ completed. │
├─────────┼────────────────────────────────────────────────────────┤
│ P │ Provisional data subject to revision. │
├─────────┼────────────────────────────────────────────────────────┤
│ < │ The value is known to be less than reported value and │
│ │ is write protected. │
├─────────┼────────────────────────────────────────────────────────┤
│ > │ The value is known to be greater than reported value │
│ │ and is write protected. │
├─────────┼────────────────────────────────────────────────────────┤
│ 1 │ Value is write protected without any remark code to be │
│ │ printed │
├─────────┼────────────────────────────────────────────────────────┤
│ 2 │ Remark is write protected without any remark code to │
│ │ be printed │
├─────────┼────────────────────────────────────────────────────────┤
│ │ No remark (blank) │
├─────────┼────────────────────────────────────────────────────────┤
│ Ssn │ Parameter monitored seasonally │
├─────────┼────────────────────────────────────────────────────────┤
│ Ice │ Ice affected │
├─────────┼────────────────────────────────────────────────────────┤
│ Pr │ Partial-record site │
├─────────┼────────────────────────────────────────────────────────┤
│ Rat │ Rating being developed or revised │
├─────────┼────────────────────────────────────────────────────────┤
│ Eqp │ Equipment malfunction │
├─────────┼────────────────────────────────────────────────────────┤
│ Fld │ Flood damage │
├─────────┼────────────────────────────────────────────────────────┤
│ Dis │ Data-collection discontinued │
├─────────┼────────────────────────────────────────────────────────┤
│ Dry │ Dry │
├─────────┼────────────────────────────────────────────────────────┤
│ -- │ Parameter not determined │
├─────────┼────────────────────────────────────────────────────────┤
│ Mnt │ Maintenance in progress │
├─────────┼────────────────────────────────────────────────────────┤
│ ZFl │ Zero flow │
├─────────┼────────────────────────────────────────────────────────┤
│ *** │ Temporarily unavailable │
╘═════════╧════════════════════════════════════════════════════════╛
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--stateCd STATECD
[optional, default is None, major site filter]
U.S. postal service (2-digit) state code. Can have only 1 state code. List
is available at <[4;36mhttp://www.usps.com/ncsc/lookups/usps_abbre-
viations.html[0m>:
--stateCd=NY
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--countyCd COUNTYCD
[optional, default is None, major site filter]
A list of county numbers, in a 5 digit numeric format. The first two
digits of a county's code are the FIPS State Code. Can have from 1
to 20 county codes. The first 2 digits are the FIPS State Code
(<[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>) and the list of
county codes are at <[4;36mhttp://help.waterdata.usgs.gov/code/cou-
nty_query?fmt=html[0m>:
--countyCd=51059,51061
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--drainAreaMax DRAINAREAMAX
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
Providing a value to drainAreaMax (maximum drainage area) means you want
sites that have or are less than the drainAreaMax value.:
--drainAreaMin=1000 --drainAreaMax=5000
# Return sites where the drainage area
# is 1000 square miles or greater and
# is 5000 square miles or less.
--drainAreaMin=10.5 --drainAreaMax=10.7
# Return sites where the drainage area
# is 10.5 square miles or greater and
# is 10.7 square miles or less.
--drainAreaMin DRAINAREAMIN
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
These arguments allows you to select principally surface water sites where
the associated sites' drainage areas (watersheds) are within a
desired size, expressed in square miles or decimal fractions
thereof. Providing a value to drainAreaMin (minimum drainage area)
means you want sites that have or exceed the drainAreaMin value. The
values may be expressed in decimals. If both the drainAreaMin and
drainAreaMax are specified, sites at or between the minimum and
maximum drainage areas values specified are returned Caution: not
all sites are associated with a drainage area. Caution: drainage
area generally only applies to surface water sites. Use with other
site types, such as groundwater sites, will likely retrieve no
results.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--include_codes
[optional, default is False]
Whether or not to include the metadata/quality code column. Useful to
almost halve the size of the pandas DataFrame.
--statisticsCd STATISTICSCD
[optional, default is None]
The statisticsCd represents how the instantaneous values are aggregated.
The statisticsCd is from the following table:
┌───────┬────────────────────────────────────┐
│ Code │ Description │
╞═══════╪════════════════════════════════════╡
│ 00001 │ MAXIMUM VALUES │
├───────┼────────────────────────────────────┤
│ 00002 │ MINIMUM VALUES │
├───────┼────────────────────────────────────┤
│ 00003 │ MEAN VALUES │
├───────┼────────────────────────────────────┤
│ 00004 │ VALUES TAKEN BETWEEN 0001 AND 1200 │
├───────┼────────────────────────────────────┤
│ 00005 │ VALUES TAKEN BETWEEN 1201 AND 2400 │
├───────┼────────────────────────────────────┤
│ 00006 │ SUMMATION VALUES │
├───────┼────────────────────────────────────┤
│ 00007 │ MODAL VALUES │
├───────┼────────────────────────────────────┤
│ 00008 │ MEDIAN VALUES │
├───────┼────────────────────────────────────┤
│ 00009 │ STANDARD DEVIATION VALUES │
├───────┼────────────────────────────────────┤
│ 00010 │ VARIANCE VALUES │
├───────┼────────────────────────────────────┤
│ 00011 │ RANDOM INSTANTANEOUS VALUES │
├───────┼────────────────────────────────────┤
│ 00012 │ EQUIVALENT MEAN VALUES │
├───────┼────────────────────────────────────┤
│ 00013 │ SKEWNESS VALUES │
├───────┼────────────────────────────────────┤
│ 00021 │ TIDAL HIGH-HIGH VALUES │
├───────┼────────────────────────────────────┤
│ 00022 │ TIDAL LOW-HIGH VALUES │
├───────┼────────────────────────────────────┤
│ 00023 │ TIDAL HIGH-LOW VALUES │
├───────┼────────────────────────────────────┤
│ 00024 │ TIDAL LOW-LOW VALUES │
├───────┼────────────────────────────────────┤
│ 01XXY │ XX.Y PERCENTILE │
├───────┼────────────────────────────────────┤
│ 02LLL │ LLL DAY LOW MEAN │
├───────┼────────────────────────────────────┤
│ 03HHH │ HHH DAY HIGH MEAN │
├───────┼────────────────────────────────────┤
│ 3TTTT │ INSTANTANEOUS OBSERVATION AT TTTT │
╘═══════╧════════════════════════════════════╛
nwis_gwlevels#
$ tsgettoolbox nwis_gwlevels --help
usage: tsgettoolbox nwis_gwlevels [-h] [--sites SITES] [--stateCd STATECD]
[--huc HUC] [--bBox BBOX] [--countyCd COUNTYCD] [--parameterCd PARAMETERCD]
[--period PERIOD] [--startDT STARTDT] [--endDT ENDDT] [--siteType SITETYPE]
[--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD] [--siteStatus
SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX] [--aquiferCd AQUIFERCD]
[--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX]
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mResults[0m
┌───────────────┬───────────────────────────────┐
│ Column │ Description │
╞═══════════════╪═══════════════════════════════╡
│ agency_cd │ Agency code │
├───────────────┼───────────────────────────────┤
│ site_no │ USGS site number │
├───────────────┼───────────────────────────────┤
│ site_tp_cd │ Site type code │
├───────────────┼───────────────────────────────┤
│ lev_dt │ Date level measured │
├───────────────┼───────────────────────────────┤
│ lev_tm │ Time level measured │
├───────────────┼───────────────────────────────┤
│ lev_tz_cd │ Time datum │
├───────────────┼───────────────────────────────┤
│ lev_va │ Water-level value in feet │
│ │ below land surface │
├───────────────┼───────────────────────────────┤
│ sl_lev_va │ Water-level value in feet │
│ │ above specific vertical datum │
├───────────────┼───────────────────────────────┤
│ sl_datum_cd │ Referenced vertical datum │
├───────────────┼───────────────────────────────┤
│ lev_status_cd │ Status │
├───────────────┼───────────────────────────────┤
│ lev_agency_cd │ Measuring agency │
╘═══════════════╧═══════════════════════════════╛
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--stateCd STATECD
[optional, default is None, major site filter]
U.S. postal service (2-digit) state code. Can have only 1 state code. List
is available at <[4;36mhttp://www.usps.com/ncsc/lookups/usps_abbre-
viations.html[0m>:
--stateCd=NY
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--countyCd COUNTYCD
[optional, default is None, major site filter]
A list of county numbers, in a 5 digit numeric format. The first two
digits of a county's code are the FIPS State Code. Can have from 1
to 20 county codes. The first 2 digits are the FIPS State Code
(<[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>) and the list of
county codes are at <[4;36mhttp://help.waterdata.usgs.gov/code/cou-
nty_query?fmt=html[0m>:
--countyCd=51059,51061
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
nwis_iv#
$ tsgettoolbox nwis_iv --help
usage: tsgettoolbox nwis_iv [-h] [--sites SITES] [--stateCd STATECD]
[--huc HUC] [--bBox BBOX] [--countyCd COUNTYCD] [--parameterCd PARAMETERCD]
[--siteType SITETYPE] [--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD]
[--siteStatus SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX]
[--drainAreaMin DRAINAREAMIN] [--drainAreaMax DRAINAREAMAX] [--aquiferCd
AQUIFERCD] [--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX] [--period PERIOD] [--startDT STARTDT] [--endDT ENDDT]
[--include_codes]
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mResults[0m
The column name in the resulting table is made up of
"agencyCd_siteno_parameterCd", for example "USGS_02248380_00010". The agency
and parameter codes are described in the agencyCd and parameterCd options
below.
If include_codes option is used, there will also be columns representing the
data quality codes named "agencyCd_siteno_parameterCd_cd".
┌─────────┬────────────────────────────────────────────────────────┐
│ Code │ Description │
╞═════════╪════════════════════════════════════════════════════════╡
│ e │ Value has been edited or estimated by USGS personnel │
│ │ and is write protected │
├─────────┼────────────────────────────────────────────────────────┤
│ & │ Value was computed from affected unit values │
├─────────┼────────────────────────────────────────────────────────┤
│ E │ Value was computed from estimated unit values. │
├─────────┼────────────────────────────────────────────────────────┤
│ A │ Approved for publication -- Processing and review │
│ │ completed. │
├─────────┼────────────────────────────────────────────────────────┤
│ P │ Provisional data subject to revision. │
├─────────┼────────────────────────────────────────────────────────┤
│ < │ The value is known to be less than reported value and │
│ │ is write protected. │
├─────────┼────────────────────────────────────────────────────────┤
│ > │ The value is known to be greater than reported value │
│ │ and is write protected. │
├─────────┼────────────────────────────────────────────────────────┤
│ 1 │ Value is write protected without any remark code to be │
│ │ printed │
├─────────┼────────────────────────────────────────────────────────┤
│ 2 │ Remark is write protected without any remark code to │
│ │ be printed │
├─────────┼────────────────────────────────────────────────────────┤
│ │ No remark (blank) │
├─────────┼────────────────────────────────────────────────────────┤
│ Ssn │ Parameter monitored seasonally │
├─────────┼────────────────────────────────────────────────────────┤
│ Ice │ Ice affected │
├─────────┼────────────────────────────────────────────────────────┤
│ Pr │ Partial-record site │
├─────────┼────────────────────────────────────────────────────────┤
│ Rat │ Rating being developed or revised │
├─────────┼────────────────────────────────────────────────────────┤
│ Eqp │ Equipment malfunction │
├─────────┼────────────────────────────────────────────────────────┤
│ Fld │ Flood damage │
├─────────┼────────────────────────────────────────────────────────┤
│ Dis │ Data-collection discontinued │
├─────────┼────────────────────────────────────────────────────────┤
│ Dry │ Dry │
├─────────┼────────────────────────────────────────────────────────┤
│ -- │ Parameter not determined │
├─────────┼────────────────────────────────────────────────────────┤
│ Mnt │ Maintenance in progress │
├─────────┼────────────────────────────────────────────────────────┤
│ ZFl │ Zero flow │
├─────────┼────────────────────────────────────────────────────────┤
│ *** │ Temporarily unavailable │
╘═════════╧════════════════════════════════════════════════════════╛
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--stateCd STATECD
[optional, default is None, major site filter]
U.S. postal service (2-digit) state code. Can have only 1 state code. List
is available at <[4;36mhttp://www.usps.com/ncsc/lookups/usps_abbre-
viations.html[0m>:
--stateCd=NY
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--countyCd COUNTYCD
[optional, default is None, major site filter]
A list of county numbers, in a 5 digit numeric format. The first two
digits of a county's code are the FIPS State Code. Can have from 1
to 20 county codes. The first 2 digits are the FIPS State Code
(<[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>) and the list of
county codes are at <[4;36mhttp://help.waterdata.usgs.gov/code/cou-
nty_query?fmt=html[0m>:
--countyCd=51059,51061
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--drainAreaMin DRAINAREAMIN
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
These arguments allows you to select principally surface water sites where
the associated sites' drainage areas (watersheds) are within a
desired size, expressed in square miles or decimal fractions
thereof. Providing a value to drainAreaMin (minimum drainage area)
means you want sites that have or exceed the drainAreaMin value. The
values may be expressed in decimals. If both the drainAreaMin and
drainAreaMax are specified, sites at or between the minimum and
maximum drainage areas values specified are returned Caution: not
all sites are associated with a drainage area. Caution: drainage
area generally only applies to surface water sites. Use with other
site types, such as groundwater sites, will likely retrieve no
results.
--drainAreaMax DRAINAREAMAX
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
Providing a value to drainAreaMax (maximum drainage area) means you want
sites that have or are less than the drainAreaMax value.:
--drainAreaMin=1000 --drainAreaMax=5000
# Return sites where the drainage area
# is 1000 square miles or greater and
# is 5000 square miles or less.
--drainAreaMin=10.5 --drainAreaMax=10.7
# Return sites where the drainage area
# is 10.5 square miles or greater and
# is 10.7 square miles or less.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--include_codes
[optional, default is False]
Whether or not to include the metadata/quality code column. Useful to
almost halve the size of the pandas DataFrame.
nwis_measurements#
$ tsgettoolbox nwis_measurements --help
usage: tsgettoolbox nwis_measurements [-h] [--sites SITES] [--stateCd STATECD]
[--huc HUC] [--bBox BBOX] [--countyCd COUNTYCD] [--parameterCd PARAMETERCD]
[--period PERIOD] [--startDT STARTDT] [--endDT ENDDT] [--siteType SITETYPE]
[--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD] [--siteStatus
SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX] [--aquiferCd AQUIFERCD]
[--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX]
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mResults[0m
┌───────────────────────────┬─────────────────────────────────────────┐
│ Column │ Description │
╞═══════════════════════════╪═════════════════════════════════════════╡
│ agency_cd │ Agency code │
├───────────────────────────┼─────────────────────────────────────────┤
│ site_no │ Site number │
├───────────────────────────┼─────────────────────────────────────────┤
│ measurement_nu │ Measurement number │
├───────────────────────────┼─────────────────────────────────────────┤
│ measurement_dt │ date of measurement (format = MMDDYYYY │
│ │ or Month/Day/Year. The user has options │
│ │ for the data output format) │
├───────────────────────────┼─────────────────────────────────────────┤
│ tz_cd │ Time zone offset. An ANSI SQL/92 time │
│ │ zone offset string. Some examples are │
│ │ '-07:00' (Eastern), '+02:00' (Eastern │
│ │ Europe), and '+03:30' (India). │
├───────────────────────────┼─────────────────────────────────────────┤
│ q_meas_used_fg │ Flag indicates if the discharge │
│ │ measurement is marked used. │
├───────────────────────────┼─────────────────────────────────────────┤
│ party_nm │ an indication of who made the │
│ │ measurement and is usually populated │
│ │ with a pair of initials separated with │
├───────────────────────────┼─a slash─────────────────────────────────┤
│ site_visit_coll_agency_cd │ What agency made the measurement at the │
│ │ site visit │
├───────────────────────────┼─────────────────────────────────────────┤
│ gage_height_va │ gage height as shown on the inside │
│ │ staff gage at the site or read off the │
│ │ recorder inside the gage house in feet │
├───────────────────────────┼─────────────────────────────────────────┤
│ discharge_va │ the computed discharge in cubic feet │
│ │ per second (cfs) │
├───────────────────────────┼─────────────────────────────────────────┤
│ measured_rating_diff │ measurement rating codes that denote │
│ │ the relative quality of the measurement │
├───────────────────────────┼─────────────────────────────────────────┤
│ gage_va_change │ The amount the gage height changed │
│ │ while the measurement was being made in │
├───────────────────────────┼─feet────────────────────────────────────┤
│ gage_va_time │ The amount of time elapsed while the │
│ │ measurement was being made in decimal │
│ │ hours │
├───────────────────────────┼─────────────────────────────────────────┤
│ control_type_cd │ condition of the rating control at the │
│ │ time of the measurement │
├───────────────────────────┼─────────────────────────────────────────┤
│ discharge_cd │ The adjustment code for the measured │
│ │ discharge │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_nu │ The channel number │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_name │ The channel name │
├───────────────────────────┼─────────────────────────────────────────┤
│ meas_type │ The channel measurement type │
├───────────────────────────┼─────────────────────────────────────────┤
│ streamflow_method │ The channel discharge measurement │
├───────────────────────────┼─method──────────────────────────────────┤
│ velocity_method │ The channel velocity measurement method │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_discharge │ The channel discharge in cubic feet per │
│ │ second │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_width │ The channel width in feet │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_area │ The channel area in square feet │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_velocity │ The mean velocity in feet per second │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_stability │ The stability of the channel material │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_material │ The channel material │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_evenness │ The channel evenness from bank to bank │
├───────────────────────────┼─────────────────────────────────────────┤
│ long_vel_desc │ The longitudinal velocity description │
├───────────────────────────┼─────────────────────────────────────────┤
│ horz_vel_desc │ The horizontal velocity description │
├───────────────────────────┼─────────────────────────────────────────┤
│ vert_vel_desc │ The vertical velocity description │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_loc_cd │ The channel location code │
├───────────────────────────┼─────────────────────────────────────────┤
│ chan_loc_dist │ The channel location distance │
╘═══════════════════════════╧═════════════════════════════════════════╛
<[4;36mhttps://help.waterdata.usgs.gov/output-formats#streamflow_measurement_data[0m>
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--stateCd STATECD
[optional, default is None, major site filter]
U.S. postal service (2-digit) state code. Can have only 1 state code. List
is available at <[4;36mhttp://www.usps.com/ncsc/lookups/usps_abbre-
viations.html[0m>:
--stateCd=NY
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--countyCd COUNTYCD
[optional, default is None, major site filter]
A list of county numbers, in a 5 digit numeric format. The first two
digits of a county's code are the FIPS State Code. Can have from 1
to 20 county codes. The first 2 digits are the FIPS State Code
(<[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>) and the list of
county codes are at <[4;36mhttp://help.waterdata.usgs.gov/code/cou-
nty_query?fmt=html[0m>:
--countyCd=51059,51061
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
nwis_peak#
$ tsgettoolbox nwis_peak --help
usage: tsgettoolbox nwis_peak [-h] [--sites SITES] [--stateCd STATECD]
[--huc HUC] [--bBox BBOX] [--countyCd COUNTYCD] [--parameterCd PARAMETERCD]
[--period PERIOD] [--startDT STARTDT] [--endDT ENDDT] [--siteType SITETYPE]
[--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD] [--siteStatus
SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX] [--aquiferCd AQUIFERCD]
[--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX]
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mResults[0m
┌───────────────┬────────────────────────────────────────────┐
│ Column │ Description │
╞═══════════════╪════════════════════════════════════════════╡
│ agency_cd │ Agency Code │
├───────────────┼────────────────────────────────────────────┤
│ site_no │ USGS station number │
├───────────────┼────────────────────────────────────────────┤
│ peak_dt │ Date of peak streamflow │
├───────────────┼─ (format YYYY-MM-DD)──────────────────────┤
│ peak_tm │ Time of peak streamflow │
├───────────────┼─ (24 hour format, 00:00 - 23:59)──────────┤
│ peak_va │ Annual peak streamflow value in cfs │
├───────────────┼────────────────────────────────────────────┤
│ peak_cd │ Peak Discharge-Qualification codes │
├───────────────┼─ (see explanation below)──────────────────┤
│ gage_ht │ Gage height for the associated peak │
├───────────────┼─ streamflow in feet───────────────────────┤
│ gage_ht_cd │ Gage height qualification codes │
├───────────────┼────────────────────────────────────────────┤
│ year_last_pk │ Peak streamflow reported is the highest │
├───────────────┼─ since this year──────────────────────────┤
│ ag_dt │ Date of maximum gage-height for water year │
├───────────────┼─ (if not concurrent with peak)────────────┤
│ ag_tm │ Time of maximum gage-height for water year │
├───────────────┼─ (if not concurrent with peak)────────────┤
│ ag_gage_ht │ maximum Gage height for water year in feet │
├───────────────┼─ (if not concurrent with peak)────────────┤
│ ag_gage_ht_cd │ maximum Gage height code │
╘═══════════════╧════════════════════════════════════════════╛
Peak Streamflow-Qualification Codes(peak_cd):
+---------+------------------------------------------------------+ | peak_cd |
Description | +=========+======================================================+
| 1 | Discharge is a Maximum Daily Average |
+---------+------------------------------------------------------+ | 2 |
Discharge is an Estimate | +---------+------------------------------------------
-------------+ | 3 | Discharge affected by Dam Failure |
+---------+------------------------------------------------------+ | 4 |
Discharge less than indicated value, | | | which is Minimum Recordable Discharge
at this site | +---------+------------------------------------------------------
-+ | 5 | Discharge affected to unknown degree by | | | Regulation or Diversion |
+---------+------------------------------------------------------+ | 6 |
Discharge affected by Regulation or Diversion |
+---------+------------------------------------------------------+ | 7 |
Discharge is an Historic Peak | +---------+-------------------------------------
------------------+ | 8 | Discharge actually greater than indicated value |
+---------+------------------------------------------------------+ | 9 |
Discharge due to Snowmelt, Hurricane, | | | Ice-Jam or Debris Dam breakup |
+---------+------------------------------------------------------+ | A | Year of
occurrence is unknown or not exact | +---------+--------------------------------
-----------------------+ | B | Month or Day of occurrence is unknown or not
exact | +---------+------------------------------------------------------+ | C |
All or part of the record affected by Urbanization, | | | Mining, Agricultural
changes, Channelization, | | | or other |
+---------+------------------------------------------------------+ | D | Base
Discharge changed during this year | +---------+--------------------------------
-----------------------+ | E | Only Annual Maximum Peak available for this year
| +---------+------------------------------------------------------+
Gage height qualification codes(gage_ht_cd,ag_gage_ht_cd):
+---------------+------------------------------------------------+ | gage_ht_cd
| Description | | ag_gage_ht_cd | | +===============+==========================-
======================+ | 1 | Gage height affected by backwater |
+---------------+------------------------------------------------+ | 2 | Gage
height not the maximum for the year | +---------------+-------------------------
------------------------+ | 3 | Gage height at different site and(or) datum |
+---------------+------------------------------------------------+ | 4 | Gage
height below minimum recordable elevation |
+---------------+------------------------------------------------+ | 5 | Gage
height is an estimate | +---------------+---------------------------------------
----------+ | 6 | Gage datum changed during this year |
+---------------+------------------------------------------------+
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--stateCd STATECD
[optional, default is None, major site filter]
U.S. postal service (2-digit) state code. Can have only 1 state code. List
is available at <[4;36mhttp://www.usps.com/ncsc/lookups/usps_abbre-
viations.html[0m>:
--stateCd=NY
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--countyCd COUNTYCD
[optional, default is None, major site filter]
A list of county numbers, in a 5 digit numeric format. The first two
digits of a county's code are the FIPS State Code. Can have from 1
to 20 county codes. The first 2 digits are the FIPS State Code
(<[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>) and the list of
county codes are at <[4;36mhttp://help.waterdata.usgs.gov/code/cou-
nty_query?fmt=html[0m>:
--countyCd=51059,51061
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
nwis_site#
$ tsgettoolbox nwis_site --help
usage: tsgettoolbox nwis_site [-h] [--sites SITES] [--stateCd STATECD]
[--huc HUC] [--bBox BBOX] [--countyCd COUNTYCD] [--parameterCd PARAMETERCD]
[--period PERIOD] [--startDT STARTDT] [--endDT ENDDT] [--siteType SITETYPE]
[--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD] [--siteStatus
SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX] [--drainAreaMin
DRAINAREAMIN] [--drainAreaMax DRAINAREAMAX] [--aquiferCd AQUIFERCD]
[--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX] [--siteOutput SITEOUTPUT] [--seriesCatalogOutput
SERIESCATALOGOUTPUT] [--outputDataTypeCd OUTPUTDATATYPECD] [--siteName
SITENAME] [--siteNameMatchOperator SITENAMEMATCHOPERATOR] [--hasDataTypeCd
HASDATATYPECD]
This does not return a time-series, but a table of sites.
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mResults[0m
┌─────────────────────┬──────────────────────────────────┐
│ Column │ Description │
╞═════════════════════╪══════════════════════════════════╡
│ agency_cd │ Agency │
├─────────────────────┼──────────────────────────────────┤
│ site_no │ Site identification number │
├─────────────────────┼──────────────────────────────────┤
│ station_nm │ Site name │
├─────────────────────┼──────────────────────────────────┤
│ site_tp_cd │ Site type │
├─────────────────────┼──────────────────────────────────┤
│ dec_lat_va │ Decimal latitude │
├─────────────────────┼──────────────────────────────────┤
│ dec_long_va │ Decimal longitude │
├─────────────────────┼──────────────────────────────────┤
│ coord_acy_cd │ Latitude-longitude accuracy │
├─────────────────────┼──────────────────────────────────┤
│ dec_coord_datum_cd │ Decimal Latitude-longitude datum │
├─────────────────────┼──────────────────────────────────┤
│ alt_va │ Altitude of Gage/land surface │
├─────────────────────┼──────────────────────────────────┤
│ alt_acy_va │ Altitude accuracy │
├─────────────────────┼──────────────────────────────────┤
│ alt_datum_cd │ Altitude datum │
├─────────────────────┼──────────────────────────────────┤
│ huc_cd │ Hydrologic unit code │
╘═════════════════════╧══════════════════════════════════╛
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--stateCd STATECD
[optional, default is None, major site filter]
U.S. postal service (2-digit) state code. Can have only 1 state code. List
is available at <[4;36mhttp://www.usps.com/ncsc/lookups/usps_abbre-
viations.html[0m>:
--stateCd=NY
--huc HUC
[optional, default is None, major site filter]
A list of hydrologic unit codes (HUC) or watersheds. Only 1 major HUC can
be specified per request. A major HUC has two digits. Minor HUCs
must be eight digits in length. Can have 1 to 10 HUC codes. List of
HUCs is available at <[4;36mhttp://water.usgs.gov/GIS/huc_name.html[0m>:
--huc=01,02070010
--bBox BBOX
[optional, default is None, major site filter]
A contiguous range of decimal latitude and longitude, starting with the
west longitude, then the south latitude, then the east longitude,
and then the north latitude with each value separated by a comma.
The product of the range of latitude and longitude cannot exceed 25
degrees. Whole or decimal degrees must be specified, up to six
digits of precision. Minutes and seconds are not allowed. Remember:
western longitude (which includes almost all of the United States)
is specified in negative degrees. Caution: many sites outside the
continental US do not have latitude and longitude referenced to
NAD83 and therefore can not be found using these arguments. Certain
sites are not associated with latitude and longitude due to homeland
security concerns and cannot be found using this filter.:
--bBox=-83,36.5,-81,38.5
--countyCd COUNTYCD
[optional, default is None, major site filter]
A list of county numbers, in a 5 digit numeric format. The first two
digits of a county's code are the FIPS State Code. Can have from 1
to 20 county codes. The first 2 digits are the FIPS State Code
(<[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>) and the list of
county codes are at <[4;36mhttp://help.waterdata.usgs.gov/code/cou-
nty_query?fmt=html[0m>:
--countyCd=51059,51061
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--drainAreaMin DRAINAREAMIN
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
These arguments allows you to select principally surface water sites where
the associated sites' drainage areas (watersheds) are within a
desired size, expressed in square miles or decimal fractions
thereof. Providing a value to drainAreaMin (minimum drainage area)
means you want sites that have or exceed the drainAreaMin value. The
values may be expressed in decimals. If both the drainAreaMin and
drainAreaMax are specified, sites at or between the minimum and
maximum drainage areas values specified are returned Caution: not
all sites are associated with a drainage area. Caution: drainage
area generally only applies to surface water sites. Use with other
site types, such as groundwater sites, will likely retrieve no
results.
--drainAreaMax DRAINAREAMAX
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
Providing a value to drainAreaMax (maximum drainage area) means you want
sites that have or are less than the drainAreaMax value.:
--drainAreaMin=1000 --drainAreaMax=5000
# Return sites where the drainage area
# is 1000 square miles or greater and
# is 5000 square miles or less.
--drainAreaMin=10.5 --drainAreaMax=10.7
# Return sites where the drainage area
# is 10.5 square miles or greater and
# is 10.7 square miles or less.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
--siteOutput SITEOUTPUT
[optional, default is None]
If you would like to see expanded site information, check this box. This
argument is ignored for visually oriented output formats like
Mapper, Google Earth and Google Maps. The default is basic. Use
expanded to get expanded site information. Example:
&siteOutput=expanded. Note: for performance reasons,
&siteOutput=expanded cannot be used if seriesCatalogOutput=true or
with any values for outputDataTypeCd.
--seriesCatalogOutput SERIESCATALOGOUTPUT
[optional, default is None]
This argument is ignored for visually oriented output formats like Mapper,
Google Earth and Google Maps. If you would like to see all the
period of record information for the sites selected, check this box.
You will see detailed information, such as a continuous range of
dates served by a site for one or more data types, for example, the
begin and end dates that streamflow (parameter 00060) was recorded
at a site. Note: if you select any data types for output (see below)
the period of record data will also appear. In that case specifying
this argument is unnecessary. The default is false. The only legal
values for this argument are true and false. Example:
&seriesCatalogOutput=true. &seriesCatalogOutput=true is equivalent
to &outputDataTypeCd=all. Note: for performance reasons,
&siteOutput=expanded cannot be used if seriesCatalogOutput=true.
--outputDataTypeCd OUTPUTDATATYPECD
[optional, default is None]
This will add period of record information to certain output formats (GML,
RDB and JSON) that summarize information about the data types
requested. The default is all data types. Some output formats are
designed for visual use (Google Earth, Google Maps and Mapper).
Consequently with these formats you will not see data type code
information.
Default information: If seriesCatalogOutput is true, all period of record
information is shown by default. If seriesCatalogOutput is false,
unless you override it using one of the values below, no period of
record information is shown.
Note: for performance reasons, &siteOutput=expanded cannot be used if with
any values for outputDataTypeCd.
Here are the various output data type codes available. These can be
selected individually or can be added as comma separated values if
desired. Example: &outputDataTypeCd=iv,dv
┌─────┬───────────────────────────────────────────────────────────────┐
│ all │ default (see above for qualifications). This is equivalent to │
│ │ &seriesCatalogOutput=true. │
├─────┼───────────────────────────────────────────────────────────────┤
│ iv │ Instantaneous values (time-series measurements typically │
│ │ recorded by automated equipment at frequent intervals (e.g., │
│ │ hourly) │
├─────┼───────────────────────────────────────────────────────────────┤
│ uv │ Unit values (alias for iv) │
├─────┼───────────────────────────────────────────────────────────────┤
│ rt │ Real-time data (alias for iv) │
├─────┼───────────────────────────────────────────────────────────────┤
│ dv │ Daily values (once daily measurements or summarized │
│ │ information for a particular day, such as daily maximum, │
├─────┼─minimum and mean)─────────────────────────────────────────────┤
│ pk │ Peaks measurements of water levels and streamflow for surface │
│ │ water sites (such as during floods, may be either an │
│ │ automated or a manual measurement) │
├─────┼───────────────────────────────────────────────────────────────┤
│ sv │ Site visits (irregular manual surface water measurements, │
│ │ excluding peak measurements) │
├─────┼───────────────────────────────────────────────────────────────┤
│ gw │ Groundwater levels measured at irregular, discrete intervals. │
│ │ For recorded, time series groundwater levels, use iv or id. │
├─────┼───────────────────────────────────────────────────────────────┤
│ qw │ Water-quality data from discrete sampling events and analyzed │
│ │ in the field or in a laboratory. For recorded time series │
│ │ water-quality data, use iv or id. │
├─────┼───────────────────────────────────────────────────────────────┤
│ id │ Historical instantaneous values (sites in the USGS │
│ │ Instantaneous Data Archive External Link) │
├─────┼───────────────────────────────────────────────────────────────┤
│ aw │ Sites monitored by the USGS Active Groundwater Level Network │
│ │ External Link │
├─────┼───────────────────────────────────────────────────────────────┤
│ ad │ Sites included in USGS Annual Water Data Reports External │
╘═════╧═Link}═════════════════════════════════════════════════════════╛
--siteName SITENAME
[optional, default is None, minor site filter]
This filter allows you to find a site by its name, using either the exact
site name or a partial site name. Note that a major filter is still
required. String matches are case insensitive, so if you specify
"Boulder" you will retrieve site names with "Boulder", "boulder",
"BOULDER" as well as many other variants. To embed a space, you can
use single quotes. Examaple: --siteName='Boulder Creek'
--siteNameMatchOperator SITENAMEMATCHOPERATOR
[optional, default is None, minor site filter]
If used, this must be used with siteName. It determines how the pattern
matching for the site name behaves. Matches are case insensitive.
The options are:
start = The string must be at the start of the site name (default)
any = The string must be contained somewhere in the site name
exact = The site name must exactly match the string supplied, with
the exception that the match is not case sensitive
Example: &siteNameMatchOperator=any
--hasDataTypeCd HASDATATYPECD
[optional, default is None, minor site filter]
Default is all. Restricts results to those sites that collect certain
kinds of data. Separate values with commas. Allowed values are:
┌─────┬───────────────────────────────────────────────────────────────┐
│ all │ default (see above for qualifications). This is equivalent to │
│ │ &seriesCatalogOutput=true. │
├─────┼───────────────────────────────────────────────────────────────┤
│ iv │ Instantaneous values (time-series measurements typically │
│ │ recorded by automated equipment at frequent intervals (e.g., │
│ │ hourly) │
├─────┼───────────────────────────────────────────────────────────────┤
│ uv │ Unit values (alias for iv) │
├─────┼───────────────────────────────────────────────────────────────┤
│ rt │ Real-time data (alias for iv) │
├─────┼───────────────────────────────────────────────────────────────┤
│ dv │ Daily values (once daily measurements or summarized │
│ │ information for a particular day, such as daily maximum, │
├─────┼─minimum and mean)─────────────────────────────────────────────┤
│ pk │ Peaks measurements of water levels and streamflow for surface │
│ │ water sites (such as during floods, may be either an │
│ │ automated or a manual measurement) │
├─────┼───────────────────────────────────────────────────────────────┤
│ sv │ Site visits (irregular manual surface water measurements, │
│ │ excluding peak measurements) │
├─────┼───────────────────────────────────────────────────────────────┤
│ gw │ Groundwater levels measured at irregular, discrete intervals. │
│ │ For recorded, time series groundwater levels, use iv or id. │
├─────┼───────────────────────────────────────────────────────────────┤
│ qw │ Water-quality data from discrete sampling events and analyzed │
│ │ in the field or in a laboratory. For recorded time series │
│ │ water-quality data, use iv or id. │
├─────┼───────────────────────────────────────────────────────────────┤
│ id │ Historical instantaneous values (sites in the USGS │
│ │ Instantaneous Data Archive External Link) │
├─────┼───────────────────────────────────────────────────────────────┤
│ aw │ Sites monitored by the USGS Active Groundwater Level Network │
│ │ External Link │
├─────┼───────────────────────────────────────────────────────────────┤
│ ad │ Sites included in USGS Annual Water Data Reports External │
╘═════╧═Link══════════════════════════════════════════════════════════╛
nwis_stat#
$ tsgettoolbox nwis_stat --help
usage: tsgettoolbox nwis_stat [-h] [--sites SITES] [--parameterCd PARAMETERCD]
[--period PERIOD] [--startDT STARTDT] [--endDT ENDDT] [--siteType SITETYPE]
[--modifiedSince MODIFIEDSINCE] [--agencyCd AGENCYCD] [--siteStatus
SITESTATUS] [--altMin ALTMIN] [--altMax ALTMAX] [--drainAreaMin
DRAINAREAMIN] [--drainAreaMax DRAINAREAMAX] [--aquiferCd AQUIFERCD]
[--localAquiferCd LOCALAQUIFERCD] [--wellDepthMin WELLDEPTHMIN]
[--wellDepthMax WELLDEPTHMAX] [--holeDepthMin HOLEDEPTHMIN] [--holeDepthMax
HOLEDEPTHMAX] [--statReportType STATREPORTTYPE] [--statType STATTYPE]
[--missingData MISSINGDATA] [--statYearType STATYEARTYPE]
Detailed documentation is available at <[4;36mhttp://waterdata.usgs.gov/nwis[0m>.
Site local time is output, even if multiple sites are requested and sites are
in different time zones. Note that the measurement time zone at a site may
not be the same as the time zone actually in effect at the site.
Every query requires a major filter. Pick the major filter ('--sites',
'--stateCd', '--huc', '--bBox', '--countyCd') that best retrieves the data
for the sites that you are interested in. You can have only one major filter
per query. If you specify more than one major filter, you will get an error.
[1mMajor Filter[0m
Select ONE of:
'--sites',
'--stateCd',
'--huc',
'--bBox', or
'--countyCd'
[1mMinor Filters[0m
Additional filters can be applied after specifying a major filter. This
further reduces the set of expected results. Users are encouraged to use
minor filters because it allows more efficient use of this service.
Use as many as desired to limit number of retrieved time series:
'--agencyCd',
'--altMax',
'--altMin',
'--aquiferCd',
'--drainAreaMax',
'--drainAreaMin',
'--holeDepthMax'
'--holeDepthMin',
'--localAquiferCd',
'--modifiedSince',
'--parameterCd',
'--siteStatus',
'--siteType',
'--wellDepthMax',
'--wellDepthMin',
[1mReturns[0m
This returns a pandas DataFrame if using the Python API, or a text table to
standard out if using the command line interface. Both will have columns named
according to the following table.
┌──────────────┬────────────────┬─────────────────────────────────────────┐
│ Column Name │ statReportType │ Description │
╞══════════════╪════════════════╪═════════════════════════════════════════╡
│ agency_cd │ all │ Agency code │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ site_no │ all │ Site identification number │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ parameter_cd │ all │ Parameter code │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ station_nm │ all │ Site name │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ loc_web_ds │ all │ Additional measurement description │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ year_nu │ monthly annual │ The year for which the statistics │
├──────────────┼────────────────┼─apply.──────────────────────────────────┤
│ month_nu │ monthly daily │ The month for which the statistics │
├──────────────┼────────────────┼─apply.──────────────────────────────────┤
│ day_nu │ daily │ The day for which the statistics apply. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ begin_yr │ daily │ First water year of data of daily mean │
│ │ │ values for this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ end_yr │ daily │ Last water year of data of daily mean │
│ │ │ values for this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ count_nu │ all │ Number of values used in the │
├──────────────┼────────────────┼─calculation.────────────────────────────┤
│ max_va_yr │ daily │ Water year in which the maximum value │
│ │ │ occurred. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ max_va │ daily │ Maximum of daily mean values for this │
│ │ │ day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ min_va_yr │ daily │ Water year in which the minimum value │
│ │ │ occurred. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ min_va │ daily │ Minimum of daily mean values for this │
│ │ │ day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ mean_va │ all │ Mean of daily mean values for this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p05_va │ daily │ 05 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p10_va │ daily │ 10 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p20_va │ daily │ 20 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p25_va │ daily │ 25 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p50_va │ daily │ 50 percentile (median) of daily mean │
│ │ │ values for this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p75_va │ daily │ 75 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p80_va │ daily │ 80 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p90_va │ daily │ 90 percentile of daily mean values for │
│ │ │ this day. │
├──────────────┼────────────────┼─────────────────────────────────────────┤
│ p95_va │ daily │ 95 percentile of daily mean values for │
│ │ │ this day. │
╘══════════════╧════════════════╧═════════════════════════════════════════╛
options:
-h | --help
show this help message and exit
--sites SITES
[optional, default is None, major site filter]
Want to only query one site? Use sites as your major filter, and put only
one site number in the list. Sites are comma separated. Sites may be
prefixed with an optional agency code followed by a colon. If you do
not know the site numbers you need, you can find relevant sites with
the NWIS Mapper (<[4;36mhttp://wdr.water.usgs.gov/nwisgmap/index.html[0m>) or
on the USGS Water Data for the Nation site.
(<[4;36mhttp://waterdata.usgs.gov/nwis/[0m>)
Can have from 1 to 100 comma separated site numbers:
--sites=USGS:01646500
--sites=01646500,06306300
--parameterCd PARAMETERCD
[optional, default is None, minor site filter]
USGS time-series parameter code. All parameter codes are numeric and 5
characters in length. Parameter codes are used to identify the
constituent measured and the units of measure. Popular codes include
stage (00065), discharge in cubic feet per second (00060) and water
temperature in degrees Celsius (00010). Can request from 1 to 100
"parameterCD"s. Default: returns all regular time-series for the
requested sites.
Complete list:
http://help.waterdata.usgs.gov/codes-and-parameters/parameters::
--parameterCd=00060 # discharge, cubic feet
# per second
--parameterCd=00060,00065 # discharge,
# cubic feet per second
# and gage height in
# feet
--period PERIOD
[optional, default is None]
Get a range of values from now by specifying the period argument period
must be in ISO-8601 Duration format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>) Negative periods
(ex: P-T2H) are not allowed. Data are always returned up to the most
recent value, which in the case of a predictive gage might be in the
future. When specifying days from now, the first value will probably
not be at midnight of the first day, but somewhat before exactly 24
hours from now.:
--period=PT2H
# Retrieve last two hours from now up to most recent
# instantaneous value)
--period=P7D
# Retrieve last seven days up from now to most recent
# instantaneous value)
--startDT STARTDT
[optional, default is None]
Get a range of values from an explicit begin or end date/time. Use the
startDT and endDT arguments. Site local time is output, even if
multiple sites are requested and sites are in different time zones.
Note that the measurement time zone at a site may not be the same as
the time zone actually in effect at the site.
Both startDt and endDt must be in ISO-8601 Date/Time format.
(<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Dates[0m>) You can express the
date and time in a timezone other than site local time if you want
as long as it follows the ISO standard. For example, you can express
the time in Universal time: 2014-03-20T00:00Z. If startDT is
supplied and endDT is not, endDT ends with the most recent
instantaneous value. startDT must be chronologically before endDT.
If startDt shows the date and not the time of day (ex: 2010-09-01) the
time of midnight site time is assumed (2010-09-01T00:00) If endDt
shows the date and not the time of day (ex: 2010-09-02) the last
minute before midnight site time is assumed (2010-09-02T23:59).
Remember, only data from October 1, 2007 are currently available in
the 'iv' database.
--endDT ENDDT
[optional, default is None]
If endDT is present, startDt must also be present.:
--startDT=2010-11-22 --endDT=2010-11-22 # Full day, 00:00 to 23:59
--startDT=2010-11-22T12:00 --endDT=2010-11-22T18:00
--startDT=2010-11-22 --endDT=2010-11-22
--startDT=2010-11-22T12:00 # From "startDT" to most recent
# instantaneous value
--siteType SITETYPE
[optional, default is None, minor site filter]
Restricts sites to those having one or more major and/or minor site types.
If you request a major site type (ex: &siteType=ST) you will get all
sub-site types of the same major type as well (in this case, ST-CA,
ST-DCH and ST-TS). Can have from 1 to an unlimited number of
siteType codes. Default is to return all types. List of valid site
types: <[4;36mhttp://help.waterdata.usgs.gov/site_tp_cd[0m>:
--siteType=ST # Streams only
--siteType=ST,LA-OU # Streams and Land Outcrops only
--modifiedSince MODIFIEDSINCE
[optional, default is None, minor site filter]
Returns all values for sites and period of record requested only if any
values have changed over the last modifiedSince period.
modifiedSince is useful if you periodically need to poll a site but
are only interested in getting data if some of it has changed. It is
typically be used with period, or startDT/endDT but does not have to
be. In the latter case, if any values were changed during the
specified modifiedSince period, only the most recent values would be
retrieved for those sites. This is a typical usage, since users
typically are polling a site and only want data if there are new or
changed measurements. ISO-8601 duration format is always used. There
is no default. (<[4;36mhttp://en.wikipedia.org/wiki/ISO_8601#Durations[0m>):
--modifiedSince=PT2H
# Retrieves all values for sites and period of record
# requested for any of the requested sites and
# parameters, but only for sites where any of the
# values changed during the last two hours.
--modifiedSince=PT2H --period=P1D
# Retrieve all values for sites and period of record
# requested for the last 24 hours from now only for
# sites and parameters that had any values that
# changed or were added during the last two hours.
--modifiedSince=PT2H --startDt=2010-11-01 --endDt=2010-11-02
# Retrieve all values for sites and period of record
# requested for sites and parameters that had values
# change between midnight site local time on Nov 1st,
# 2010 and 23:59 on Nov 2nd, 2010 site local time,
# only if values were changed or added within the
# last two hours.
--agencyCd AGENCYCD
[optional, default is None, minor site filter]
The list of sites returned are filtered to return only those with the
provided agency code. The agency code describes the organization
that maintains the site. Only one agency code is allowed and is
optional. An authoritative list of agency codes can be found here.
Default is to return all sites regardless of agency code. List:
<[4;36mhttp://help.waterdata.usgs.gov/code/agency_cd_query?fmt=html[0m>:
--stateCd=il --agencyCd=USCE # Only US Army Corps
# of Engineers sites
# in Illinois
--siteStatus SITESTATUS
[optional, default is None, minor site filter]
Selects sites based on whether or not they are active. If a site is
active, it implies that it is being actively maintained. A site is
considered active if: it has collected time-series (automated) data
within the last 183 days (6 months), or it has collected discrete
(manually collected) data within 397 days (13 months) If it does not
meet these criteria, it is considered inactive. Some exceptions
apply. If a site is flagged by a USGS water science center as
discontinued, it will show as inactive. A USGS science center can
also flag a new site as active even if it has not collected any
data. The default is all (show both active and inactive sites).
Chose between, 'all', 'active', or 'inactive'. Default all - sites
of any activity status are returned.:
--siteStatus='active'
--altMin ALTMIN
[optional, default is None, minor site filter]
These arguments allows you to select instantaneous values sites where the
associated sites' altitude are within a desired altitude, expressed
in feet. Altitude is based on the datum used at the site. Providing
a value to altMin (minimum altitude) means you want sites that have
or exceed the altMin value. You may specify decimal feet if
precision is critical If both the altMin and altMax are specified,
sites at or between the minimum and maximum altitude are returned.
--altMax ALTMAX
[optional, default is None, minor site filter]
Providing a value to altMax (maximum altitude) means you want sites that
have or are less than the altMax value.:
--altMin=1000 --altMax=5000
# Return sites where the altitude is 1000 feet or
# greater and 5000 feet or less.
--altMin=12.5 --altMax=13
# Return sites where the altitude is 12.5 feet or
# greater and 13 feet or less.
--drainAreaMin DRAINAREAMIN
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
These arguments allows you to select principally surface water sites where
the associated sites' drainage areas (watersheds) are within a
desired size, expressed in square miles or decimal fractions
thereof. Providing a value to drainAreaMin (minimum drainage area)
means you want sites that have or exceed the drainAreaMin value. The
values may be expressed in decimals. If both the drainAreaMin and
drainAreaMax are specified, sites at or between the minimum and
maximum drainage areas values specified are returned Caution: not
all sites are associated with a drainage area. Caution: drainage
area generally only applies to surface water sites. Use with other
site types, such as groundwater sites, will likely retrieve no
results.
--drainAreaMax DRAINAREAMAX
[optional, default is None, minor site filter]
SURFACE WATER SITE ATTRIBUTE
Providing a value to drainAreaMax (maximum drainage area) means you want
sites that have or are less than the drainAreaMax value.:
--drainAreaMin=1000 --drainAreaMax=5000
# Return sites where the drainage area
# is 1000 square miles or greater and
# is 5000 square miles or less.
--drainAreaMin=10.5 --drainAreaMax=10.7
# Return sites where the drainage area
# is 10.5 square miles or greater and
# is 10.7 square miles or less.
--aquiferCd AQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers.
Enter one or more national aquifer codes, separated by commas. A
national aquifer code is exactly 10 characters. You can have up to
1000 aquiferCd codes. Complete list:
<[4;36mhttp://water.usgs.gov/ogw/NatlAqCode-reflist.html[0m>:
--aquiferCd=S500EDRTRN,N100HGHPLN
# returns groundwater sites for the
# Edwards-Trinity aquifer system and
# the High Plains national
# aquifers.
--localAquiferCd LOCALAQUIFERCD
[optional, default is None, minor site filter]
Used to filter sites to those that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter
one or more local aquifer codes, separated by commas. A local
aquifer code begins with a 2 character state abbreviation (such as
TX for Texas) followed by a colon followed by the 7 character
aquifer code. Can have 0 to 1000 comma delimited codes. Complete
list: <[4;36mhttp://help.waterdata.usgs.gov/code/aqfr_cd_query?fmt=html[0m>
To translate state codes associated with the local aquifer you may
need this reference: <[4;36mhttp://www.itl.nist.gov/fipspubs/fip5-2.htm[0m>
--localAquiferCd=AL:111RGLT,AL:111RSDM
# returns sites for the Regolith and Saprolite local
# aquifers in Alabama
--wellDepthMin WELLDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' well depth are
within a desired depth, expressed in feet from the land surface
datum. Express well depth as a positive number. Providing a value to
wellDepthMin (minimum well depth) means you want sites that have or
exceed the wellDepthMin value. The values may be expressed in
decimals Caution: well depth applies to groundwater sites only.:
--wellDepthMin=100 --wellDepthMax=500
# Return daily value sites where the well depth is
# 100 feet or greater and 500 feet or less.
--wellDepthMax WELLDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to wellDepthMax (maximum well depth) means you want
sites that have or are less than the wellDepthMax value.:
--wellDepthMin=10.5 --wellDepthMax=10.7
# Return daily value sites where the well depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the wellDepthMin and wellDepthMax are specified, sites at or
between the minimum and maximum well depth values specified are
returned wellDepthMax should be greater than or equal to
wellDepthMin.
--holeDepthMin HOLEDEPTHMIN
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
These arguments allows you to select groundwater sites serving data
recorded automatically where the associated sites' hole depth are
within a desired depth, expressed in feet from the land surface
datum. Express hole depth as a positive number. Providing a value to
holeDepthMin (minimum hole depth) means you want sites that have or
exceed the holeDepthMin value. The values may be expressed in
decimals Caution: hole depth applies to groundwater sites only.
--holeDepthMax HOLEDEPTHMAX
[optional, default is None, minor site filter]
GROUNDWATER SITE ATTRIBUTE
Providing a value to holeDepthMax (maximum hole depth) means you want
sites that have or are less than the holeDepthMax value.:
--holeDepthMin=100 --holeDepthMax=500
# Return daily values sites where the hole depth is
# 100 feet or greater and 500 feet or less.
--holeDepthMin=10.5 --holeDepthMax=10.7
# Return daily value sites where the hole depth is
# 10.5 feet or greater and 10.7 feet or less.
If both the holeDepthMin and holeDepthMax are specified, sites at or
between the minimum and maximum hole depth values specified are
returned holeDepthMax should be greater than or equal to
holeDepthMin.
--statReportType STATREPORTTYPE
[optional, default is 'daily']
The type of statistics desired. Valid statistic report types include:
┌────────────────┬──────────────────────────────────────────┐
│ statReportType │ Description │
├────────────────┼──────────────────────────────────────────┤
│ daily │ daily statistics (default) statistic │
│ │ across years │
├────────────────┼──────────────────────────────────────────┤
│ monthly │ monthly statistics (monthly time-series) │
├────────────────┼──────────────────────────────────────────┤
│ annual │ annual statistics, based on either │
│ │ calendar year or water year, as defined │
│ │ by statYearType. If statYearType is not │
│ │ provided, calendar year statistics are │
│ │ assumed. (annual time-series) │
╘════════════════╧══════════════════════════════════════════╛
--statType STATTYPE
[optional, default is None, minor site filter]
Selects sites based on the statistics type(s) desired, such as minimum,
maximum or mean
For all statReportType types include:
mean - arithmetic mean or average
all - selects all available statistics
For daily statistics you can also specify:
min - minimum, or smallest value found for the
daily statistics
max - maximum, or largest value found for the
daily statistics
median - the numerical value separating the higher
half of a the data from the lower half,
same as specifying P50. If used median
will be represented by the column name
p50_va.
P05, P10, P20, P25, P50, P75, P80, P90, P95
with the number indicating percentile. Note:
the service can calculate only these
percentiles.
--missingData MISSINGDATA
[optional, default is None]
Used to indicate the rules to follow to generate statistics if there are
gaps in the period of record during the requested statistics period.
By default if there are any missing data for the report type, the
statistic is left blank or null.
This option does not apply to daily statistics, but optionally can be used
with monthly and yearly statistics. If used with daily statistics,
an error will occur.
Missing data can happen for various reasons including there was a
technical problem with the gage for part of the time period.
Enabling this switch will attempt to provide a statistic if there is
enough data to create one.
Choice is 'off' or 'on'.
--statYearType STATYEARTYPE
[optional, default is None]
Indicates which kind of year statistics should be created against. This
only applies when requesting annual statistics, i.e.
statReportType=annual. Valid year types codes include:
┌──────────┬──────────────────────────────────────────────────────────┐
│ calendar │ calendar year, i.e. January 1 through December 31 │
├──────────┼──────────────────────────────────────────────────────────┤
│ water │ water year, i.e. a year begins October 1 of the previous │
│ │ year and ends September 30 of the current year. This is │
│ │ the same as a federal fiscal year. │
╘══════════╧══════════════════════════════════════════════════════════╛
rivergages#
$ tsgettoolbox rivergages --help
usage: tsgettoolbox rivergages [-h] [--start_date START_DATE]
[--end_date END_DATE] station_code parameter
Stage and flow from systems managed by the U.S. Army Corps of Engineers.
positional arguments:
station_code The station code for the
station.
parameter Parameter
code.
options:
-h | --help
show this help message and exit
--start_date START_DATE
The start date of the desired time-series.
--end_date END_DATE
The end data of the desired time-series.
terraclimate19912020#
$ tsgettoolbox terraclimate19912020 --help
usage: tsgettoolbox terraclimate19912020 [-h] [--variables VARIABLES]
[--start_date START_DATE] [--end_date END_DATE] lat lon
method: These layers from TerraClimate were derived from the essential climate
variables of TerraClimate. Water balance variables, actual evapotranspiration,
climatic water deficit, runoff, soil moisture, and snow water equivalent were
calculated using a water balance model and plant extractable soil water capacity
derived from Wang-Erlandsson et al (2016).
title: TerraClimate: monthly climate and climatic water balance for global land
surfaces
summary: This archive contains a dataset of high-spatial resolution (1/24deg,
~4-km) monthly climate and climatic water balance for global terrestrial
surfaces from 1958-2015. These data were created by using climatically aided
interpolation, combining high-spatial resolution climatological normals from the
WorldClim version 1.4 and version 2 datasets, with coarser resolution time
varying (i.e. monthly) data from CRU Ts4.0 and JRA-55 to produce a monthly
dataset of precipitation, maximum and minimum temperature, wind speed, vapor
pressure, and solar radiation. TerraClimate additionally produces monthly
surface water balance datasets using a water balance model that incorporates
reference evapotranspiration, precipitation, temperature, and interpolated plant
extractable soil water capacity.
method: These layers from TerraClimate were creating using climatically aided
interpolation of monthly anomalies from the CRU Ts4.0 and Japanese 55-year
Reanalysis (JRA-55) datasets with WorldClim v2.0 climatologies.
keywords: WORLDCLIM,global,monthly, temperature,precipitation,wind,radiation,va-
por pressure,evapotranspiration,water balance,soil water capacity,snow water
equivalent,runoff
history: Created by John Abatzoglou, University of California Merced
creator_url: climate.nkn.uidaho.edu/TerraClimate
creator_email: jabatzoglou at ucmerced.edu
institution: University of California Merced
project: Global Dataset of Monthly Climate and Climatic Water Balance
(1958-2015)
acknowledgment: Please cite the references included herein. We also acknowledge
the WorldClim datasets (Fick and Hijmans, 2017; Hijmans et al., 2005) and the
CRU Ts4.0 (Harris et al., 2014) and JRA-55 (Kobayashi et al., 2015) datasets.
geospatial_lat_min: -89.979164
geospatial_lat_max: 89.979164
geospatial_lon_min: -179.97917
geospatial_lon_max: 179.97917
time_coverage_start: 1958-01-01T00:0
time_coverage_end: present
time_coverage_resolution: P1M
standard_nam_vocabulary: CF-1.0
license: No restrictions
geospatial_lat_units: decimal degrees north
geospatial_lat_resolution: -0.041666668
geospatial_lon_units: decimal degrees east
geospatial_lon_resolution: 0.041666668
references: Abatzoglou, J.T., S.Z. Dobrowski, S.A. Parks, and K.C. Hegewisch,
2017, High-resolution global dataset of monthly climate and climatic water
balance from 1958-2015, submitted to Scientific Data.
source: WorldClim v2.0 (2.5m), CRU Ts4.0, JRA-55
version: v1.0
Conventions: CF-1.6
positional arguments:
lat The latitude of the point. North hemisphere is positive from 0 to
90. South hemisphere is negative from 0 to -90.
lon The longitude of the point. Western hemisphere (west of Greenwich
Prime Meridian) is negative 0 to -180. The eastern hemisphere (east of the
Greenwich Prime Meridian) is positive 0 to 180.
options:
-h | --help
show this help message and exit
--variables VARIABLES
At the command line can supply a comma separated list of variable names.
Using the Python API needs to be a Python list of strings.
The current list of available variables are in the following table.
┌────────┬───────────────────────────────────────┬───────────┐
│ Short │ Long │ Units │
╞════════╪═══════════════════════════════════════╪═══════════╡
│ aet │ Actual ET │ mm │
├────────┼───────────────────────────────────────┼───────────┤
│ def │ Climate water deficit │ mm │
├────────┼───────────────────────────────────────┼───────────┤
│ pet │ Reference ET (mis-labeled by │ mm │
│ │ terraclimate as PET, but actually RET │ │
│ │ calculated by Penman-Monteith) │ │
├────────┼───────────────────────────────────────┼───────────┤
│ q │ Runoff │ mm │
├────────┼───────────────────────────────────────┼───────────┤
│ soil │ Soil moisture │ mm │
├────────┼───────────────────────────────────────┼───────────┤
│ swe │ Snow water equivalence │ mm │
├────────┼───────────────────────────────────────┼───────────┤
│ tmax │ maximum temperature │ degC │
├────────┼───────────────────────────────────────┼───────────┤
│ tmin │ minimum temperature │ degC │
├────────┼───────────────────────────────────────┼───────────┤
│ vap │ Vapor pressure │ kPa │
├────────┼───────────────────────────────────────┼───────────┤
│ vpd │ Vapor pressure deficit │ kPa │
├────────┼───────────────────────────────────────┼───────────┤
│ ws │ wind_speed │ m/s │
╘════════╧═══════════════════════════════════════╧═══════════╛
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
terraclimate19812010#
$ tsgettoolbox terraclimate19812010 --help
usage: tsgettoolbox terraclimate19812010 [-h] [--variables VARIABLES]
[--start_date START_DATE] [--end_date END_DATE] lat lon
method: These layers from TerraClimate were derived from the essential climate
variables of TerraClimate. Water balance variables, actual evapotranspiration,
climatic water deficit, runoff, soil moisture, and snow water equivalent were
calculated using a water balance model and plant extractable soil water capacity
derived from Wang-Erlandsson et al (2016).
title: TerraClimate: monthly climate and climatic water balance for global land
surfaces
summary: This archive contains a dataset of high-spatial resolution (1/24deg,
~4-km) monthly climate and climatic water balance for global terrestrial
surfaces from 1958-2015. These data were created by using climatically aided
interpolation, combining high-spatial resolution climatological normals from the
WorldClim version 1.4 and version 2 datasets, with coarser resolution time
varying (i.e. monthly) data from CRU Ts4.0 and JRA-55 to produce a monthly
dataset of precipitation, maximum and minimum temperature, wind speed, vapor
pressure, and solar radiation. TerraClimate additionally produces monthly
surface water balance datasets using a water balance model that incorporates
reference evapotranspiration, precipitation, temperature, and interpolated plant
extractable soil water capacity.
method: These layers from TerraClimate were creating using climatically aided
interpolation of monthly anomalies from the CRU Ts4.0 and Japanese 55-year
Reanalysis (JRA-55) datasets with WorldClim v2.0 climatologies.
keywords: WORLDCLIM,global,monthly, temperature,precipitation,wind,radiation,va-
por pressure,evapotranspiration,water balance,soil water capacity,snow water
equivalent,runoff
history: Created by John Abatzoglou, University of California Merced
creator_url: climate.nkn.uidaho.edu/TerraClimate
creator_email: jabatzoglou at ucmerced.edu
institution: University of California Merced
project: Global Dataset of Monthly Climate and Climatic Water Balance
(1958-2015)
acknowledgment: Please cite the references included herein. We also acknowledge
the WorldClim datasets (Fick and Hijmans, 2017; Hijmans et al., 2005) and the
CRU Ts4.0 (Harris et al., 2014) and JRA-55 (Kobayashi et al., 2015) datasets.
geospatial_lat_min: -89.979164
geospatial_lat_max: 89.979164
geospatial_lon_min: -179.97917
geospatial_lon_max: 179.97917
time_coverage_start: 1958-01-01T00:0
time_coverage_end: present
time_coverage_resolution: P1M
standard_nam_vocabulary: CF-1.0
license: No restrictions
geospatial_lat_units: decimal degrees north
geospatial_lat_resolution: -0.041666668
geospatial_lon_units: decimal degrees east
geospatial_lon_resolution: 0.041666668
references: Abatzoglou, J.T., S.Z. Dobrowski, S.A. Parks, and K.C. Hegewisch,
2017, High-resolution global dataset of monthly climate and climatic water
balance from 1958-2015, submitted to Scientific Data.
source: WorldClim v2.0 (2.5m), CRU Ts4.0, JRA-55
version: v1.0
Conventions: CF-1.6
positional arguments:
lat The latitude of the point. North hemisphere is positive from 0 to
90. South hemisphere is negative from 0 to -90.
lon The longitude of the point. Western hemisphere (west of Greenwich
Prime Meridian) is negative 0 to -180. The eastern hemisphere (east of the
Greenwich Prime Meridian) is positive 0 to 180.
options:
-h | --help
show this help message and exit
--variables VARIABLES
At the command line can supply a comma separated list of variable names.
Using the Python API needs to be a Python list of strings.
The current list of available variables are in the following table.
┌────────┬────────────────────────────────────────┬───────────┐
│ Short │ Long │ Units │
╞════════╪════════════════════════════════════════╪═══════════╡
│ aet │ Actual ET │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ def │ Climate water deficit │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ pet │ Reference ET (mis-labeled by │ mm │
│ │ terraclimate as PET, but actually RET │ │
│ │ calculated by Penman-Monteith) │ │
├────────┼────────────────────────────────────────┼───────────┤
│ q │ Runoff │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ soil │ Soil moisture │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ swe │ Snow water equivalence │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ tmax │ maximum temperature │ degC │
├────────┼────────────────────────────────────────┼───────────┤
│ tmin │ minimum temperature │ degC │
├────────┼────────────────────────────────────────┼───────────┤
│ vap │ Vapor pressure │ kPa │
├────────┼────────────────────────────────────────┼───────────┤
│ vpd │ Vapor pressure deficit │ kPa │
├────────┼────────────────────────────────────────┼───────────┤
│ ws │ wind_speed │ m/s │
╘════════╧════════════════════════════════════════╧═══════════╛
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
terraclimate#
$ tsgettoolbox terraclimate --help
usage: tsgettoolbox terraclimate [-h] [--variables VARIABLES]
[--start_date START_DATE] [--end_date END_DATE] lat lon
method: These layers from TerraClimate were derived from the essential climate
variables of TerraClimate. Water balance variables, actual evapotranspiration,
climatic water deficit, runoff, soil moisture, and snow water equivalent were
calculated using a water balance model and plant extractable soil water capacity
derived from Wang-Erlandsson et al (2016).
title: TerraClimate: monthly climate and climatic water balance for global land
surfaces
summary: This archive contains a dataset of high-spatial resolution (1/24deg,
~4-km) monthly climate and climatic water balance for global terrestrial
surfaces from 1958-2015. These data were created by using climatically aided
interpolation, combining high-spatial resolution climatological normals from the
WorldClim version 1.4 and version 2 datasets, with coarser resolution time
varying (i.e. monthly) data from CRU Ts4.0 and JRA-55 to produce a monthly
dataset of precipitation, maximum and minimum temperature, wind speed, vapor
pressure, and solar radiation. TerraClimate additionally produces monthly
surface water balance datasets using a water balance model that incorporates
reference evapotranspiration, precipitation, temperature, and interpolated plant
extractable soil water capacity.
keywords: WORLDCLIM,global,monthly, temperature,precipitation,wind,radiation,va-
por pressure,evapotranspiration,water balance,soil water capacity,snow water
equivalent,runoff
naming_authority: edu.uidaho.nkn
history: Created by John Abatzoglou, University of California Merced
creator_url: climate.nkn.uidaho.edu/TerraClimate
creator_email: jabatzoglou at ucmerced.edu
institution: University of California Merced
project: Global Dataset of Monthly Climate and Climatic Water Balance
(1958-2015)
acknowledgment: Please cite the references included herein. We also acknowledge
the WorldClim datasets (Fick and Hijmans, 2017; Hijmans et al., 2005) and the
CRU Ts4.0 (Harris et al., 2014) and JRA-55 (Kobayashi et al., 2015) datasets.
geospatial_lat_min: -89.979164
geospatial_lat_max: 89.979164
geospatial_lon_min: -179.97917
geospatial_lon_max: 179.97917
time_coverage_start: 1958-01-01T00:0
time_coverage_end: present
time_coverage_resolution: P1M
standard_nam_vocabulary: CF-1.0
license: No restrictions
geospatial_lat_units: decimal degrees north
geospatial_lat_resolution: -0.041666668
geospatial_lon_units: decimal degrees east
geospatial_lon_resolution: 0.041666668
references: Abatzoglou, J.T., S.Z. Dobrowski, S.A. Parks, and K.C. Hegewisch,
2017, High-resolution global dataset of monthly climate and climatic water
balance from 1958-2015, submitted to Scientific Data.
source: WorldClim v2.0 (2.5m), CRU Ts4.0, JRA-55
version: v1.0
Conventions: CF-1.6
positional arguments:
lat The latitude of the point. North hemisphere is positive from 0 to
90. South hemisphere is negative from 0 to -90.
lon The longitude of the point. Western hemisphere (west of Greenwich
Prime Meridian) is negative 0 to -180. The eastern hemisphere (east of the
Greenwich Prime Meridian) is positive 0 to 180.
options:
-h | --help
show this help message and exit
--variables VARIABLES
At the command line can supply a comma separated list of variable names.
Using the Python API needs to be a Python list of strings.
The current list of available variables are in the following table.
┌────────┬────────────────────────────────────────┬───────────┐
│ Short │ Long │ Units │
╞════════╪════════════════════════════════════════╪═══════════╡
│ aet │ Actual ET │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ def │ Climate water deficit │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ PDSI │ Palmer Drought Severity Index │ │
├────────┼────────────────────────────────────────┼───────────┤
│ pet │ Reference ET (mis-labeled by │ mm │
│ │ terraclimate as PET, but actually RET │ │
│ │ calculated by Penman-Monteith) │ │
├────────┼────────────────────────────────────────┼───────────┤
│ q │ Runoff │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ soil │ Soil moisture │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ srad │ Downwelling solar shortwave │ W/m^2 │
├────────┼────────────────────────────────────────┼───────────┤
│ swe │ Snow water equivalence │ mm │
├────────┼────────────────────────────────────────┼───────────┤
│ tmax │ maximum temperature │ degC │
├────────┼────────────────────────────────────────┼───────────┤
│ tmin │ minimum temperature │ degC │
├────────┼────────────────────────────────────────┼───────────┤
│ vap │ Vapor pressure │ kPa │
├────────┼────────────────────────────────────────┼───────────┤
│ vpd │ Vapor pressure deficit │ kPa │
├────────┼────────────────────────────────────────┼───────────┤
│ ws │ wind_speed │ m/s │
╘════════╧════════════════════════════════════════╧═══════════╛
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
twc#
$ tsgettoolbox twc --help
usage: tsgettoolbox twc [-h] [--start_date START_DATE] [--end_date END_DATE]
county
This module provides direct access to [4;36mTexas Weather Connection[0m [0] [4;36mDaily
Keetch-Byram Drought Index (KBDI)[0m [1] dataset.
positional arguments:
county If specified, results will be limited to the county corresponding to
the given 5-character Texas county fips code i.e. 48.
options:
-h | --help
show this help message and exit
--start_date START_DATE
[optional, defaults to first date in time-series, input filter]
The start_date of the series in ISOdatetime format, or 'None' for
beginning.
--end_date END_DATE
[optional, defaults to last date in time-series, input filter]
The end_date of the series in ISOdatetime format, or 'None' for end.
[1mReferences:[0m
[0]: <[4;36mhttp://twc.tamu.edu/[0m>
[1]: <[4;36mhttp://twc.tamu.edu/drought/kbdi[0m>
wdfn_agency_codes#
$ tsgettoolbox wdfn_agency_codes --help
usage: tsgettoolbox wdfn_agency_codes [-h] [--geometry GEOMETRY] [--id ID]
[--agency_name AGENCY_NAME]
Code identifying the agency or organization used for site information, data
sources, and permitting agencies. Agency codes are fixed values assigned by
the National Water Information System (NWIS).
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Agency code identification number.
--agency_name AGENCY_NAME
Agency name.
wdfn_altitude_datums#
$ tsgettoolbox wdfn_altitude_datums --help
usage: tsgettoolbox wdfn_altitude_datums [-h] [--geometry GEOMETRY] [--id ID]
[--altitude_datum_description ALTITUDE_DATUM_DESCRIPTION]
The recommended vertical datum is NAVD88 (North American Vertical Datum of
1988) where applicable as stated in Office of Information Technical Memo
2002.01. NGVD29 (National Geodetic Vertical Datum of 1929) and NAVD88 are the
only datums that can be converted on output. NWIS uses the North American
Vertical Datum Conversions (VERTCON) of the National Geodetic Survey to
convert from NGVD29 to NAVD88 or vice versa. Conversions to or from other
vertical datums are not available.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID id
--altitude_datum_description ALTITUDE_DATUM_DESCRIPTION
altitude_datum_description
wdfn_aquifer_codes#
$ tsgettoolbox wdfn_aquifer_codes --help
usage: tsgettoolbox wdfn_aquifer_codes [-h] [--geometry GEOMETRY] [--id ID]
[--aquifer_name AQUIFER_NAME]
Local aquifers in USGS data are identified by an aquifer name and
geohydrologic unit code (a three-digit number related to the age of the
formation, followed by a 4 or 5 character abbreviation for the geologic unit
or aquifer name). For the age of formation (aquifer age), generally the
smaller the number represents the younger the geohydrologic unit. Aquifer
names and the definition of an aquifer can be very subjective. One rock unit
may be called different aquifer names by different people. Local aquifers and
layered aquifers are often grouped into larger named regional aquifers or
aquifer systems. For example, the National Northern Atlantic Coastal Plain
aquifer system (National aquifer) consists of five layered regional aquifers.
Each regional aquifer is divided into two or more aquifers which may have a
different name in each of the states in which the aquifer is found.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Aquifer code. The eight-character string identifying
an aquifer. Codes are defined by the \"Catalog of
Aquifer Names and Geologic Unit Codes used by the
Water Resources Division.\"
--aquifer_name AQUIFER_NAME
Aquifer name. Aquifer names are defined by the
\"Catalog of Aquifer Names and Geologic Unit Codes
used by the Water Resources Division.\"
wdfn_aquifer_types#
$ tsgettoolbox wdfn_aquifer_types --help
usage: tsgettoolbox wdfn_aquifer_types [-h] [--geometry GEOMETRY] [--id ID]
[--aquifer_type_description AQUIFER_TYPE_DESCRIPTION]
Groundwater occurs in aquifers under two different conditions. Where water
only partly fills an aquifer, the upper surface is free to rise and decline.
These aquifers are referred to as unconfined (or water-table) aquifers. Where
water completely fills an aquifer that is overlain by a confining bed, the
aquifer is referred to as a confined (or artesian) aquifer. When a confined
aquifer is penetrated by a well, the water level in the well will rise above
the top of the aquifer (but not necessarily above land surface).
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID The single-character code identifying the type of
aquifer
--aquifer_type_description AQUIFER_TYPE_DESCRIPTION
Longer description of the aquifer type.
wdfn_channel_measurements#
$ tsgettoolbox wdfn_channel_measurements --help
usage: tsgettoolbox wdfn_channel_measurements [-h] [--geometry GEOMETRY]
[--id ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--field_visit_id FIELD_VISIT_ID]
[--measurement_number MEASUREMENT_NUMBER]
[--time TIME]
[--channel_name CHANNEL_NAME]
[--channel_flow CHANNEL_FLOW]
[--channel_flow_unit CHANNEL_FLOW_UNIT]
[--channel_width CHANNEL_WIDTH]
[--channel_width_unit CHANNEL_WIDTH_UNIT]
[--channel_area CHANNEL_AREA]
[--channel_area_unit CHANNEL_AREA_UNIT]
[--channel_velocity CHANNEL_VELOCITY]
[--channel_velocity_unit CHANNEL_VELOCITY_UNIT]
[--channel_location_distance CHANNEL_LOCATION_DISTANCE]
[--channel_location_distance_unit CHANNEL_LOCATION_DISTANCE_UNIT]
[--channel_stability CHANNEL_STABILITY]
[--channel_material CHANNEL_MATERIAL]
[--channel_evenness CHANNEL_EVENNESS]
[--horizontal_velocity_description HORIZONTAL_VELOCITY_DESCRIPTION]
[--vertical_velocity_description VERTICAL_VELOCITY_DESCRIPTION]
[--longitudinal_velocity_description LONGITUDINAL_VELOCITY_DESCRIPTION]
[--measurement_type MEASUREMENT_TYPE]
[--last_modified LAST_MODIFIED]
[--channel_measurement_type CHANNEL_MEASUREMENT_TYPE]
[--channel_location_direction CHANNEL_LOCATION_DIRECTION]
[--ts_return_style TS_RETURN_STYLE]
Channel measurements taken as part of streamflow field measurements.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. To uniquely
identify a single observation over time, compare the
`time` and `time_series_id` fields; each time series
will only have a single observation at a given `time`.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--field_visit_id FIELD_VISIT_ID
A universally unique identifier (UUID) for the field
visit. Multiple measurements may be made during a
single field visit.
--measurement_number MEASUREMENT_NUMBER
Measurement number.
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--channel_name CHANNEL_NAME
The channel name.
--channel_flow CHANNEL_FLOW
Channel discharge.
--channel_flow_unit CHANNEL_FLOW_UNIT
The units for channel discharge.
--channel_width CHANNEL_WIDTH
The channel width.
--channel_width_unit CHANNEL_WIDTH_UNIT
The units for channel width.
--channel_area CHANNEL_AREA
The channel area.
--channel_area_unit CHANNEL_AREA_UNIT
The units for channel area.
--channel_velocity CHANNEL_VELOCITY
The mean channel velocity.
--channel_velocity_unit CHANNEL_VELOCITY_UNIT
The units for channel velocity.
--channel_location_distance CHANNEL_LOCATION_DISTANCE
The channel location distance.
--channel_location_distance_unit CHANNEL_LOCATION_DISTANCE_UNIT
The units for channel location distance.
--channel_stability CHANNEL_STABILITY
The stability of the channel material.
--channel_material CHANNEL_MATERIAL
The channel material.
--channel_evenness CHANNEL_EVENNESS
The channel evenness from bank to bank.
--horizontal_velocity_description HORIZONTAL_VELOCITY_DESCRIPTION
The horizontal velocity description.
--vertical_velocity_description VERTICAL_VELOCITY_DESCRIPTION
The vertical velocity description.
--longitudinal_velocity_description LONGITUDINAL_VELOCITY_DESCRIPTION
The longitudinal velocity description.
--measurement_type MEASUREMENT_TYPE
The measurement type.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--channel_measurement_type CHANNEL_MEASUREMENT_TYPE
The channel measurement type.
--channel_location_direction CHANNEL_LOCATION_DIRECTION
Location of the measurement from the gage.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_citations#
$ tsgettoolbox wdfn_citations --help
usage: tsgettoolbox wdfn_citations [-h] [--geometry GEOMETRY] [--id ID]
[--citation_description CITATION_DESCRIPTION]
Citations associated with water measurement methods.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Method citation name. An abbreviated citation that
describes the reference.
--citation_description CITATION_DESCRIPTION
Method citation description.
wdfn_combined_metadata#
$ tsgettoolbox wdfn_combined_metadata --help
usage: tsgettoolbox wdfn_combined_metadata [-h] [--geometry GEOMETRY]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--id ID]
[--unit_of_measure UNIT_OF_MEASURE]
[--parameter_name PARAMETER_NAME]
[--parameter_code PARAMETER_CODE]
[--statistic_id STATISTIC_ID]
[--last_modified LAST_MODIFIED]
[--begin BEGIN] [--end END]
[--data_type DATA_TYPE]
[--computation_identifier COMPUTATION_IDENTIFIER]
[--thresholds THRESHOLDS]
[--sublocation_identifier SUBLOCATION_IDENTIFIER]
[--primary PRIMARY]
[--web_description WEB_DESCRIPTION]
[--parameter_description PARAMETER_DESCRIPTION]
[--parent_time_series_id PARENT_TIME_SERIES_ID]
[--data_gap_interval DATA_GAP_INTERVAL]
[--reading_type READING_TYPE]
This endpoint combines metadata from timeseries and field measurements
collections by site.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--id ID The ID of the time series or field measurement series
(identified by `data_type`) that collection metadata
corresponds to.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--parameter_name PARAMETER_NAME
A human-understandable name corresponding to
`parameter_code`.
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--statistic_id STATISTIC_ID
A code corresponding to the statistic an observation
represents. Example codes include 00001 (max), 00002
(min), and 00003 (mean). A complete list of codes and
their descriptions can be found at [https://api.waterd
ata.usgs.gov/ogcapi/v1/collections/statistic-codes/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/statistic-codes/items).
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--begin BEGIN The datetime of the earliest observation in the time
series. Together with `end_utc`, this field represents
the period of record of a time series. Note that some
time series may have large gaps in their collection
record. You can query this field using date-times or
intervals, adhering to RFC 3339, or using ISO 8601
duration objects. Intervals may be bounded or half-
bounded (double-dots at start or end). Examples: - A
date-time: "2018-02-12T23:20:50Z" - A bounded
interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `begin_utc` that
intersects the value of datetime are selected.
--end END The datetime of the most recent observation in the
time series. Data returned by this endpoint updates at
most once per day, and potentially less frequently
than that, and as such there may be more recent
observations within a time series than the time series
`end_utc` value reflects. Together with `begin_utc`,
this field represents the period of record of a time
series. It is additionally used to determine whether a
time series is "active". You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `end_utc` that
intersects the value of datetime are selected.
--data_type DATA_TYPE
The computational period type of data collected at the
monitoring location.
--computation_identifier COMPUTATION_IDENTIFIER
Indicates the computation performed to calculate this
time series. Values of "Instantaneous" reflect point
measurements.
--thresholds THRESHOLDS
Thresholds represent known numeric limits for a time
series, for example the historic maximum value for a
parameter or a level below which a sensor is non-
operative. These thresholds are sometimes used to
automatically determine if an observation is erroneous
due to sensor error, and therefore shouldn't be
included in the time series.
--sublocation_identifier SUBLOCATION_IDENTIFIER
An optional human-readable identifier used to specify
where measurements are recorded at a monitoring
location.
--primary PRIMARY A flag identifying if the time series is a "primary"
time series. "Primary" time series (which have this
flag) are standard observations which undergo [Bureau
review and approval
processes](https://www.usgs.gov/survey-
manual/5028-fundamental-science-practices-review-and-
approval-scientific-data-release). Non-primary time
series, which will have missing values for "primary",
are provisional datasets made available to meet the
need for timely best science and to assist with daily
operations which need real-time information. Non-
primary time series data are only retained by this
system for 120 days. See the [USGS Provisional Data
Statement](https://waterdata.usgs.gov/provisional-
data- statement/) for more information.
--web_description WEB_DESCRIPTION
An optional description of the time series. WDFN and
other USGS data dissemination products use this field,
in combination with sublocation_identifier, to
distinguish the differences between multiple time
series for the same parameter code, statistic code,
and monitoring location.
--parameter_description PARAMETER_DESCRIPTION
A description of what the parameter code represents,
as used by WDFN and other USGS data dissemination
products.
--parent_time_series_id PARENT_TIME_SERIES_ID
The unique identifier representing the parent or
"upchain" time series that a daily values time series
is generated from. Daily values time series have one
and only one parent time series.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
--reading_type READING_TYPE
Distinguishes field-measurement readings from
measurements. Readings have a value of
ReferencePrimary; measurements are Discharge or
MeanGageHeight.
wdfn_combined_method_citations#
$ tsgettoolbox wdfn_combined_method_citations --help
usage: tsgettoolbox [-h]
{cdec,coops,daymet,epa_wqp,fawn,hydstra_catalog,hydstra_stations,hydstra_ts,ldas,ldas_gldas_noah,ldas_gldas_noah_v2_0,ldas_gldas_noah_v2_1,ldas_grace,ldas_merra,ldas_nldas3_forcing,ldas_nldas_fora,ldas_nldas_noah,ldas_nldas_vic,ldas_smerge,metdata,modis,ncei_annual,ncei_ghcnd,ncei_ghcnd_ftp,ncei_ghcndms,ncei_gsod,ncei_gsom,ncei_gsoy,ncei_ish,ncei_normal_ann,ncei_normal_dly,ncei_normal_hly,ncei_normal_mly,ncei_precip_15,ncei_precip_hly,ndbc,nwis,nwis_dv,nwis_gwlevels,nwis_iv,nwis_measurements,nwis_peak,nwis_site,nwis_stat,rivergages,terraclimate19912020,terraclimate19812010,terraclimate,twc,unavco,wdfn_agency_codes,wdfn_altitude_datums,wdfn_aquifer_codes,wdfn_aquifer_types,wdfn_channel_measurements,wdfn_citations,wdfn_combined_metadata,wdfn_continuous,wdfn_coordinate_accuracy_codes,wdfn_coordinate_datum_codes,wdfn_coordinate_method_codes,wdfn_counties,wdfn_countries,wdfn_daily,wdfn_field_measurements,wdfn_field_measurements_metadata,wdfn_hydrologic_unit_codes,wdfn_latest_continuous,wdfn_latest_daily,wdfn_latest_field_measurements,wdfn_medium_codes,wdfn_method_categories,wdfn_method_citations,wdfn_methods,wdfn_monitoring_locations,wdfn_national_aquifer_codes,wdfn_parameter_codes,wdfn_peaks,wdfn_reliability_codes,wdfn_site_types,wdfn_states,wdfn_statistic_codes,wdfn_time_series_metadata,wdfn_time_series_methods,wdfn_time_series_revisions,wdfn_time_zone_codes,wdfn_read_normal_observations,wdfn_read_interval_observations,about} ...
tsgettoolbox: error: argument {cdec,coops,daymet,epa_wqp,fawn,hydstra_catalog,hydstra_stations,hydstra_ts,ldas,ldas_gldas_noah,ldas_gldas_noah_v2_0,ldas_gldas_noah_v2_1,ldas_grace,ldas_merra,ldas_nldas3_forcing,ldas_nldas_fora,ldas_nldas_noah,ldas_nldas_vic,ldas_smerge,metdata,modis,ncei_annual,ncei_ghcnd,ncei_ghcnd_ftp,ncei_ghcndms,ncei_gsod,ncei_gsom,ncei_gsoy,ncei_ish,ncei_normal_ann,ncei_normal_dly,ncei_normal_hly,ncei_normal_mly,ncei_precip_15,ncei_precip_hly,ndbc,nwis,nwis_dv,nwis_gwlevels,nwis_iv,nwis_measurements,nwis_peak,nwis_site,nwis_stat,rivergages,terraclimate19912020,terraclimate19812010,terraclimate,twc,unavco,wdfn_agency_codes,wdfn_altitude_datums,wdfn_aquifer_codes,wdfn_aquifer_types,wdfn_channel_measurements,wdfn_citations,wdfn_combined_metadata,wdfn_continuous,wdfn_coordinate_accuracy_codes,wdfn_coordinate_datum_codes,wdfn_coordinate_method_codes,wdfn_counties,wdfn_countries,wdfn_daily,wdfn_field_measurements,wdfn_field_measurements_metadata,wdfn_hydrologic_unit_codes,wdfn_latest_continuous,wdfn_latest_daily,wdfn_latest_field_measurements,wdfn_medium_codes,wdfn_method_categories,wdfn_method_citations,wdfn_methods,wdfn_monitoring_locations,wdfn_national_aquifer_codes,wdfn_parameter_codes,wdfn_peaks,wdfn_reliability_codes,wdfn_site_types,wdfn_states,wdfn_statistic_codes,wdfn_time_series_metadata,wdfn_time_series_methods,wdfn_time_series_revisions,wdfn_time_zone_codes,wdfn_read_normal_observations,wdfn_read_interval_observations,about}: invalid choice: 'wdfn_combined_method_citations' (choose from cdec, coops, daymet, epa_wqp, fawn, hydstra_catalog, hydstra_stations, hydstra_ts, ldas, ldas_gldas_noah, ldas_gldas_noah_v2_0, ldas_gldas_noah_v2_1, ldas_grace, ldas_merra, ldas_nldas3_forcing, ldas_nldas_fora, ldas_nldas_noah, ldas_nldas_vic, ldas_smerge, metdata, modis, ncei_annual, ncei_ghcnd, ncei_ghcnd_ftp, ncei_ghcndms, ncei_gsod, ncei_gsom, ncei_gsoy, ncei_ish, ncei_normal_ann, ncei_normal_dly, ncei_normal_hly, ncei_normal_mly, ncei_precip_15, ncei_precip_hly, ndbc, nwis, nwis_dv, nwis_gwlevels, nwis_iv, nwis_measurements, nwis_peak, nwis_site, nwis_stat, rivergages, terraclimate19912020, terraclimate19812010, terraclimate, twc, unavco, wdfn_agency_codes, wdfn_altitude_datums, wdfn_aquifer_codes, wdfn_aquifer_types, wdfn_channel_measurements, wdfn_citations, wdfn_combined_metadata, wdfn_continuous, wdfn_coordinate_accuracy_codes, wdfn_coordinate_datum_codes, wdfn_coordinate_method_codes, wdfn_counties, wdfn_countries, wdfn_daily, wdfn_field_measurements, wdfn_field_measurements_metadata, wdfn_hydrologic_unit_codes, wdfn_latest_continuous, wdfn_latest_daily, wdfn_latest_field_measurements, wdfn_medium_codes, wdfn_method_categories, wdfn_method_citations, wdfn_methods, wdfn_monitoring_locations, wdfn_national_aquifer_codes, wdfn_parameter_codes, wdfn_peaks, wdfn_reliability_codes, wdfn_site_types, wdfn_states, wdfn_statistic_codes, wdfn_time_series_metadata, wdfn_time_series_methods, wdfn_time_series_revisions, wdfn_time_zone_codes, wdfn_read_normal_observations, wdfn_read_interval_observations, about)
wdfn_continuous#
$ tsgettoolbox wdfn_continuous --help
usage: tsgettoolbox wdfn_continuous [-h] [--geometry GEOMETRY] [--id ID]
[--time_series_id TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE]
[--statistic_id STATISTIC_ID]
[--time TIME] [--value VALUE]
[--unit_of_measure UNIT_OF_MEASURE]
[--approval_status APPROVAL_STATUS]
[--qualifier QUALIFIER]
[--last_modified LAST_MODIFIED]
[--method_category METHOD_CATEGORY]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--data_gap_interval DATA_GAP_INTERVAL]
[--ts_return_style TS_RETURN_STYLE]
Continuous data are collected via automated sensors installed at a monitoring
location. They are collected at a high frequency and often at a fixed
15-minute interval. Depending on the specific monitoring location, the data
may be transmitted automatically via telemetry and be available on WDFN within
minutes of collection, while other times the delivery of data may be delayed
if the monitoring location does not have the capacity to automatically
transmit data. Continuous data are described by parameter name and parameter
code (pcode). These data might also be referred to as "instantaneous values"
or "IV".
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. To uniquely
identify a single observation over time, compare the
`time` and `time_series_id` fields; each time series
will only have a single observation at a given `time`.
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--statistic_id STATISTIC_ID
A code corresponding to the statistic an observation
represents. Example codes include 00001 (max), 00002
(min), and 00003 (mean). A complete list of codes and
their descriptions can be found at [https://api.waterd
ata.usgs.gov/ogcapi/v1/collections/statistic-codes/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/statistic-codes/items).
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--approval_status APPROVAL_STATUS
Some of the data that you have obtained from this U.S.
Geological Survey database may not have received
Director's approval. Any such data values are
qualified as provisional and are subject to revision.
Provisional data are released on the condition that
neither the USGS nor the United States Government may
be held liable for any damages resulting from its use.
This field reflects the approval status of each
record, and is either "Approved", meaining processing
review has been completed and the data is approved for
publication, or "Provisional" and subject to revision.
For more information about provisional data, go to
[https://waterdata.usgs.gov/provisional-data-
statement/](https://waterdata.usgs.gov/provisional-
data-statement/).
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--method_category METHOD_CATEGORY
The RLMS method category code classifying the method
in effect for this interval.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_coordinate_accuracy_codes#
$ tsgettoolbox wdfn_coordinate_accuracy_codes --help
usage: tsgettoolbox wdfn_coordinate_accuracy_codes [-h] [--geometry GEOMETRY]
[--id ID]
[--coordinate_accuracy_description COORDINATE_ACCURACY_DESCRIPTION]
Appropriate code on the schedule to indicate the accuracy of the latitude-
longitude values.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID id
--coordinate_accuracy_description COORDINATE_ACCURACY_DESCRIPTION
coordinate_accuracy_description
wdfn_coordinate_datum_codes#
$ tsgettoolbox wdfn_coordinate_datum_codes --help
usage: tsgettoolbox wdfn_coordinate_datum_codes [-h] [--geometry GEOMETRY]
[--id ID]
[--coordinate_datum_description COORDINATE_DATUM_DESCRIPTION]
Horizontal datum code for the latitude/longitude coordinates. There are
currently more than 300 horizontal datums available for entry.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID id
--coordinate_datum_description COORDINATE_DATUM_DESCRIPTION
coordinate_datum_description
wdfn_coordinate_method_codes#
$ tsgettoolbox wdfn_coordinate_method_codes --help
usage: tsgettoolbox wdfn_coordinate_method_codes [-h] [--geometry GEOMETRY]
[--id ID]
[--coordinate_method_description COORDINATE_METHOD_DESCRIPTION]
Methods used to determine latitude-longitude values.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID id
--coordinate_method_description COORDINATE_METHOD_DESCRIPTION
coordinate_method_description
wdfn_counties#
$ tsgettoolbox wdfn_counties --help
usage: tsgettoolbox wdfn_counties [-h] [--geometry GEOMETRY] [--id ID]
[--country_code COUNTRY_CODE]
[--state_fips_code STATE_FIPS_CODE]
[--county_fips_code COUNTY_FIPS_CODE]
[--county_name COUNTY_NAME]
The name of the county or county equivalent (parish, borough, planning
reagion, etc.) in which the site is located. List includes Census Bureau FIPS
county codes, names and associated Country and State.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID
--country_code COUNTRY_CODE
FIPS country code as defined by FIPS PUB 10-4:
Countries, Dependencies, Areas of Special Sovereignty,
and Their Principal Administrative Divisions.
--state_fips_code STATE_FIPS_CODE
State FIPS code.
--county_fips_code COUNTY_FIPS_CODE
County FIPS code. A two digit code indicating a U.S.
county as defined by FIPS 5-2.
--county_name COUNTY_NAME
County name. The name of a U.S. county as defined by
FIPS 5-2.
wdfn_countries#
$ tsgettoolbox wdfn_countries --help
usage: tsgettoolbox wdfn_countries [-h] [--geometry GEOMETRY] [--id ID]
[--country_name COUNTRY_NAME]
FIPS country codes and names.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID The purpose of ISO 3166 is to define internationally
recognized codes of letters and/or numbers that we can
use when we refer to countries and their subdivisions.
--country_name COUNTRY_NAME
Country name.
wdfn_daily#
$ tsgettoolbox wdfn_daily --help
usage: tsgettoolbox wdfn_daily [-h] [--geometry GEOMETRY] [--id ID]
[--time_series_id TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE]
[--statistic_id STATISTIC_ID] [--time TIME]
[--value VALUE]
[--unit_of_measure UNIT_OF_MEASURE]
[--approval_status APPROVAL_STATUS]
[--qualifier QUALIFIER]
[--last_modified LAST_MODIFIED]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE] [--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--data_gap_interval DATA_GAP_INTERVAL]
[--ts_return_style TS_RETURN_STYLE]
Daily data provide one data value to represent water conditions for the day.
Throughout much of the history of the USGS, the primary water data available
was daily data collected manually at the monitoring location once each day.
With improved availability of computer storage and automated transmission of
data, the daily data published today are generally a statistical summary or
metric of the continuous data collected each day, such as the daily mean,
minimum, or maximum value. Daily data are automatically calculated from the
continuous data of the same parameter code and are described by parameter code
and a statistic code. These data have also been referred to as “daily values”
or “DV”.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. To uniquely
identify a single observation over time, compare the
`time` and `time_series_id` fields; each time series
will only have a single observation at a given `time`.
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--statistic_id STATISTIC_ID
A code corresponding to the statistic an observation
represents. Example codes include 00001 (max), 00002
(min), and 00003 (mean). A complete list of codes and
their descriptions can be found at [https://api.waterd
ata.usgs.gov/ogcapi/v1/collections/statistic-codes/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/statistic-codes/items).
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--approval_status APPROVAL_STATUS
Some of the data that you have obtained from this U.S.
Geological Survey database may not have received
Director's approval. Any such data values are
qualified as provisional and are subject to revision.
Provisional data are released on the condition that
neither the USGS nor the United States Government may
be held liable for any damages resulting from its use.
This field reflects the approval status of each
record, and is either "Approved", meaining processing
review has been completed and the data is approved for
publication, or "Provisional" and subject to revision.
For more information about provisional data, go to
[https://waterdata.usgs.gov/provisional-data-
statement/](https://waterdata.usgs.gov/provisional-
data-statement/).
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_edr_daily#
$ tsgettoolbox wdfn_edr_daily --help
usage: tsgettoolbox [-h]
{cdec,coops,daymet,epa_wqp,fawn,hydstra_catalog,hydstra_stations,hydstra_ts,ldas,ldas_gldas_noah,ldas_gldas_noah_v2_0,ldas_gldas_noah_v2_1,ldas_grace,ldas_merra,ldas_nldas3_forcing,ldas_nldas_fora,ldas_nldas_noah,ldas_nldas_vic,ldas_smerge,metdata,modis,ncei_annual,ncei_ghcnd,ncei_ghcnd_ftp,ncei_ghcndms,ncei_gsod,ncei_gsom,ncei_gsoy,ncei_ish,ncei_normal_ann,ncei_normal_dly,ncei_normal_hly,ncei_normal_mly,ncei_precip_15,ncei_precip_hly,ndbc,nwis,nwis_dv,nwis_gwlevels,nwis_iv,nwis_measurements,nwis_peak,nwis_site,nwis_stat,rivergages,terraclimate19912020,terraclimate19812010,terraclimate,twc,unavco,wdfn_agency_codes,wdfn_altitude_datums,wdfn_aquifer_codes,wdfn_aquifer_types,wdfn_channel_measurements,wdfn_citations,wdfn_combined_metadata,wdfn_continuous,wdfn_coordinate_accuracy_codes,wdfn_coordinate_datum_codes,wdfn_coordinate_method_codes,wdfn_counties,wdfn_countries,wdfn_daily,wdfn_field_measurements,wdfn_field_measurements_metadata,wdfn_hydrologic_unit_codes,wdfn_latest_continuous,wdfn_latest_daily,wdfn_latest_field_measurements,wdfn_medium_codes,wdfn_method_categories,wdfn_method_citations,wdfn_methods,wdfn_monitoring_locations,wdfn_national_aquifer_codes,wdfn_parameter_codes,wdfn_peaks,wdfn_reliability_codes,wdfn_site_types,wdfn_states,wdfn_statistic_codes,wdfn_time_series_metadata,wdfn_time_series_methods,wdfn_time_series_revisions,wdfn_time_zone_codes,wdfn_read_normal_observations,wdfn_read_interval_observations,about} ...
tsgettoolbox: error: argument {cdec,coops,daymet,epa_wqp,fawn,hydstra_catalog,hydstra_stations,hydstra_ts,ldas,ldas_gldas_noah,ldas_gldas_noah_v2_0,ldas_gldas_noah_v2_1,ldas_grace,ldas_merra,ldas_nldas3_forcing,ldas_nldas_fora,ldas_nldas_noah,ldas_nldas_vic,ldas_smerge,metdata,modis,ncei_annual,ncei_ghcnd,ncei_ghcnd_ftp,ncei_ghcndms,ncei_gsod,ncei_gsom,ncei_gsoy,ncei_ish,ncei_normal_ann,ncei_normal_dly,ncei_normal_hly,ncei_normal_mly,ncei_precip_15,ncei_precip_hly,ndbc,nwis,nwis_dv,nwis_gwlevels,nwis_iv,nwis_measurements,nwis_peak,nwis_site,nwis_stat,rivergages,terraclimate19912020,terraclimate19812010,terraclimate,twc,unavco,wdfn_agency_codes,wdfn_altitude_datums,wdfn_aquifer_codes,wdfn_aquifer_types,wdfn_channel_measurements,wdfn_citations,wdfn_combined_metadata,wdfn_continuous,wdfn_coordinate_accuracy_codes,wdfn_coordinate_datum_codes,wdfn_coordinate_method_codes,wdfn_counties,wdfn_countries,wdfn_daily,wdfn_field_measurements,wdfn_field_measurements_metadata,wdfn_hydrologic_unit_codes,wdfn_latest_continuous,wdfn_latest_daily,wdfn_latest_field_measurements,wdfn_medium_codes,wdfn_method_categories,wdfn_method_citations,wdfn_methods,wdfn_monitoring_locations,wdfn_national_aquifer_codes,wdfn_parameter_codes,wdfn_peaks,wdfn_reliability_codes,wdfn_site_types,wdfn_states,wdfn_statistic_codes,wdfn_time_series_metadata,wdfn_time_series_methods,wdfn_time_series_revisions,wdfn_time_zone_codes,wdfn_read_normal_observations,wdfn_read_interval_observations,about}: invalid choice: 'wdfn_edr_daily' (choose from cdec, coops, daymet, epa_wqp, fawn, hydstra_catalog, hydstra_stations, hydstra_ts, ldas, ldas_gldas_noah, ldas_gldas_noah_v2_0, ldas_gldas_noah_v2_1, ldas_grace, ldas_merra, ldas_nldas3_forcing, ldas_nldas_fora, ldas_nldas_noah, ldas_nldas_vic, ldas_smerge, metdata, modis, ncei_annual, ncei_ghcnd, ncei_ghcnd_ftp, ncei_ghcndms, ncei_gsod, ncei_gsom, ncei_gsoy, ncei_ish, ncei_normal_ann, ncei_normal_dly, ncei_normal_hly, ncei_normal_mly, ncei_precip_15, ncei_precip_hly, ndbc, nwis, nwis_dv, nwis_gwlevels, nwis_iv, nwis_measurements, nwis_peak, nwis_site, nwis_stat, rivergages, terraclimate19912020, terraclimate19812010, terraclimate, twc, unavco, wdfn_agency_codes, wdfn_altitude_datums, wdfn_aquifer_codes, wdfn_aquifer_types, wdfn_channel_measurements, wdfn_citations, wdfn_combined_metadata, wdfn_continuous, wdfn_coordinate_accuracy_codes, wdfn_coordinate_datum_codes, wdfn_coordinate_method_codes, wdfn_counties, wdfn_countries, wdfn_daily, wdfn_field_measurements, wdfn_field_measurements_metadata, wdfn_hydrologic_unit_codes, wdfn_latest_continuous, wdfn_latest_daily, wdfn_latest_field_measurements, wdfn_medium_codes, wdfn_method_categories, wdfn_method_citations, wdfn_methods, wdfn_monitoring_locations, wdfn_national_aquifer_codes, wdfn_parameter_codes, wdfn_peaks, wdfn_reliability_codes, wdfn_site_types, wdfn_states, wdfn_statistic_codes, wdfn_time_series_metadata, wdfn_time_series_methods, wdfn_time_series_revisions, wdfn_time_zone_codes, wdfn_read_normal_observations, wdfn_read_interval_observations, about)
wdfn_field_measurements#
$ tsgettoolbox wdfn_field_measurements --help
usage: tsgettoolbox wdfn_field_measurements [-h] [--geometry GEOMETRY]
[--id ID]
[--field_measurements_series_id FIELD_MEASUREMENTS_SERIES_ID]
[--reading_type READING_TYPE]
[--field_visit_id FIELD_VISIT_ID]
[--parameter_code PARAMETER_CODE]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--observing_procedure_code OBSERVING_PROCEDURE_CODE]
[--observing_procedure OBSERVING_PROCEDURE]
[--value VALUE]
[--unit_of_measure UNIT_OF_MEASURE]
[--time TIME]
[--qualifier QUALIFIER]
[--vertical_datum VERTICAL_DATUM]
[--approval_status APPROVAL_STATUS]
[--measuring_agency MEASURING_AGENCY]
[--last_modified LAST_MODIFIED]
[--control_condition CONTROL_CONDITION]
[--measurement_rated MEASUREMENT_RATED]
[--year YEAR] [--month MONTH]
[--day DAY]
[--time_of_day TIME_OF_DAY]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum_site VERTICAL_DATUM_SITE]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--ts_return_style TS_RETURN_STYLE]
Field measurements are physically measured values collected during a visit to
the monitoring location. Field measurements consist of measurements of gage
height and discharge, and readings of groundwater levels, and are primarily
used as calibration readings for the automated sensors collecting continuous
data. They are collected at a low frequency, and delivery of the data in WDFN
may be delayed due to data processing time.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. There may be
multiple readings occurring at identical times during
a single field visit; to uniquely identify a set of
readings over time, use the `field_visit_id` field.
--field_measurements_series_id FIELD_MEASUREMENTS_SERIES_ID
A unique identifier representing a single collection
series. This corresponds to the `id` field in the
`field-measurements-metadata` endpoint. Collection
series are defined as the set of field measurements at
a given monitoring location for a single parameter
code using a single reading type.
--reading_type READING_TYPE
Distinguishes field-measurement readings from
measurements. Readings have a value of
ReferencePrimary; measurements are Discharge or
MeanGageHeight.
--field_visit_id FIELD_VISIT_ID
A universally unique identifier (UUID) for the field
visit. Multiple measurements may be made during a
single field visit.
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--observing_procedure_code OBSERVING_PROCEDURE_CODE
A short code corresponding to the observing procedure
for the field measurement.
--observing_procedure OBSERVING_PROCEDURE
Water measurement or water-quality observing procedure
descriptions.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--approval_status APPROVAL_STATUS
Some of the data that you have obtained from this U.S.
Geological Survey database may not have received
Director's approval. Any such data values are
qualified as provisional and are subject to revision.
Provisional data are released on the condition that
neither the USGS nor the United States Government may
be held liable for any damages resulting from its use.
This field reflects the approval status of each
record, and is either "Approved", meaining processing
review has been completed and the data is approved for
publication, or "Provisional" and subject to revision.
For more information about provisional data, go to
[https://waterdata.usgs.gov/provisional-data-
statement/](https://waterdata.usgs.gov/provisional-
data-statement/).
--measuring_agency MEASURING_AGENCY
The agency performing the measurement.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--control_condition CONTROL_CONDITION
The state of the control feature at the time of
observation.
--measurement_rated MEASUREMENT_RATED
A qualitative estimate of the quality of a
measurement.
--year YEAR The calendar year the field measurement was taken.
--month MONTH The calendar month the field measurement was taken. If
null, the month is unknown.
--day DAY The day of the month the field measurement was taken.
If null, the day is unknown.
--time_of_day TIME_OF_DAY
The time of day the field measurement was taken. If
null, the time of day is unknown.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum_site VERTICAL_DATUM_SITE
The vertical datum used to determine altitude at the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/a
ltitude-datums/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/altitude-datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_field_measurements_metadata#
$ tsgettoolbox wdfn_field_measurements_metadata --help
usage: tsgettoolbox wdfn_field_measurements_metadata [-h]
[--geometry GEOMETRY]
[--id ID]
[--reading_type READING_TYPE]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE]
[--parameter_name PARAMETER_NAME]
[--parameter_description PARAMETER_DESCRIPTION]
[--begin BEGIN]
[--end END]
[--last_modified LAST_MODIFIED]
[--sublocation_identifier SUBLOCATION_IDENTIFIER]
This endpoint provides metadata about field measurement collections, including
when the earliest and most recent observations for a parameter occurred at a
monitoring location and its units.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A unique identifier representing a single collection
series. This corresponds to the
`field_measurement_series_id` field in the `field-
measurements` endpoint. Collection series are defined
as the set of field measurements at a given monitoring
location for a single parameter code using a single
reading type.
--reading_type READING_TYPE
Distinguishes field-measurement readings from
measurements. Readings have a value of
ReferencePrimary; measurements are Discharge or
MeanGageHeight.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--parameter_name PARAMETER_NAME
A human-understandable name corresponding to
`parameter_code`.
--parameter_description PARAMETER_DESCRIPTION
A description of what the parameter code represents,
as used by WDFN and other USGS data dissemination
products.
--begin BEGIN The datetime of the earliest observation in the time
series. Together with `end_utc`, this field represents
the period of record of a time series. Note that some
time series may have large gaps in their collection
record. You can query this field using date-times or
intervals, adhering to RFC 3339, or using ISO 8601
duration objects. Intervals may be bounded or half-
bounded (double-dots at start or end). Examples: - A
date-time: "2018-02-12T23:20:50Z" - A bounded
interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `begin_utc` that
intersects the value of datetime are selected.
--end END The datetime of the most recent observation in the
time series. Data returned by this endpoint updates at
most once per day, and potentially less frequently
than that, and as such there may be more recent
observations within a time series than the time series
`end_utc` value reflects. Together with `begin_utc`,
this field represents the period of record of a time
series. It is additionally used to determine whether a
time series is "active". You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `end_utc` that
intersects the value of datetime are selected.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--sublocation_identifier SUBLOCATION_IDENTIFIER
An optional human-readable identifier used to specify
where measurements are recorded at a monitoring
location.
wdfn_hydrologic_unit_codes#
$ tsgettoolbox wdfn_hydrologic_unit_codes --help
usage: tsgettoolbox wdfn_hydrologic_unit_codes [-h] [--geometry GEOMETRY]
[--id ID]
[--hydrologic_unit_name HYDROLOGIC_UNIT_NAME]
[--hydrologic_unit_classification_code HYDROLOGIC_UNIT_CLASSIFICATION_CODE]
Hydrologic units are geographic areas representing part or all of a surface
drainage basin or distinct hydrologic feature identified by a unique number
(HUC), and a name. The United States is divided and sub-divided into
successively smaller hydrologic units which are classified into four levels:
regions, sub-regions, accounting units, and cataloging units. Each unit
consists of two to eight digits based on the four levels of classification in
the hydrologic unit system. Additional information can be found at
<https://water.usgs.gov/GIS/huc.html>.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Hydrologic unit code. The format of the code is
('RRSSBBUUWWXX') where: 'RR' is the 2-digit code for
the region. 'SS' is the 2-digit code for the sub-
region. 'BB' is the 2-digit code for the basin. 'UU'
is the 2-digit code for the sub-basin. 'WW' is the
2-digit code for the watershed. 'XX' is the 2-digit
code for the sub- watershed. Watersheds are delineated
by USGS using a nationwide system based on surface
hydrologic features. This system divides the country
into 22 regions (2-digit), 245 subregions (4-digit),
405 basins (6-digit), ~2,400 subbasins (8-digit),
~19,000 watersheds (10-digit), and ~105,000
subwatersheds (12-digit). A hierarchical hydrologic
unit code (HUC) consisting of 2 additional digits for
each level in the hydrologic unit system is used to
identify any hydrologic area (see Federal Standards
and Procedures for the National Watershed Boundary
Dataset - https://pubs.usgs.gov/tm/11/a3/).
--hydrologic_unit_name HYDROLOGIC_UNIT_NAME
Hydrologic unit name.
--hydrologic_unit_classification_code HYDROLOGIC_UNIT_CLASSIFICATION_CODE
Hydrologic unit classification code.
wdfn_latest_continuous#
$ tsgettoolbox wdfn_latest_continuous --help
usage: tsgettoolbox wdfn_latest_continuous [-h] [--geometry GEOMETRY]
[--id ID]
[--time_series_id TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE]
[--statistic_id STATISTIC_ID]
[--time TIME] [--value VALUE]
[--unit_of_measure UNIT_OF_MEASURE]
[--approval_status APPROVAL_STATUS]
[--qualifier QUALIFIER]
[--last_modified LAST_MODIFIED]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--data_gap_interval DATA_GAP_INTERVAL]
[--ts_return_style TS_RETURN_STYLE]
This endpoint provides the most recent observation for each time series of
continuous data. Continuous data are collected via automated sensors installed
at a monitoring location. They are collected at a high frequency and often at
a fixed 15-minute interval. Depending on the specific monitoring location, the
data may be transmitted automatically via telemetry and be available on WDFN
within minutes of collection, while other times the delivery of data may be
delayed if the monitoring location does not have the capacity to automatically
transmit data. Continuous data are described by parameter name and parameter
code. These data might also be referred to as "instantaneous values" or "IV"
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. To uniquely
identify a single observation over time, compare the
`time` and `time_series_id` fields; each time series
will only have a single observation at a given `time`.
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--statistic_id STATISTIC_ID
A code corresponding to the statistic an observation
represents. Example codes include 00001 (max), 00002
(min), and 00003 (mean). A complete list of codes and
their descriptions can be found at [https://api.waterd
ata.usgs.gov/ogcapi/v1/collections/statistic-codes/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/statistic-codes/items).
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--approval_status APPROVAL_STATUS
Some of the data that you have obtained from this U.S.
Geological Survey database may not have received
Director's approval. Any such data values are
qualified as provisional and are subject to revision.
Provisional data are released on the condition that
neither the USGS nor the United States Government may
be held liable for any damages resulting from its use.
This field reflects the approval status of each
record, and is either "Approved", meaining processing
review has been completed and the data is approved for
publication, or "Provisional" and subject to revision.
For more information about provisional data, go to
[https://waterdata.usgs.gov/provisional-data-
statement/](https://waterdata.usgs.gov/provisional-
data-statement/).
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_latest_daily#
$ tsgettoolbox wdfn_latest_daily --help
usage: tsgettoolbox wdfn_latest_daily [-h] [--geometry GEOMETRY] [--id ID]
[--time_series_id TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE]
[--statistic_id STATISTIC_ID]
[--time TIME] [--value VALUE]
[--unit_of_measure UNIT_OF_MEASURE]
[--approval_status APPROVAL_STATUS]
[--qualifier QUALIFIER]
[--last_modified LAST_MODIFIED]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--data_gap_interval DATA_GAP_INTERVAL]
[--ts_return_style TS_RETURN_STYLE]
Daily data provide one data value to represent water conditions for the day.
Throughout much of the history of the USGS, the primary water data available
was daily data collected manually at the monitoring location once each day.
With improved availability of computer storage and automated transmission of
data, the daily data published today are generally a statistical summary or
metric of the continuous data collected each day, such as the daily mean,
minimum, or maximum value. Daily data are automatically calculated from the
continuous data of the same parameter code and are described by parameter code
and a statistic code. These data have also been referred to as “daily values”
or “DV”.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. To uniquely
identify a single observation over time, compare the
`time` and `time_series_id` fields; each time series
will only have a single observation at a given `time`.
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--statistic_id STATISTIC_ID
A code corresponding to the statistic an observation
represents. Example codes include 00001 (max), 00002
(min), and 00003 (mean). A complete list of codes and
their descriptions can be found at [https://api.waterd
ata.usgs.gov/ogcapi/v1/collections/statistic-codes/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/statistic-codes/items).
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--approval_status APPROVAL_STATUS
Some of the data that you have obtained from this U.S.
Geological Survey database may not have received
Director's approval. Any such data values are
qualified as provisional and are subject to revision.
Provisional data are released on the condition that
neither the USGS nor the United States Government may
be held liable for any damages resulting from its use.
This field reflects the approval status of each
record, and is either "Approved", meaining processing
review has been completed and the data is approved for
publication, or "Provisional" and subject to revision.
For more information about provisional data, go to
[https://waterdata.usgs.gov/provisional-data-
statement/](https://waterdata.usgs.gov/provisional-
data-statement/).
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_latest_field_measurements#
$ tsgettoolbox wdfn_latest_field_measurements --help
usage: tsgettoolbox wdfn_latest_field_measurements [-h] [--geometry GEOMETRY]
[--id ID]
[--field_measurements_series_id FIELD_MEASUREMENTS_SERIES_ID]
[--field_visit_id FIELD_VISIT_ID]
[--parameter_code PARAMETER_CODE]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--observing_procedure_code OBSERVING_PROCEDURE_CODE]
[--observing_procedure OBSERVING_PROCEDURE]
[--value VALUE]
[--unit_of_measure UNIT_OF_MEASURE]
[--time TIME]
[--qualifier QUALIFIER]
[--vertical_datum VERTICAL_DATUM]
[--approval_status APPROVAL_STATUS]
[--measuring_agency MEASURING_AGENCY]
[--last_modified LAST_MODIFIED]
[--control_condition CONTROL_CONDITION]
[--measurement_rated MEASUREMENT_RATED]
[--year YEAR]
[--month MONTH] [--day DAY]
[--time_of_day TIME_OF_DAY]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum_site VERTICAL_DATUM_SITE]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--ts_return_style TS_RETURN_STYLE]
Field measurements are physically measured values collected during a visit to
the monitoring location. Field measurements consist of measurements of gage
height and discharge, and readings of groundwater levels, and are primarily
used as calibration readings for the automated sensors collecting continuous
data. They are collected at a low frequency, and delivery of the data in WDFN
may be delayed due to data processing time.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A universally unique identifier (UUID) representing a
single version of a record. It is not stable over
time. Every time the record is refreshed in our
database (which may happen as part of normal
operations and does not imply any change to the data
itself) a new ID will be generated. There may be
multiple readings occurring at identical times during
a single field visit; to uniquely identify a set of
readings over time, use the `field_visit_id` field.
--field_measurements_series_id FIELD_MEASUREMENTS_SERIES_ID
A unique identifier representing a single collection
series. This corresponds to the `id` field in the
`field-measurements-metadata` endpoint. Collection
series are defined as the set of field measurements at
a given monitoring location for a single parameter
code using a single reading type.
--field_visit_id FIELD_VISIT_ID
A universally unique identifier (UUID) for the field
visit. Multiple measurements may be made during a
single field visit.
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--observing_procedure_code OBSERVING_PROCEDURE_CODE
A short code corresponding to the observing procedure
for the field measurement.
--observing_procedure OBSERVING_PROCEDURE
Water measurement or water-quality observing procedure
descriptions.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--approval_status APPROVAL_STATUS
Some of the data that you have obtained from this U.S.
Geological Survey database may not have received
Director's approval. Any such data values are
qualified as provisional and are subject to revision.
Provisional data are released on the condition that
neither the USGS nor the United States Government may
be held liable for any damages resulting from its use.
This field reflects the approval status of each
record, and is either "Approved", meaining processing
review has been completed and the data is approved for
publication, or "Provisional" and subject to revision.
For more information about provisional data, go to
[https://waterdata.usgs.gov/provisional-data-
statement/](https://waterdata.usgs.gov/provisional-
data-statement/).
--measuring_agency MEASURING_AGENCY
The agency performing the measurement.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--control_condition CONTROL_CONDITION
The state of the control feature at the time of
observation.
--measurement_rated MEASUREMENT_RATED
A qualitative estimate of the quality of a
measurement.
--year YEAR The calendar year the field measurement was taken.
--month MONTH The calendar month the field measurement was taken. If
null, the month is unknown.
--day DAY The day of the month the field measurement was taken.
If null, the day is unknown.
--time_of_day TIME_OF_DAY
The time of day the field measurement was taken. If
null, the time of day is unknown.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum_site VERTICAL_DATUM_SITE
The vertical datum used to determine altitude at the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/a
ltitude-datums/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/altitude-datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_medium_codes#
$ tsgettoolbox wdfn_medium_codes --help
usage: tsgettoolbox wdfn_medium_codes [-h] [--geometry GEOMETRY] [--id ID]
[--medium_name MEDIUM_NAME]
[--medium_description MEDIUM_DESCRIPTION]
[--legacy_medium_code LEGACY_MEDIUM_CODE]
Medium refers to the specific environmental medium from which the sample was
collected. Medium type differs from site type because one site type, such as
surface water, could have data for several media, such as water, bottom
sediment, fish tissue, and others.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID The medium code is the 3-character alpha code that
identifies the material type and quality-assurance
type of the sample. The first character of the code is
the \"super\" medium, which describes the primary
matrix of the sample. The second character is the sub-
medium, which characterizes the sample type as a
unique entity within the \"super\" medium category.
The third character is used to designate whether a
sample is an environmental or QC sample. A blank in
position three denotes an environmental sample; a
\"Q\" in position three denotes a QC sample.
--medium_name MEDIUM_NAME
The medium name is a short identifying appellation
that explains the associated medium code. See qwmed
for examples of codes, names, and descriptions.
--medium_description MEDIUM_DESCRIPTION
The medium description is a short string of words that
explains the associated medium code. See qwmed for
examples of codes, names, and descriptions.
--legacy_medium_code LEGACY_MEDIUM_CODE
Historical 1-char medium code that corresponds to the
3-char code.
wdfn_method_categories#
$ tsgettoolbox wdfn_method_categories --help
usage: tsgettoolbox wdfn_method_categories [-h] [--geometry GEOMETRY]
[--id ID]
[--method_category_name METHOD_CATEGORY_NAME]
[--method_category_description METHOD_CATEGORY_DESCRIPTION]
Categorical standards for methods describing the associated data's
appropriateness for an intended use.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Code representing the method category standard.
--method_category_name METHOD_CATEGORY_NAME
Name representing the method category standard.
--method_category_description METHOD_CATEGORY_DESCRIPTION
Full description of the method category as defined by
the USGS Water Mission Area standards for field and
analytical methods and their fit-for-purpose use
internally and for public delivery
wdfn_method_citations#
$ tsgettoolbox wdfn_method_citations --help
usage: tsgettoolbox wdfn_method_citations [-h] [--geometry GEOMETRY] [--id ID]
[--method_id METHOD_ID]
[--citation_name CITATION_NAME]
[--citation_method_number CITATION_METHOD_NUMBER]
[--method_source METHOD_SOURCE]
Citation identifiers for water measurement methods.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Citation method identification number.
--method_id METHOD_ID
USGS Central Laboratory method code. The lab method
used to determine a parameter value.
--citation_name CITATION_NAME
Method citation name. An abbreviated citation that
describes the reference.
--citation_method_number CITATION_METHOD_NUMBER
Citation method number. A number assigned to a method
within a cited reference.
--method_source METHOD_SOURCE
Protocol organization code.
wdfn_methods#
$ tsgettoolbox wdfn_methods --help
usage: tsgettoolbox wdfn_methods [-h] [--geometry GEOMETRY] [--id ID]
[--method_type METHOD_TYPE]
[--method_category METHOD_CATEGORY]
[--method_name METHOD_NAME]
[--method_description METHOD_DESCRIPTION]
Water measurement or water-quality analytical methods. Codes and descriptions
defining a method for calculating or measuring the value of a water quality or
quantity parameter. Method codes are associated with one or many parameter
codes.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Water measurement or water-quality analytical method
code. The method used to determine a parameter value.
--method_type METHOD_TYPE
Method type for measured or collected data
--method_category METHOD_CATEGORY
Code representing the method category standard.
--method_name METHOD_NAME
A short name that partially describes a method.
--method_description METHOD_DESCRIPTION
A long name that fully describes a method.
wdfn_monitoring_locations#
$ tsgettoolbox wdfn_monitoring_locations --help
usage: tsgettoolbox wdfn_monitoring_locations [-h] [--geometry GEOMETRY]
[--id ID]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE]
[--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--revision_note REVISION_NOTE]
[--revision_created REVISION_CREATED]
[--revision_modified REVISION_MODIFIED]
Location information is basic information about the monitoring location
including the name, identifier, agency responsible for data collection, and
the date the location was established. It also includes information about the
type of location, such as stream, lake, or groundwater, and geographic
information about the location, such as state, county, latitude and longitude,
and hydrologic unit code (HUC).
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A unique identifier representing a single monitoring
location. This corresponds to the
`monitoring_location_id` field in other endpoints.
Monitoring location IDs are created by combining the
agency code of the agency responsible for the
monitoring location (e.g. USGS) with the ID number of
the monitoring location (e.g. 02238500), separated by
a hyphen (e.g. USGS-02238500).
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--revision_note REVISION_NOTE
Approved water data are considered published record,
but on occasion changes or deletions (revisions) must
be made to data after they are approved. Data
revisions are rare because of USGS quality assurance
practices, including documentation of all data before
they are officially approved. This field contains text
explanations for data revisions at this monitoring
location. Changes to data also are indicated with
revision qualifier codes alongside the data. Text
explanations before 2017 are not necessarily available
online, but can be requested.
--revision_created REVISION_CREATED
The date a revision statement was created.
--revision_modified REVISION_MODIFIED
The most recent date a revision statement was
modified.
wdfn_national_aquifer_codes#
$ tsgettoolbox wdfn_national_aquifer_codes --help
usage: tsgettoolbox wdfn_national_aquifer_codes [-h] [--geometry GEOMETRY]
[--id ID]
[--national_aquifer_name NATIONAL_AQUIFER_NAME]
National aquifers are the principal aquifers or aquifer systems in the United
States, defined as regionally extensive aquifers or aquifer systems that have
the potential to be used as a source of potable water.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID National aquifer code.
--national_aquifer_name NATIONAL_AQUIFER_NAME
National aquifer name.
wdfn_parameter_codes#
$ tsgettoolbox wdfn_parameter_codes --help
usage: tsgettoolbox wdfn_parameter_codes [-h] [--geometry GEOMETRY] [--id ID]
[--parameter_name PARAMETER_NAME]
[--unit_of_measure UNIT_OF_MEASURE]
[--parameter_group_code PARAMETER_GROUP_CODE]
[--parameter_description PARAMETER_DESCRIPTION]
[--medium MEDIUM]
[--statistical_basis STATISTICAL_BASIS]
[--time_basis TIME_BASIS]
[--weight_basis WEIGHT_BASIS]
[--particle_size_basis PARTICLE_SIZE_BASIS]
[--sample_fraction SAMPLE_FRACTION]
[--temperature_basis TEMPERATURE_BASIS]
[--epa_equivalence EPA_EQUIVALENCE]
Parameter codes are 5-digit codes and associated descriptions used to identify
the constituent measured and the units of measure. Some parameter code
definitions include information about the sampling matrix, fraction, and
methods used to measure the constituent. Some parameters are fixed-value (fxd)
numeric codes having textual meaning (for example: parameter code 00041 is a
weather code parameter, code of 60 means rain), but more commonly represent a
numeric value for chemical, physical, or biological data.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Parameter code.
--parameter_name PARAMETER_NAME
Parameter short name.
--unit_of_measure UNIT_OF_MEASURE
Parameter reporting units defined to cooperate with
descriptions by USEPA.
--parameter_group_code PARAMETER_GROUP_CODE
Categorical groupings of parameters by water-quality
data type for display and report ordering
--parameter_description PARAMETER_DESCRIPTION
Parameter description.
--medium MEDIUM Parameter medium.
--statistical_basis STATISTICAL_BASIS
Parameter statistical basis.
--time_basis TIME_BASIS
Parameter time basis.
--weight_basis WEIGHT_BASIS
Parameter weight basis.
--particle_size_basis PARTICLE_SIZE_BASIS
Parameter particle-size basis.
--sample_fraction SAMPLE_FRACTION
Parameter fraction.
--temperature_basis TEMPERATURE_BASIS
Parameter temperature basis.
--epa_equivalence EPA_EQUIVALENCE
Indicates the relationship of the USGS parameter code
to the EPA code.
wdfn_peaks#
$ tsgettoolbox wdfn_peaks --help
usage: tsgettoolbox wdfn_peaks [-h] [--geometry GEOMETRY]
[--time_series_id TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE] [--id ID]
[--unit_of_measure UNIT_OF_MEASURE]
[--value VALUE] [--last_modified LAST_MODIFIED]
[--time TIME] [--water_year WATER_YEAR]
[--year YEAR] [--month MONTH] [--day DAY]
[--time_of_day TIME_OF_DAY]
[--peak_since PEAK_SINCE]
[--qualifier QUALIFIER]
[--agency_code AGENCY_CODE]
[--agency_name AGENCY_NAME]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--monitoring_location_name MONITORING_LOCATION_NAME]
[--district_code DISTRICT_CODE]
[--country_code COUNTRY_CODE]
[--country_name COUNTRY_NAME]
[--state_code STATE_CODE]
[--state_name STATE_NAME]
[--county_code COUNTY_CODE]
[--county_name COUNTY_NAME]
[--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type SITE_TYPE]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--basin_code BASIN_CODE] [--altitude ALTITUDE]
[--altitude_accuracy ALTITUDE_ACCURACY]
[--altitude_method_code ALTITUDE_METHOD_CODE]
[--altitude_method_name ALTITUDE_METHOD_NAME]
[--vertical_datum VERTICAL_DATUM]
[--vertical_datum_name VERTICAL_DATUM_NAME]
[--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE]
[--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY]
[--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE]
[--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME]
[--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM]
[--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME]
[--drainage_area DRAINAGE_AREA]
[--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA]
[--time_zone_abbreviation TIME_ZONE_ABBREVIATION]
[--uses_daylight_savings USES_DAYLIGHT_SAVINGS]
[--construction_date CONSTRUCTION_DATE]
[--aquifer_code AQUIFER_CODE]
[--national_aquifer_code NATIONAL_AQUIFER_CODE]
[--aquifer_type_code AQUIFER_TYPE_CODE]
[--well_constructed_depth WELL_CONSTRUCTED_DEPTH]
[--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH]
[--depth_source_code DEPTH_SOURCE_CODE]
[--data_gap_interval DATA_GAP_INTERVAL]
[--ts_return_style TS_RETURN_STYLE]
Annual peak flow values are the maximum instantaneous streamflow values
recorded at a particular site for the entire water year from October 1 to
September 30. Note that the annual peak flow value may not occur at the same
time the maximum water level occurs due to conditions such as backwater, tidal
fluctuations, etc.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--id ID A unique identifier for the peak value record.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--value VALUE The value of the observation. Values are transmitted
as strings in the JSON response format in order to
preserve precision.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--time TIME The date an observation represents. You can query this
field using date-times or intervals, adhering to RFC
3339, or using ISO 8601 duration objects. Intervals
may be bounded or half-bounded (double- dots at start
or end). Examples: - A date-time:
"2018-02-12T23:20:50Z" - A bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `time` that
intersects the value of datetime are selected. If a
feature has multiple temporal properties, it is the
decision of the server whether only a single temporal
property is used to determine the extent or all
relevant temporal properties.
--water_year WATER_YEAR
The water year (running from October 1st to September
30th) a peak occurred.
--year YEAR The calendar year a peak occurred.
--month MONTH The calendar month a peak occurred. If null, the month
a peak occurred is unknown.
--day DAY The day of the month a peak occurred. If null, the day
a peak occurred is unknown.
--time_of_day TIME_OF_DAY
The time of day a peak occurred. If null, the time of
day a peak occurred is unknown.
--peak_since PEAK_SINCE
If not null, this record represents the peak value for
the parameter code since the year contained in
"peak_since".
--qualifier QUALIFIER
This field indicates any qualifiers associated with an
observation, for instance if a sensor may have been
impacted by ice or if values were estimated.
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v1
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v1/collections/agency-codes/items).
--agency_name AGENCY_NAME
The name of the agency that is reporting the data.
--monitoring_location_number MONITORING_LOCATION_NUMBER
Each monitoring location in the USGS data base has a
unique 8- to 15-digit identification number.
--monitoring_location_name MONITORING_LOCATION_NAME
This is the official name of the monitoring location
in the database. For well information this can be a
district-assigned local number.
--district_code DISTRICT_CODE
The Water Science Centers (WSCs) across the United
States use the FIPS state code as the district code.
In some case, monitoring locations and samples may be
managed by a water science center that is adjacent to
the state in which the monitoring location actually
resides. For example a monitoring location may have a
district code of 30 which translates to Montana, but
the state code could be 56 for Wyoming because that is
where the monitoring location actually is located.
--country_code COUNTRY_CODE
The code for the country in which the monitoring
location is located.
--country_name COUNTRY_NAME
The name of the country in which the monitoring
location is located.
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v1/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v1/collection
s/counties/items).
--county_name COUNTY_NAME
The name of the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. [A list of codes is available at [https://api
.waterdata.usgs.gov/ogcapi/v1/collections/counties/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/counties/items).
--minor_civil_division_code MINOR_CIVIL_DIVISION_CODE
Codes for primary governmental or administrative
divisions of the county or county equivalent in which
the monitoring location is located.
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--site_type SITE_TYPE
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v1/collections/site-types/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--basin_code BASIN_CODE
The Basin Code or "drainage basin code" is a two-digit
code that further subdivides the 8-digit hydrologic-
unit code. The drainage basin code is defined by the
USGS State Office where the monitoring location is
located.
--altitude ALTITUDE Altitude of the monitoring location referenced to the
specified Vertical Datum.
--altitude_accuracy ALTITUDE_ACCURACY
Accuracy of the altitude, in feet. An accuracy of +/-
0.1 foot would be entered as “.1”. Many altitudes are
interpolated from the contours on topographic maps;
accuracies determined in this way are generally
entered as one-half of the contour interval.
--altitude_method_code ALTITUDE_METHOD_CODE
Codes representing the method used to measure
altitude.
--altitude_method_name ALTITUDE_METHOD_NAME
The name of the method used to measure altitude.
--vertical_datum VERTICAL_DATUM
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--vertical_datum_name VERTICAL_DATUM_NAME
The datum used to determine altitude and vertical
position at the monitoring location. A list of codes
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/altitude-datums/items](https://api.wat
erdata.usgs.gov/ogcapi/v1/collections/altitude-
datums/items).
--horizontal_positional_accuracy_code HORIZONTAL_POSITIONAL_ACCURACY_CODE
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_positional_accuracy HORIZONTAL_POSITIONAL_ACCURACY
Indicates the accuracy of the latitude longitude
values. A list of codes is available at [https://api.w
aterdata.usgs.gov/ogcapi/v1/collections/coordinate-
accuracy-codes/items](https://api.waterdata.usgs.gov/o
gcapi/v1/collections/coordinate-accuracy-codes/items).
--horizontal_position_method_code HORIZONTAL_POSITION_METHOD_CODE
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--horizontal_position_method_name HORIZONTAL_POSITION_METHOD_NAME
Indicates the method used to determine latitude
longitude values. A list of codes is available at [htt
ps://api.waterdata.usgs.gov/ogcapi/v1/collections/coor
dinate-method-codes/items](https://api.waterdata.usgs.
gov/ogcapi/v1/collections/coordinate-method-
codes/items).
--original_horizontal_datum ORIGINAL_HORIZONTAL_DATUM
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--original_horizontal_datum_name ORIGINAL_HORIZONTAL_DATUM_NAME
Coordinates are published in EPSG:4326 / WGS84 / World
Geodetic System 1984. This field indicates the
original datum used to determine coordinates before
they were converted. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v1/collections/c
oordinate-datum-codes/items](https://api.waterdata.usg
s.gov/ogcapi/v1/collections/coordinate-datum-
codes/items).
--drainage_area DRAINAGE_AREA
The area enclosed by a topographic divide from which
direct surface runoff from precipitation normally
drains by gravity into the stream above that point.
--contributing_drainage_area CONTRIBUTING_DRAINAGE_AREA
The contributing drainage area of a lake, stream,
wetland, or estuary monitoring location, in square
miles. This item should be present only if the
contributing area is different from the total drainage
area. This situation can occur when part of the
drainage area consists of very porous soil or
depressions that either allow all runoff to enter the
groundwater or traps the water in ponds so that
rainfall does not contribute to runoff. A transbasin
diversion can also affect the total drainage area.
--time_zone_abbreviation TIME_ZONE_ABBREVIATION
A short code describing the time zone used by a
monitoring location.
--uses_daylight_savings USES_DAYLIGHT_SAVINGS
A flag indicating whether or not a monitoring location
uses daylight savings.
--construction_date CONSTRUCTION_DATE
Date the well was completed.
--aquifer_code AQUIFER_CODE
Local aquifers in the USGS water resources data base
are identified by a geohydrologic unit code (a three-
digit number related to the age of the formation,
followed by a 4 or 5 character abbreviation for the
geologic unit or aquifer name).
--national_aquifer_code NATIONAL_AQUIFER_CODE
National aquifers are the principal aquifers or
aquifer systems in the United States, defined as
regionally extensive aquifers or aquifer systems that
have the potential to be used as a source of potable
water. Not all groundwater monitoring locations can be
associated with a National Aquifer. Such monitoring
locations will not be retrieved using this search
criteria. A list of National aquifer codes and names
is available at [https://api.waterdata.usgs.gov/ogcapi
/v1/collections/national-aquifer-codes/items](https://
api.waterdata.usgs.gov/ogcapi/v1/collections/national-
aquifer-codes/items).
--aquifer_type_code AQUIFER_TYPE_CODE
Describes the confinement status of an aquifer at the
monitoring location. A confined aquifer is an aquifer
below the land surface that is saturated with water. A
water table--or unconfined--aquifer is an aquifer
whose upper water surface (water table) is at
atmospheric pressure, and thus is able to rise and
fall.
--well_constructed_depth WELL_CONSTRUCTED_DEPTH
The depth of the finished well, in feet below land
surface datum. Note: Not all groundwater monitoring
locations have information on Well Depth. Such
monitoring locations will not be retrieved using this
search criteria.
--hole_constructed_depth HOLE_CONSTRUCTED_DEPTH
The total depth to which the hole is drilled, in feet
below land surface datum. Note: Not all groundwater
monitoring locations have information on Hole Depth.
Such monitoring locations will not be retrieved using
this search criteria.
--depth_source_code DEPTH_SOURCE_CODE
A code indicating the source of water-level data.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
--ts_return_style TS_RETURN_STYLE
Return style, either 'compact' or 'full'
wdfn_reliability_codes#
$ tsgettoolbox wdfn_reliability_codes --help
usage: tsgettoolbox wdfn_reliability_codes [-h] [--geometry GEOMETRY]
[--id ID]
[--reliability_description RELIABILITY_DESCRIPTION]
Code indicating the reliability of the data available for the site.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID id
--reliability_description RELIABILITY_DESCRIPTION
reliability_description
wdfn_site_types#
$ tsgettoolbox wdfn_site_types --help
usage: tsgettoolbox wdfn_site_types [-h] [--geometry GEOMETRY] [--id ID]
[--site_type_primary_flag SITE_TYPE_PRIMARY_FLAG]
[--site_type_name SITE_TYPE_NAME]
[--site_type_description SITE_TYPE_DESCRIPTION]
The hydrologic cycle setting or a man-made feature thought to affect the
hydrologic conditions measured at a site. Primary and secondary site types
associated with data collection sites. All sites have a primary site type, and
may additionally have a secondary site type that further describes the
location.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID An acronym specifying the primary or secondary site
type.
--site_type_primary_flag SITE_TYPE_PRIMARY_FLAG
Identifies which site types are primary.
--site_type_name SITE_TYPE_NAME
A long name for the site type used in retrieved
output.
--site_type_description SITE_TYPE_DESCRIPTION
Site type description.
wdfn_states#
$ tsgettoolbox wdfn_states --help
usage: tsgettoolbox wdfn_states [-h] [--geometry GEOMETRY] [--id ID]
[--country_code COUNTRY_CODE]
[--state_fips_code STATE_FIPS_CODE]
[--state_name STATE_NAME]
[--state_postal_code STATE_POSTAL_CODE]
State name or territory. Includes U.S. states and foreign entities classified
under FIPS as 'Principal Administrative Divisions'.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID
--country_code COUNTRY_CODE
The purpose of ISO 3166 is to define internationally
recognized codes of letters and/or numbers that we can
use when we refer to countries and their subdivisions.
--state_fips_code STATE_FIPS_CODE
State FIPS code.
--state_name STATE_NAME
State name.
--state_postal_code STATE_POSTAL_CODE
State postal abbreviation. A two-letter USPS state
postal abbreviation.
wdfn_statistic_codes#
$ tsgettoolbox wdfn_statistic_codes --help
usage: tsgettoolbox wdfn_statistic_codes [-h] [--geometry GEOMETRY] [--id ID]
[--statistic_name STATISTIC_NAME]
[--statistic_description STATISTIC_DESCRIPTION]
Statistic codes.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Statistic code.
--statistic_name STATISTIC_NAME
Statistic name.
--statistic_description STATISTIC_DESCRIPTION
Statistic description.
wdfn_time_series_metadata#
$ tsgettoolbox wdfn_time_series_metadata --help
usage: tsgettoolbox wdfn_time_series_metadata [-h] [--geometry GEOMETRY]
[--id ID]
[--unit_of_measure UNIT_OF_MEASURE]
[--parameter_name PARAMETER_NAME]
[--parameter_code PARAMETER_CODE]
[--statistic_id STATISTIC_ID]
[--hydrologic_unit_code HYDROLOGIC_UNIT_CODE]
[--state_name STATE_NAME]
[--last_modified LAST_MODIFIED]
[--begin BEGIN] [--end END]
[--begin_utc BEGIN_UTC]
[--end_utc END_UTC]
[--computation_period_identifier COMPUTATION_PERIOD_IDENTIFIER]
[--computation_identifier COMPUTATION_IDENTIFIER]
[--thresholds THRESHOLDS]
[--sublocation_identifier SUBLOCATION_IDENTIFIER]
[--primary PRIMARY]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--web_description WEB_DESCRIPTION]
[--parameter_description PARAMETER_DESCRIPTION]
[--parent_time_series_id PARENT_TIME_SERIES_ID]
[--data_gap_interval DATA_GAP_INTERVAL]
Daily data and continuous measurements are grouped into time series, which
represent a collection of observations of a single parameter, potentially
aggregated using a standard statistic, at a single monitoring location. This
endpoint provides metadata about those time series, including their
operational thresholds, units of measurement, and when the earliest and most
recent observations in a time series occurred.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A unique identifier representing a single time series.
This corresponds to the "time_series_id" field in
other endpoints.
--unit_of_measure UNIT_OF_MEASURE
A human-readable description of the units of
measurement associated with an observation.
--parameter_name PARAMETER_NAME
A human-understandable name corresponding to
`parameter_code`.
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v1/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v1/collections/parame
ter-codes/items).
--statistic_id STATISTIC_ID
A code corresponding to the statistic an observation
represents. Example codes include 00001 (max), 00002
(min), and 00003 (mean). A complete list of codes and
their descriptions can be found at [https://api.waterd
ata.usgs.gov/ogcapi/v1/collections/statistic-codes/ite
ms](https://api.waterdata.usgs.gov/ogcapi/v1/collectio
ns/statistic-codes/items).
--hydrologic_unit_code HYDROLOGIC_UNIT_CODE
The hydrologic unit code (HUC) for the monitoring
location. Supports prefix matching — querying with a
shorter HUC (e.g. "04") matches all locations within
that hydrologic region.
--state_name STATE_NAME
The name of the state or state equivalent in which the
monitoring location is located.
--last_modified LAST_MODIFIED
The last time a record was refreshed in our database.
This may happen due to regular operational processes
and does not necessarily indicate anything about the
measurement has changed. You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `last_modified`
that intersects the value of datetime are selected.
--begin BEGIN This field contains the same information as
"begin_utc", but in the local time of the monitoring
location. It is retained for backwards compatibility,
but will be removed in V1 of these APIs.
--end END This field contains the same information as "end_utc",
but in the local time of the monitoring location. It
is retained for backwards compatibility, but will be
removed in V1 of these APIs.
--begin_utc BEGIN_UTC
The datetime of the earliest observation in the time
series. Together with `end_utc`, this field represents
the period of record of a time series. Note that some
time series may have large gaps in their collection
record. You can query this field using date-times or
intervals, adhering to RFC 3339, or using ISO 8601
duration objects. Intervals may be bounded or half-
bounded (double-dots at start or end). Examples: - A
date-time: "2018-02-12T23:20:50Z" - A bounded
interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `begin_utc` that
intersects the value of datetime are selected.
--end_utc END_UTC The datetime of the most recent observation in the
time series. Data returned by this endpoint updates at
most once per day, and potentially less frequently
than that, and as such there may be more recent
observations within a time series than the time series
`end_utc` value reflects. Together with `begin_utc`,
this field represents the period of record of a time
series. It is additionally used to determine whether a
time series is "active". You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `end_utc` that
intersects the value of datetime are selected.
--computation_period_identifier COMPUTATION_PERIOD_IDENTIFIER
Indicates the period of data used for any statistical
computations.
--computation_identifier COMPUTATION_IDENTIFIER
Indicates the computation performed to calculate this
time series. Values of "Instantaneous" reflect point
measurements.
--thresholds THRESHOLDS
Thresholds represent known numeric limits for a time
series, for example the historic maximum value for a
parameter or a level below which a sensor is non-
operative. These thresholds are sometimes used to
automatically determine if an observation is erroneous
due to sensor error, and therefore shouldn't be
included in the time series.
--sublocation_identifier SUBLOCATION_IDENTIFIER
An optional human-readable identifier used to specify
where measurements are recorded at a monitoring
location.
--primary PRIMARY A flag identifying if the time series is a "primary"
time series. "Primary" time series (which have this
flag) are standard observations which undergo [Bureau
review and approval
processes](https://www.usgs.gov/survey-
manual/5028-fundamental-science-practices-review-and-
approval-scientific-data-release). Non-primary time
series, which will have missing values for "primary",
are provisional datasets made available to meet the
need for timely best science and to assist with daily
operations which need real-time information. Non-
primary time series data are only retained by this
system for 120 days. See the [USGS Provisional Data
Statement](https://waterdata.usgs.gov/provisional-
data- statement/) for more information.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--web_description WEB_DESCRIPTION
An optional description of the time series. WDFN and
other USGS data dissemination products use this field,
in combination with sublocation_identifier, to
distinguish the differences between multiple time
series for the same parameter code, statistic code,
and monitoring location.
--parameter_description PARAMETER_DESCRIPTION
A description of what the parameter code represents,
as used by WDFN and other USGS data dissemination
products.
--parent_time_series_id PARENT_TIME_SERIES_ID
The unique identifier representing the parent or
"upchain" time series that a daily values time series
is generated from. Daily values time series have one
and only one parent time series.
--data_gap_interval DATA_GAP_INTERVAL
The time interval threshold used for gap detection in
the time series.
wdfn_time_series_methods#
$ tsgettoolbox wdfn_time_series_methods --help
usage: tsgettoolbox wdfn_time_series_methods [-h] [--geometry GEOMETRY]
[--id ID]
[--time_series_id TIME_SERIES_ID]
[--begin BEGIN] [--end END]
[--method_id METHOD_ID]
[--method_category METHOD_CATEGORY]
The measurement or computation method in effect for a time series over a given
interval. A time series can have many methods over its history; each record
here represents one contiguous interval during which a single method was used.
This collection is non-spatial: method records carry no geometry, so
bbox/spatial filters are not supported.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A unique identifier for a single time series method
interval record.
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--begin BEGIN The datetime of the earliest observation in the time
series. Together with `end_utc`, this field represents
the period of record of a time series. Note that some
time series may have large gaps in their collection
record. You can query this field using date-times or
intervals, adhering to RFC 3339, or using ISO 8601
duration objects. Intervals may be bounded or half-
bounded (double-dots at start or end). Examples: - A
date-time: "2018-02-12T23:20:50Z" - A bounded
interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `begin_utc` that
intersects the value of datetime are selected.
--end END The datetime of the most recent observation in the
time series. Data returned by this endpoint updates at
most once per day, and potentially less frequently
than that, and as such there may be more recent
observations within a time series than the time series
`end_utc` value reflects. Together with `begin_utc`,
this field represents the period of record of a time
series. It is additionally used to determine whether a
time series is "active". You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `end_utc` that
intersects the value of datetime are selected.
--method_id METHOD_ID
The RLMS method code identifying the measurement or
computation method in effect for this interval.
--method_category METHOD_CATEGORY
The RLMS method category code classifying the method
identified by `method_id`.
wdfn_time_series_revisions#
$ tsgettoolbox wdfn_time_series_revisions --help
usage: tsgettoolbox wdfn_time_series_revisions [-h] [--geometry GEOMETRY]
[--id ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--time_series_id TIME_SERIES_ID]
[--revision_note REVISION_NOTE]
[--begin BEGIN] [--end END]
Approved water data are considered published record, but on occasion changes
or deletions (revisions) must be made to data after they are approved. Data
revisions are rare because of USGS quality assurance practices, including
documentation of all data before they are officially approved. This field
contains text explanations for data revisions on a specific time series.
Changes to data also are indicated with revision qualifier codes alongside the
data. Text explanations before 2017 are not necessarily available online, but
can be requested. This collection is non-spatial: revision records carry no
geometry, so bbox/spatial filters are not supported.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID A unique identifier for a single revision record.
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500).
--time_series_id TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint.
--revision_note REVISION_NOTE
Approved water data are considered published record,
but on occasion changes or deletions (revisions) must
be made to data after they are approved. Data
revisions are rare because of USGS quality assurance
practices, including documentation of all data before
they are officially approved. This field contains text
explanations for data revisions at this monitoring
location. Changes to data also are indicated with
revision qualifier codes alongside the data. Text
explanations before 2017 are not necessarily available
online, but can be requested.
--begin BEGIN The datetime of the earliest observation in the time
series. Together with `end_utc`, this field represents
the period of record of a time series. Note that some
time series may have large gaps in their collection
record. You can query this field using date-times or
intervals, adhering to RFC 3339, or using ISO 8601
duration objects. Intervals may be bounded or half-
bounded (double-dots at start or end). Examples: - A
date-time: "2018-02-12T23:20:50Z" - A bounded
interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
- Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `begin_utc` that
intersects the value of datetime are selected.
--end END The datetime of the most recent observation in the
time series. Data returned by this endpoint updates at
most once per day, and potentially less frequently
than that, and as such there may be more recent
observations within a time series than the time series
`end_utc` value reflects. Together with `begin_utc`,
this field represents the period of record of a time
series. It is additionally used to determine whether a
time series is "active". You can query this field
using date-times or intervals, adhering to RFC 3339,
or using ISO 8601 duration objects. Intervals may be
bounded or half-bounded (double-dots at start or end).
Examples: - A date-time: "2018-02-12T23:20:50Z" - A
bounded interval:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" - Half-
bounded intervals: "2018-02-12T00:00:00Z/.." or
"../2018-03-18T12:31:12Z" - Duration objects: "P1M"
for data from the past month or "PT36H" for the last
36 hours Only features that have a `end_utc` that
intersects the value of datetime are selected.
wdfn_time_zone_codes#
$ tsgettoolbox wdfn_time_zone_codes --help
usage: tsgettoolbox wdfn_time_zone_codes [-h] [--geometry GEOMETRY] [--id ID]
[--time_zone_name TIME_ZONE_NAME]
[--time_zone_description TIME_ZONE_DESCRIPTION]
[--time_zone_utc_offset TIME_ZONE_UTC_OFFSET]
[--time_zone_daylight_savings_time_code TIME_ZONE_DAYLIGHT_SAVINGS_TIME_CODE]
[--time_zone_daylight_savings_time_name TIME_ZONE_DAYLIGHT_SAVINGS_TIME_NAME]
[--time_zone_daylight_savings_utc_offset TIME_ZONE_DAYLIGHT_SAVINGS_UTC_OFFSET]
The ISO 8601 standard defines time zone offsets as a numerical value added to
a local time to convert it to Coordinated Universal Time (UTC), either as
+hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC.
For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00
means 8 hours behind UTC. The offset Z specifically signifies UTC.
options:
-h, --help show this help message and exit
--geometry GEOMETRY The geometry parameter is used to filter the results
by a specific geographic area. The value should be a
GeoJSON geometry object.
--id ID Time zone code. An NWIS time zone code.
--time_zone_name TIME_ZONE_NAME
Time zone name. An English name for a world time zone.
--time_zone_description TIME_ZONE_DESCRIPTION
Time zone description.
--time_zone_utc_offset TIME_ZONE_UTC_OFFSET
Coordinated Universal Time (UTC) offset time. The
number of hours offset from UTC time, in ISO format.
--time_zone_daylight_savings_time_code TIME_ZONE_DAYLIGHT_SAVINGS_TIME_CODE
Time zone Daylight Saving Time code.
--time_zone_daylight_savings_time_name TIME_ZONE_DAYLIGHT_SAVINGS_TIME_NAME
Time zone Daylight Saving Time name.
--time_zone_daylight_savings_utc_offset TIME_ZONE_DAYLIGHT_SAVINGS_UTC_OFFSET
Daylight Saving Time offset time. The number of hours
offset from UTC time when Daylight Saving Time is in
effect, in ISO format.
wdfn_read_normal_observations#
$ tsgettoolbox wdfn_read_normal_observations --help
usage: tsgettoolbox wdfn_read_normal_observations [-h]
[--parent_time_series_id PARENT_TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--parameter_code PARAMETER_CODE]
[--approval_status APPROVAL_STATUS]
[--country_code COUNTRY_CODE]
[--state_code STATE_CODE]
[--county_code COUNTY_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type_name SITE_TYPE_NAME]
[--computation_type COMPUTATION_TYPE]
[--start_date START_DATE]
[--end_date END_DATE]
[--next_token NEXT_TOKEN]
[--normal_type NORMAL_TYPE]
Day of year statistics Day of year statistics are calculated based on all
approved historic observations for a numeric day of the year. For example,
January 1, is day 1 of a calendar year and December 31 is day 365 of a non-
leap year. Day of year statistics represent the expected conditions for a
generic day of the year at a location based on approved historical
observations. Day of year statistics available include the daily mean of daily
means, daily maximum of daily means, daily median of daily means, daily
minimum of daily means, and daily percentiles of daily means based on the same
numeric day of the year in the period of record. Month of year statistics
Month of year statistics are calculated based on all approved historic
observations within a given month. For example, all October data ever
collected and approved at a monitoring location would be included in one set
of monthly statistics. Month of year statistics represent the expected
conditions for a generic month of the year at a location based on approved
historical observations. Month of year statistics available include monthly
mean of daily means, monthly median of daily means, monthly maximum of daily
means, monthly minimum of daily means, and monthly percentiles of daily means
based on the same month in the period of record.
options:
-h, --help show this help message and exit
--parent_time_series_id PARENT_TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint. The parent_time_series_id
returns statistics tied to a particular database entry
Accepts Multiple Values: Multiple USGS Parent Time
Series Identifiers can be specified Default Behavior:
If no parent time series identifier is supplied, then
all records matching the rest of the provided criteria
will be returned. Examples: Return statistics tied to
one particular database entry - &parent_time_series_id
=db020040c1b746c2a635f5a53a6bb904 Return statistics
tied to multiple database entries - &parent_time_serie
s_id=db020040c1b746c2a635f5a53a6bb9045&pare
nt_time_series_id=db020040c1b746c2a635f5a53a6bb904
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500). Each monitoring location has been
assigned a unique station number that places them in
downstream order Monitoring Location Identifiers can
be found using this period of record Accepts Multiple
Values: Multiple Monitoring Location Identifiers can
be specified Default Behavior: If a monitoring
location identifier is not supplied, then statistics
will be returned for all monitoring location
identifiers within the period of record Examples:
Return statistics from a single monitoring location -
&monitoring_location_id=USGS-01432160 Return
statistics from multiple monitoring locations -
&monitoring_location_id=USGS-
01432160&monitoring_location_id=USGS-01432161
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v0/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v0/collections/parame
ter-codes/items). Accepts Multiple Values: Multiple
USGS parameter codes can be specified Default
Behavior: If no USGS parameter code is specified, but
a Monitoring Location Identifier is supplied, then all
statistics and their parameter codes with a matching
monitoring location identifier will be returned. All
statistics within the period of record will be
returned if no parameter code or monitoring location
identifier are specified. Examples: Return statistics
from one matching USGS parameter code -
¶meter_code=00095 Return statistics from multiple
matching USGS parameter codes -
¶meter_code=00095¶meter_code=0009
--approval_status APPROVAL_STATUS
Whether to include approved and/or provisional
observations. At this time, only approved observations
are returned. Accepts Multiple Values:Multiple
approval_status values can be specified as separate
parameter-value pairs. Default Behavior: Approved
observations are included by default. Example: Only
include approved observations -
&approval_status=approved Available values: approved
--country_code COUNTRY_CODE
If one of country, county, or state code is supplied
then the other two arguments do not need to be
specified Accepts Multiple Values: Multiple Country
codes can be specified Default Behavior: US will be
specified by default. Examples: Return statics from
one country - &country_code=US Return statistics from
multiple countries - &country_code=US&country_code=CA
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98. Accepts Multiple Values:
Multiple State codes can be specified Default
Behavior: US:42 will be specified by default.
Examples: Return statistics from one state -
&state_code=US:42 Return statistics in multiple states
- &state_code=US:42&state_code=US:36
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v0/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v0/collection
s/counties/items). Accepts Multiple Values: Multiple
County codes can be specified Default Behavior:
US:42:103 will be specified by default. Examples:
Return statistics from one county -
&county_code=US:42:103 Return statistics from multiple
counties -
&county_code=US:42:103&county_code=US:42:105
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v0/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v0/collections/site-types/items). Accepts Multiple
Values: Multiple Site Type Codes can be specified
Default Behavior: If no Site Type code is specified,
statistics of all site types with the matching
Monitoring Location Identifier will be returned.
Examples: Return statistics with matching site type
code - &site_type_code=GW Return statistics with
matching site type codes -
&site_type_code=GW&site_type_code=ST
--site_type_name SITE_TYPE_NAME
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v0/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v0/collections/site-types/items). Accepts Multiple
Values: Multiple Site Type Names can be specified
Default Behavior: If no Site Type name is specified,
statistics of all site types with the matching
Monitoring Location Identifier will be returned
Examples: Return statistics with matching site type
name - &site_type_name=Well Return statistics with
multiple matching site type names -
&site_type_name=Well&site_type_name=Spring
--computation_type COMPUTATION_TYPE
Statistical computation method Accepts Multiple
Values: Multiple computation types can be specified
Default Behavior: All statistical computation types
are returned by default. Examples: Only return
arithmetic_mean calculations -
&computation_type=arithmetic_mean Only return maximum
calculations - &computation_type=maximum Only return
median calculations - &computation_type=median Only
return minimum calculations -
&computation_type=minimum Only return percentile
calculations - &computation_type=percentile Return
multiple calculations - &computation_type=arithmetic_m
ean&computation_type=median Available values :
arithmetic_mean, maximum, median, minimum, percentile
--start_date START_DATE
The logic is inclusive i.e it will also return records
that match the date Default Behavior: If an end date
is supplied, but no start date is supplied, then
statistics will be supplied for the entire period of
record ending with the end date. If an end date is not
supplied, but a start date is supplied then statistics
will be supplied for the period of record following
the start date. If no start or end date are supplied
then statistics will be supplied for the entire period
of record. Example: Return statistics starting on a
particular start date - &start_date=02-04
--end_date END_DATE The logic is inclusive i.e it will also return records
that match the date Default Behavior: If an end date
is supplied, but no start date is supplied, then
statistics will be supplied for the entire period of
record ending with the end date. If an end date is not
supplied, but a start date is supplied then statistics
will be supplied for the period of record following
the start date. If no start or end date are supplied
then statistics will be supplied for the entire period
of record. Example: Return statistics starting on a
particular start date - &end_date=03-04
--next_token NEXT_TOKEN
Randomly generated token value of numbers and digits
To get all pages, one is required to make continued
requests with the newly provided token until the last
resulting page where no nextToken is present Default
Behavior: Provided in the event of results exceeding
the default or specified page_size. Example: Returned
token for next set of results - A43kJRTn26nT46fyj4ug1A
--normal_type NORMAL_TYPE
Default Behavior: Defaults to 'DOY' It will filter the
results to one of the following normals: (DOY) for
day-of-year, (MOY) for month-of-year. Examples: Return
day-of-year statistics only - &normal_type=DOY Return
month-of-year statistics only - &normal_type=MOY
Available values : DOY, MOY
wdfn_read_interval_observations#
$ tsgettoolbox wdfn_read_interval_observations --help
usage: tsgettoolbox wdfn_read_interval_observations [-h]
[--parent_time_series_id PARENT_TIME_SERIES_ID]
[--monitoring_location_id MONITORING_LOCATION_ID]
[--monitoring_location_number MONITORING_LOCATION_NUMBER]
[--agency_code AGENCY_CODE]
[--parameter_code PARAMETER_CODE]
[--approval_status APPROVAL_STATUS]
[--country_code COUNTRY_CODE]
[--state_code STATE_CODE]
[--county_code COUNTY_CODE]
[--site_type_code SITE_TYPE_CODE]
[--site_type_name SITE_TYPE_NAME]
[--computation_type COMPUTATION_TYPE]
[--start_date START_DATE]
[--end_date END_DATE]
[--next_token NEXT_TOKEN]
[--interval_type INTERVAL_TYPE]
Monthly statistics Monthly statistics are calculated based on the approved
data for a specific month. These statistics are reported for each month of
each year available. For example, statistics would be available for June 1984.
Monthly statistics represent the conditions that existed for a specific month
when data was collected. Monthly statistics available include mean of daily
means, maximum of daily means, median of daily means, minimum of daily means,
and percentiles for of daily mean data for each specific month in the period
of record. Annual statistics Annual statistics are calculated based on yearly
records of approved data. Annual statistics are calculated for calendar years
(starting January 1) and water years (starting October 1). Annual statistics
represent the conditions that existed for a specific year (calendar or water)
when data was collected. Annual statistics available include mean of daily
means, maximum of daily means, median of daily means, minimum of daily means,
and percentiles of daily means for each specific year in the period of record.
options:
-h, --help show this help message and exit
--parent_time_series_id PARENT_TIME_SERIES_ID
A unique identifier representing a single time series.
This corresponds to the `id` field in the `time-
series-metadata` endpoint. The parent_time_series_id
returns statistics tied to a particular database entry
Accepts Multiple Values: Multiple USGS Parent Time
Series Identifiers can be specified Default Behavior:
If no parent time series identifier is supplied, then
all records matching the rest of the provided criteria
will be returned. Examples: Return statistics tied to
one particular database entry - &parent_time_series_id
=db020040c1b746c2a635f5a53a6bb904 Return statistics
tied to multiple database entries - &parent_time_serie
s_id=db020040c1b746c2a635f5a53a6bb9045&pare
nt_time_series_id=db020040c1b746c2a635f5a53a6bb904
--monitoring_location_id MONITORING_LOCATION_ID
A unique identifier representing a single monitoring
location. This corresponds to the `id` field in the
`monitoring-locations` endpoint. Monitoring location
IDs are created by combining the agency code of the
agency responsible for the monitoring location (e.g.
USGS) with the ID number of the monitoring location
(e.g. 02238500), separated by a hyphen (e.g.
USGS-02238500). Each monitoring location has been
assigned a unique station number that places them in
downstream order Monitoring Location Identifiers can
be found using this period of record Accepts Multiple
Values: Multiple Monitoring Location Identifiers can
be specified Default Behavior: If a monitoring
location identifier is not supplied, then statistics
will be returned for all monitoring location
identifiers within the period of record Examples:
Return statistics from a single monitoring location -
&monitoring_location_id=USGS-01432160 Return
statistics from multiple monitoring locations -
&monitoring_location_id=USGS-
01432160&monitoring_location_id=USGS-01432161
--monitoring_location_number MONITORING_LOCATION_NUMBER
An identifier representing a single monitoring
location. This corresponds to the `number` field in
the `monitoring-locations` endpoint. Monitoring
location numbers (e.g. 02238500). Each monitoring
location has been assigned a unique station number
that places them in downstream order Monitoring
Location Numbers can be found using this period of
record Accepts Multiple Values: Multiple Monitoring
Location Numbers can be specified Default Behavior: If
a monitoring location number is not supplied, then
statistics will be returned for all monitoring
location numbers within the period of record Examples:
Return statistics from a single monitoring location -
&monitoring_location_number=01432160 Return statistics
from multiple monitoring locations - &monitoring_locat
ion_number=01432160&monitoring_location_numb
er=01432161
--agency_code AGENCY_CODE
The agency that is reporting the data. Agency codes
are fixed values assigned by the National Water
Information System (NWIS). A list of agency codes is
available at [https://api.waterdata.usgs.gov/ogcapi/v0
/collections/agency-codes/items](https://api.waterdata
.usgs.gov/ogcapi/v0/collections/agency-codes/items).
--parameter_code PARAMETER_CODE
Parameter codes are 5-digit codes used to identify the
constituent measured and the units of measure. A
complete list of parameter codes and associated
groupings can be found at [https://api.waterdata.usgs.
gov/ogcapi/v0/collections/parameter-codes/items](https
://api.waterdata.usgs.gov/ogcapi/v0/collections/parame
ter-codes/items). Accepts Multiple Values: Multiple
USGS parameter codes can be specified Default
Behavior: If no USGS parameter code is specified, but
a Monitoring Location Identifier is supplied, then all
statistics and their parameter codes with a matching
monitoring location identifier will be returned. All
statistics within the period of record will be
returned if no parameter code or monitoring location
identifier are specified. Examples: Return statistics
from one matching USGS parameter code -
¶meter_code=00095 Return statistics from multiple
matching USGS parameter codes -
¶meter_code=00095¶meter_code=0009
--approval_status APPROVAL_STATUS
Whether to include approved and/or provisional
observations. At this time, only approved observations
are returned. Accepts Multiple Values:Multiple
approval_status values can be specified as separate
parameter-value pairs. Default Behavior: Approved
observations are included by default. Example: Only
include approved observations -
&approval_status=approved Available values: approved
--country_code COUNTRY_CODE
If one of country, county, or state code is supplied
then the other two arguments do not need to be
specified Accepts Multiple Values: Multiple Country
codes can be specified Default Behavior: US will be
specified by default. Examples: Return statics from
one country - &country_code=US Return statistics from
multiple countries - &country_code=US&country_code=CA
--state_code STATE_CODE
State code. A [two-digit ANSI code](https://www2.censu
s.gov/geo/docs/reference/state.txt) (formerly FIPS
code) as defined by the American National Standards
Institute, to define States and equivalents. A three-
digit ANSI code is used to define counties and county
equivalents. [A lookup table is available.](https://ww
w.census.gov/library/reference/code-
lists/ansi.html#states) The only countries with
political subdivisions other than the US are Mexico
and Canada. The Mexican states have US state codes
ranging from 81-86 and Canadian provinces have state
codes ranging from 90-98. Accepts Multiple Values:
Multiple State codes can be specified Default
Behavior: US:42 will be specified by default.
Examples: Return statistics from one state -
&state_code=US:42 Return statistics in multiple states
- &state_code=US:42&state_code=US:36
--county_code COUNTY_CODE
The code for the county or county equivalent (parish,
borough, etc.) in which the monitoring location is
located. A list of codes is available at [https://api.
waterdata.usgs.gov/ogcapi/v0/collections/counties/item
s](https://api.waterdata.usgs.gov/ogcapi/v0/collection
s/counties/items). Accepts Multiple Values: Multiple
County codes can be specified Default Behavior:
US:42:103 will be specified by default. Examples:
Return statistics from one county -
&county_code=US:42:103 Return statistics from multiple
counties -
&county_code=US:42:103&county_code=US:42:105
--site_type_code SITE_TYPE_CODE
A code describing the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v0/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v0/collections/site-types/items). Accepts Multiple
Values: Multiple Site Type Codes can be specified
Default Behavior: If no Site Type code is specified,
statistics of all site types with the matching
Monitoring Location Identifier will be returned.
Examples: Return statistics with matching site type
code - &site_type_code=GW Return statistics with
matching site type codes -
&site_type_code=GW&site_type_code=ST
--site_type_name SITE_TYPE_NAME
A description of the hydrologic setting of the
monitoring location. A list of codes is available at [
https://api.waterdata.usgs.gov/ogcapi/v0/collections/s
ite-types/items](https://api.waterdata.usgs.gov/ogcapi
/v0/collections/site-types/items). Accepts Multiple
Values: Multiple Site Type Names can be specified
Default Behavior: If no Site Type name is specified,
statistics of all site types with the matching
Monitoring Location Identifier will be returned
Examples: Return statistics with matching site type
name - &site_type_name=Well Return statistics with
multiple matching site type names -
&site_type_name=Well&site_type_name=Spring
--computation_type COMPUTATION_TYPE
Statistical computation method Accepts Multiple
Values: Multiple computation types can be specified
Default Behavior: All statistical computation types
are returned by default. Examples: Only return
arithmetic_mean calculations -
&computation_type=arithmetic_mean Only return maximum
calculations - &computation_type=maximum Only return
median calculations - &computation_type=median Only
return minimum calculations -
&computation_type=minimum Only return percentile
calculations - &computation_type=percentile Return
multiple calculations - &computation_type=arithmetic_m
ean&computation_type=median Available values :
arithmetic_mean, maximum, median, minimum, percentile
--start_date START_DATE
The logic is inclusive i.e it will also return records
that match the date Default Behavior: If an end date
is supplied, but no start date is supplied, then
statistics will be supplied for the entire period of
record ending with the end date. If an end date is not
supplied, but a start date is supplied then statistics
will be supplied for the period of record following
the start date. If no start or end date are supplied
then statistics will be supplied for the entire period
of record. Example: Return statistics starting on a
particular start date - &start_date=02-04
--end_date END_DATE The logic is inclusive i.e it will also return records
that match the date Default Behavior: If an end date
is supplied, but no start date is supplied, then
statistics will be supplied for the entire period of
record ending with the end date. If an end date is not
supplied, but a start date is supplied then statistics
will be supplied for the period of record following
the start date. If no start or end date are supplied
then statistics will be supplied for the entire period
of record. Example: Return statistics starting on a
particular start date - &end_date=03-04
--next_token NEXT_TOKEN
Randomly generated token value of numbers and digits
To get all pages, one is required to make continued
requests with the newly provided token until the last
resulting page where no nextToken is present Default
Behavior: Provided in the event of results exceeding
the default or specified page_size. Example: Returned
token for next set of results - A43kJRTn26nT46fyj4ug1A
--interval_type INTERVAL_TYPE
Default Behavior: Defaults to 'M' Filters the results
to one of the following intervals: M for month, CY for
calendar year, WY for water year Examples: Return
month interval - &interval_type=M Return calendar year
interval - &interval_type=CY Return water year
interval - &interval_type=WY Available values : M, CY,
WY
about#
$ tsgettoolbox about --help
usage: tsgettoolbox about [-h]
Print out information about tsgettoolbox and the system.
options:
-h, --help show this help message and exit