Command Line¶
Help:
tappy --help
analysis¶
$ tappy analysis --help
usage: tappy analysis [-h] [--def_filename DEF_FILENAME] [--quiet] [--debug]
[--outputts] [--outputxml OUTPUTXML] [--ephemeris]
[--rayleigh RAYLEIGH] [--print_vau_table]
[--missing_data MISSING_DATA] [--linear_trend]
[--remove_extreme] [--zero_ts ZERO_TS] [--filter FILTER]
[--pad_filters PAD_FILTERS] [--include_inferred]
[--xmlname XMLNAME] [--xmlcountry XMLCOUNTRY]
[--xmllatitude XMLLATITUDE]
[--xmllongitude XMLLONGITUDE]
[--xmltimezone XMLTIMEZONE] [--xmlcomments XMLCOMMENTS]
[--xmlunits XMLUNITS]
[--xmldecimalplaces XMLDECIMALPLACES]
data_filename
Constituent amplitude units are the same as the input heights. Constituent
phases are based in the same time zone as the dates.
positional arguments:
data_filename The time-series of elevations to be analyzed. Can be a
file name that is parsed with a companion definition
file or a CSV, WDM, HDF5, or XLSX file. The options
for each file type are listed in "tstoolbox read
--help" on the command line or "help(tstoolbox.read)
in Python.
options:
-h, --help show this help message and exit
--def_filename DEF_FILENAME
Contains the definition string to parse the input
data.
--quiet Print nothing to the screen.
--debug Print debug messages.
--outputts Output time series for each constituent.
--outputxml OUTPUTXML
File name to output constituents as IHOTC XML format.
--ephemeris Print out ephemeris tables.
--rayleigh RAYLEIGH The Rayleigh coefficient is used to compare against to
determine time series length to differentiate between
two frequencies. [default: default]
--print_vau_table For debugging - will print a table of V and u values
to compare against Schureman.
--missing_data MISSING_DATA
What should be done if there is missing data. One of:
fail, ignore, or fill. [default: default]
--linear_trend Include a linear trend in the least squares fit.
--remove_extreme Remove values outside of 2 standard deviations before
analysis.
--zero_ts ZERO_TS Zero the input time series before constituent analysis
by subtracting filtered data. One of:
transform,usgs,doodson,boxcar
--filter FILTER Filter input data set with tide elimination filters.
The -o outputts option is implied. Any mix separated
by commas and no spaces: transform,usgs,doodson,boxcar
--pad_filters PAD_FILTERS
Pad input data set with values to return same size
after filtering. Realize edge effects are unavoidable.
One of ["tide", "minimum", "maximum", "mean",
"median", "reflect", "wrap"]
--include_inferred Do not incorporate any inferred constituents into the
least squares fit.
--xmlname XMLNAME Not used in analysis. Used ONLY to complete the XML
file. Name of the station supplying the observations.
[default: A port in a storm]
--xmlcountry XMLCOUNTRY
Not used in analysis. Used ONLY to complete the XML
file. Name of the country containing the station.
Defaults to 'A man without a country'.
--xmllatitude XMLLATITUDE
Not used in analysis. Used ONLY to complete the XML
file. Latitude of the station. Defaults to 0.0.
--xmllongitude XMLLONGITUDE
Not used in analysis. Used ONLY to complete the XML
file. Longitude of the station. Defaults to 0.0.
--xmltimezone XMLTIMEZONE
Not used in analysis. Used ONLY to complete the XML
file. Time zone of the station. Defaults to '0000'.
--xmlcomments XMLCOMMENTS
Not used in analysis. Used ONLY to complete the XML
file. Station comments. Defaults to 'No comment'.
--xmlunits XMLUNITS Not used in analysis. Used ONLY to complete the XML
file. Units of the observed water level. Defaults to
'm'.
--xmldecimalplaces XMLDECIMALPLACES
Not used in analysis. Used ONLY to complete the XML
file. Format of the observed amplitude and phase.
Default depends on length of analysis record. 'full'
is the default and means that full accuracy, 'ihotc'
is formatted according to IHOTC standard which severly
limits the number of decimal places, and if an integer
number lists the number of decimal places.
prediction¶
$ tappy prediction --help
usage: tappy prediction [-h] [--include_inferred] [--fname FNAME]
xml_filename start_date end_date interval
Prediction based upon earlier constituent analysis saved in IHOTC XML transfer
format.
positional arguments:
xml_filename The tidal constituents in IHOTC XML transfer format.
start_date The start date as a ISO 8601 string.
'2010-01-01T00:00:00'
end_date The end date as a ISO 8601 string.
'2011-01-01T00:00:00:00'
interval The interval as the number of minutes.
options:
-h, --help show this help message and exit
--include_inferred Include the inferred constituents.
--fname FNAME Output filename, default is '-' to print to screen.
