.\" Man page generated from reStructuredText.
.
.TH "EARTHTIDE" "1gmt" "Sep 07, 2019" "6.0.0rc4" "GMT"
.SH NAME
earthtide \- Compute grids or time-series of solid Earth tides
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBgmt earthtide\fP
 \fB\-T\fP[\fImin/max\fP/]\fIinc\fP[\fB+n\fP] | \fB\-T\fP\fIfile\fP|\fIlist\fP
 \fB\-G\fP\fIgrdfile\fP
[  \fB\-C\fP\fIx|e,y|n,z|v\fP ]
[  \fB\-I\fP\fIincrement\fP ]
[  \fB\-L\fP\fIlon/lat\fP ]
[  \fB\-R\fP\fIregion\fP ]
[  \fB\-S\fP ]
[  \fB\-V\fP[\fIlevel\fP] ]
[ \fB\-r\fPreg ]
[ \fB\-\-PAR\fP=\fIvalue\fP ]
.sp
\fBNote:\fP No space is allowed between the option flag and the associated arguments.
.SH DESCRIPTION
.sp
Compute the three components of solid Earth tides as time\-series or grids. Optionally compute also Sun and Moon position in lon,lat.
The output can be either in the form of a grid or as a table printed to stdout. The format of the table data is:
\fItime north east vertical\fP in units of meters.
.SH REQUIRED ARGUMENTS
.sp
Either \fB\-G\fP, \fB\-S\fP or \fB\-L\fP
.INDENT 0.0
.TP
\fB\-G\fP\fIgrdfile\fP
Write one or more tide component directly to grids; no table data are written to standard output.
If more than one component are specified via \fB\-C\fP then \fIgrdfile\fP must contain the format flag %s
so that we can embed the component code in the file names (\fIn\fP for north; \fIe\fP for east and \fIv\fP for vertical).
If only one component is selected with \fB\-C\fP than no code is appended to grid name (an no need to
set the format flag %s). The grid(s) are computed at the time set by \fB\-T\fP, if that option is used, or
at the \fInow\fP time calculated in UTC from the computer clock.
.UNINDENT
.INDENT 0.0
.TP
\fB\-S\fP
Output position of Sun and Moon in geographical coordinates plus distance
in meters. Output is a Mx7 matrix where M is the number of times (set by \-T)
and columns are time, sun_lon, sun_lat, sun_dist moon_lon, moon_lat, moon_dist
.UNINDENT
.INDENT 0.0
.TP
\fB\-L\fP\fIlon/lat\fP
Geographical coordinate of the location where to compute a time\-series. Coordinates are geodetic (ellipsoidal)
latitude and longitude. GRS80 ellipsoid is used. (Which can be considered equivalent to the WGS84 ellipsoid at
the sub\-millimeter level.)
.UNINDENT
.SH OPTIONAL ARGUMENTS
.INDENT 0.0
.TP
\fB\-C\fP\fIx|e,y|n,z|v\fP
Select which component to write to individual grids. Requires \fB\-G\fP\&.
Append comma\-separated codes for available components: \fBx\fP or \fBe\fP for the east component;
\fBy\fP or \fBn\fP for the north component; and \fBz\fP or \fBv\fP for the vertical component.
For example, \fB\-C\fP\fIe,v\fP, will write 2 grids. One with east and other with the vertical components.
If \fB\-G\fP is set but not \fB\-C\fP then the default is to write the vertical component.
.UNINDENT
.INDENT 0.0
.TP
\fB\-I\fP\fIxinc\fP[\fIunit\fP][\fB+e\fP|\fBn\fP][/\fIyinc\fP[\fIunit\fP][\fB+e\fP|\fBn\fP]]
\fIx_inc\fP [and optionally \fIy_inc\fP] is the grid spacing. Optionally,
append a suffix modifier. \fBGeographical (degrees) coordinates\fP: Append
\fBm\fP to indicate arc minutes or \fBs\fP to indicate arc seconds. If one
of the units \fBe\fP, \fBf\fP, \fBk\fP, \fBM\fP, \fBn\fP or \fBu\fP is appended
instead, the increment is assumed to be given in meter, foot, km, Mile,
nautical mile or US survey foot, respectively, and will be converted to
the equivalent degrees longitude at the middle latitude of the region
(the conversion depends on PROJ_ELLIPSOID). If \fIy_inc\fP is given
but set to 0 it will be reset equal to \fIx_inc\fP; otherwise it will be
converted to degrees latitude. \fBAll coordinates\fP: If \fB+e\fP is appended
then the corresponding max \fIx\fP (\fIeast\fP) or \fIy\fP (\fInorth\fP) may be slightly
adjusted to fit exactly the given increment [by default the increment
may be adjusted slightly to fit the given domain]. Finally, instead of
giving an increment you may specify the \fInumber of nodes\fP desired by
appending \fB+n\fP to the supplied integer argument; the increment is then
recalculated from the number of nodes and the domain. The resulting
increment value depends on whether you have selected a
gridline\-registered or pixel\-registered grid; see App\-file\-formats for
details. Note: if \fB\-R\fP\fIgrdfile\fP is used then the grid spacing has
already been initialized; use \fB\-I\fP to override the values.
.UNINDENT
.INDENT 0.0
.TP
\fB\-R\fP\fIxmin\fP/\fIxmax\fP/\fIymin\fP/\fIymax\fP[\fB+r\fP][\fB+u\fP\fIunit\fP] (more ...)
Specify the region of interest. Used only with \fB\-G\fP\&. If not set, defaults to \fB\-Rd\fP
.UNINDENT
.INDENT 0.0
.TP
\fB\-T\fP[\fImin/max\fP/]\fIinc\fP[\fB+n\fP] | \fB\-T\fP\fIfile\fP|\fIlist\fP
Make evenly spaced time\-steps from \fImin\fP to \fImax\fP by \fIinc\fP\&. Append +n to indicate \fIinc\fP is the number of t\-values
to produce over the range instead. Append a valid time unit (d|h|m|s) to the increment. If only \fImin\fP is given then
we use that date and time for the calculations.  If no \fB\-T\fP is provided get
current time in UTC from the computer clock. If no \fB\-G\fP or \fB\-S\fP are provided then \fB\-T\fP is interpreted to mean compute
a time\-series at the location specified by \fB\-L\fP, thus then \fB\-L\fP becomes mandatory.
When \fB\-G\fP and \fB\-T\fP, only first time T series is considered. Finally, dates may range from 1901 through 2099.
.UNINDENT
.INDENT 0.0
.TP
\fB\-bo\fP[\fIncols\fP][\fItype\fP] (more ...)
Select native binary output.  
.UNINDENT
.INDENT 0.0
.TP
\fB\-o\fP\fIcols\fP[,...][\fIt\fP[\fIword\fP]] (more ...)
Select output columns (0 is first column; \fIt\fP is trailing text, append \fIword\fP to write one word only).
.UNINDENT
.INDENT 0.0
.TP
\fB\-r\fP (more ...)
Set node registration [gridline].  
.UNINDENT
.INDENT 0.0
.TP
\fB\-V\fP[\fIlevel\fP] (more ...)
Select verbosity level [c].  
.UNINDENT
.INDENT 0.0
.TP
\fB\-^\fP or just \fB\-\fP
Print a short message about the syntax of the command, then exits (NOTE: on Windows just use \fB\-\fP).
.TP
\fB\-+\fP or just \fB+\fP
Print an extensive usage (help) message, including the explanation of
any module\-specific option (but not the GMT common options), then exits.
.TP
\fB\-?\fP or no arguments
Print a complete usage (help) message, including the explanation of all options, then exits.
.TP
\fB\-\-PAR\fP=\fIvalue\fP
Temporarily override a GMT default setting; repeatable. See /gmt.conf for parameters.
.UNINDENT
.SH EXAMPLES
.sp
To compute a global grid of the vertical component with a grid step of 30m at noon of 18 Jun 2018,
(note: we are using the defaults for \fB\-R\fP and \fB\-I\fP) try
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt earthtide \-T2018\-06\-18T12:00:00 \-Gsolid_tide_up.grd
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To obtain a one day long time\-series, starting at same date, at the \-7 \fIW\fP, 37 \fIN\fP and 1 minute interval, try
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt earthtide \-T2018\-06\-18T/2018\-06\-19T/1m \-L\-7/37 > solid_tide.dat
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The get the Sun and Moon position in geographical coordinates at the \fInow\fP time
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
gmt earthtide \-S
.ft P
.fi
.UNINDENT
.UNINDENT
.SH NOTES
.INDENT 0.0
.IP 1. 3
All times, both input and output, are in UTC.
.UNINDENT
.SH REFERENCES
.sp
\fI\%http://geodesyworld.github.io/SOFTS/solid.htm\fP
.SH SEE ALSO
.sp
gmt.conf, gmt,
.SH COPYRIGHT
2019, The GMT Team
.\" Generated by docutils manpage writer.
.