more documentation standardization (#47)

simplify GOT and FES inputs to be similar to OTIS

output constituent IDs from GOT read program

Author: tsutterley

doc/source/user_guide/bilinear_interp.md

@@ -10,16 +10,16 @@ data = bilinear_interp(ilon,ilat,idata,lon,lat)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/bilinear_interp.py)
 
-#### Inputs
+#### Arguments
  1. `ilon`: longitude of tidal model
  2. `ilat`: latitude of tidal model
  3. `idata`: tide model data
  4. `lon`: output longitude
  5. `lat`: output latitude
 
-#### Options
+#### Keyword arguments
  - `fill_value`: invalid value
  - `dtype`: output data type
 
-#### Outputs
+#### Returns
  - `data`: interpolated data

doc/source/user_guide/calc_astrol_longitudes.md

@@ -12,14 +12,14 @@ s,h,p,N,PP = calc_astrol_longitudes(MJD, ASTRO5=True)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/calc_astrol_longitudes.py)
 
-#### Inputs
+#### Arguments
  1. `MJD`: Modified Julian Day of input date
 
-#### Options
+#### Keyword arguments
  - `MEEUS`: use additional coefficients from Meeus Astronomical Algorithms
  - `ASTRO5`: use Meeus Astronomical coefficients as implemented in ASTRO5
 
-#### Outputs
+#### Returns
  - `s`: mean longitude of moon (degrees)
  - `h`: mean longitude of sun (degrees)
  - `p`: mean longitude of lunar perigee (degrees)

doc/source/user_guide/calc_delta_time.md

@@ -10,11 +10,11 @@ deltat = calc_delta_time(delta_file, idays)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/calc_delta_time.py)
 
-#### Inputs
- 1. `delta_file`:  
-    - http://maia.usno.navy.mil/ser7/deltat.data  
-    - ftp://cddis.nasa.gov/products/iers/deltat.data  
- 2. `idays`: times to interpolate as days since 1992-01-01T00:00:00  
+#### Arguments
+ 1. `delta_file`:
+    - http://maia.usno.navy.mil/ser7/deltat.data
+    - ftp://cddis.nasa.gov/products/iers/deltat.data
+ 2. `idays`: times to interpolate as days since 1992-01-01T00:00:00
 
-#### Outputs
+#### Returns
  - `deltat`: (TT - UT1) in days

doc/source/user_guide/compute_equilibrium_tide.md

@@ -2,7 +2,7 @@ compute_equilibrium_tide.py
 ===========================
 
  - Calculates the long-period equilibrium ocean tides using fifteen spectral lines from Cartwright-Tayler-Edden tables
- - Can be used to calculate tidal corrections for imagery  
+ - Can be used to calculate tidal corrections for imagery
 
 #### Calling Sequence
 ```python
@@ -11,9 +11,9 @@ lpet = compute_equilibrium_tide(time,lat)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/compute_equilibrium_tide.py)
 
-#### Inputs
+#### Arguments
  1. `t`: days relative to Jan 1, 1992 (48622mjd)
  2. `lat`: latitudes in degrees
 
-#### Outputs
+#### Returns
  - `lpet`: long-period equilibrium tide values

doc/source/user_guide/compute_tide_corrections.md

@@ -14,12 +14,12 @@ tide = compute_tide_corrections(x, y, delta_time, DIRECTORY=DIRECTORY,
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/compute_tide_corrections.py)
 
-#### Inputs
+#### Arguments
  1. `x`: x-coordinates in projection EPSG
  2. `y`: y-coordinates in projection EPSG
  3. `delta_time`: seconds since EPOCH
 
-#### Options
+#### Keyword arguments
  - `DIRECTORY`: working data directory for tide models
  - `MODEL`: Tide model to use in correction
  - `EPOCH`: time period for calculating delta times
@@ -40,5 +40,5 @@ tide = compute_tide_corrections(x, y, delta_time, DIRECTORY=DIRECTORY,
  - `EXTRAPOLATE`: Extrapolate with nearest-neighbors
  - `FILL_VALUE`: output invalid value
 
-#### Outputs
+#### Returns
  - `tide`: tide height correction reconstructed using the nodal corrections

doc/source/user_guide/convert_ll_xy.md

@@ -11,15 +11,15 @@ lon,lat = convert_ll_xy(x,y,PROJ,'B')
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/convert_ll_xy.py)
 
-#### Inputs
+#### Arguments
  1. `i1`: longitude ('F') or projection easting x ('B')
  2. `i2`: latitude ('F') or projection northing y ('B')
  3. `PROJ`: spatial reference system code for coordinate transformations
  4. `BF`: backwards ('B') or forward ('F') translations
 
-#### Options
+#### Keyword arguments
  - `EPSG`: spatial reference system code for input (F) and output (B) coordinates
 
-#### Outputs
+#### Returns
  - `o1`: projection easting x ('F') or longitude ('B')
  - `o2`: projection northing y ('F') or latitude ('B')

doc/source/user_guide/iers_mean_pole.md

@@ -12,15 +12,15 @@ x,y,flag = iers_mean_pole(input_file,input_epoch,version,FILL_VALUE=FILL_VALUE)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/iers_mean_pole.py)
 
-#### Inputs
+#### Arguments
  1. `input_file`: full path to mean-pole.tab file provided by IERS
- 2. `input_epoch`: dates for which the angular coordinates of the Conventional Mean Pole are desired in decimal years  
+ 2. `input_epoch`: dates for which the angular coordinates of the Conventional Mean Pole are desired in decimal years
  3. `version`: Year of the conventional model (2003, 2010, 2015)
 
-#### Options
+#### Keyword arguments
  - `FILL_VALUE`: value for invalid flags
 
-#### Outputs
+#### Returns
  - `x`: Angular coordinate x of conventional mean pole [arcsec]
  - `y`: Angular coordinate y of conventional mean pole [arcsec]
  - `flag`: epoch is valid for version and version number is valid

doc/source/user_guide/infer_minor_corrections.md

@@ -12,14 +12,14 @@ dh = infer_minor_corrections(t, zmajor, constituents,
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/infer_minor_corrections.py)
 
-#### Inputs
+#### Arguments
  1. `t`: days relative to Jan 1, 1992 (48622mjd)
  2. `zmajor`: Complex oscillations for given constituents/points
  3. `constituents`: tidal constituent IDs
 
-#### Options
+#### Keyword arguments
  - `DELTAT`: time correction for converting to Ephemeris Time (days)
  - `CORRECTIONS`: use nodal corrections from OTIS/ATLAS or GOT models
 
-#### Outputs
+#### Returns
  - `dh`: height from minor constituents

doc/source/user_guide/load_constituent.md

@@ -10,10 +10,10 @@ amplitude,phase,omega,alpha,species = load_constituent(c)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/load_constituent.py)
 
-#### Inputs
+#### Arguments
  1. `c`: tidal constituent IDs
 
-#### Outputs
+#### Returns
  - `amplitude`: amplitude of equilibrium tide in m for tidal constituent
  - `phase`: phase of tidal constituent
  - `omega`: angular frequency of constituent in radians

doc/source/user_guide/load_nodal_corrections.md

@@ -11,11 +11,11 @@ pu,pf,G = load_nodal_corrections(MJD,constituents)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/load_nodal_corrections.py)
 
-#### Inputs
+#### Arguments
  1. `MJD`: Modified Julian Day of input date
  2. `zmajor`: Complex oscillations for given constituents/points
  3. `constituents`: tidal constituent IDs
 
-#### Outputs
+#### Returns
  -  `pu`,`pf`: nodal corrections for the constituents
  - `G`: phase correction in degrees

doc/source/user_guide/nearest_extrap.md

@@ -10,18 +10,18 @@ data = nearest_extrap(ilon,ilat,idata,lon,lat)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/nearest_extrap.py)
 
-#### Inputs
+#### Arguments
  1. `ilon`: longitude of tidal model
  2. `ilat`: latitude of tidal model
  3. `idata`: tide model data
  4. `lon`: output longitude
  5. `lat`: output latitude
 
-#### Options
+#### Keyword arguments
  - `fill_value`: invalid value
  - `dtype`: output data type
  - `cutoff`: return only neighbors within distance in kilometers
  - `EPSG`: projection of tide model data
 
-#### Outputs
+#### Returns
  - `data`: interpolated data

doc/source/user_guide/output_otis_tides.md

@@ -13,7 +13,7 @@ output_otis_transport(transport_file,u,v,xlim,ylim,constituents)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/output_otis_tides.py)
 
-#### Inputs
+#### Arguments
  - `output_otis_grid()`
     1. `grid_file`: output OTIS grid file name
     2. `xlim`: x-coordinate grid-cell edges of output grid

doc/source/user_guide/predict_tidal_ts.md

@@ -2,7 +2,7 @@ predict_tidal_ts.py
 ===================
 
  - Predict tidal time series at a location using harmonic constants
- - Can be used to calculate errors as compared to tide gauges or to predict tides at a point  
+ - Can be used to calculate errors as compared to tide gauges or to predict tides at a point
 
 #### Calling Sequence
 ```python
@@ -11,14 +11,14 @@ ht = predict_tidal_ts(time,hc,con)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/predict_tidal_ts.py)
 
-#### Inputs
+#### Arguments
  1. `time`: days relative to Jan 1, 1992 (48622mjd)
  2. `hc`: harmonic constant vector (complex)
  3. `constituents`: tidal constituent IDs
 
-#### Options
+#### Keyword arguments
  - `DELTAT`: time correction for converting to Ephemeris Time (days)
  - `CORRECTIONS`: use nodal corrections from OTIS/ATLAS or GOT models
 
-#### Outputs
+#### Returns
  - `ht`: time series reconstructed using the nodal corrections

doc/source/user_guide/predict_tide.md

@@ -2,7 +2,7 @@ predict_tide.py
 ===============
 
  - Predict tides at a single time using harmonic constants
- - Can be used to calculate tidal corrections for imagery  
+ - Can be used to calculate tidal corrections for imagery
 
 #### Calling Sequence
 ```python
@@ -11,14 +11,14 @@ ht = predict_tide(time,hc,con)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/predict_tide.py)
 
-#### Inputs
+#### Arguments
  1. `time`: days relative to Jan 1, 1992 (48622mjd)
  2. `hc`: harmonic constant vector (complex)
  3. `constituents`: tidal constituent IDs
 
-#### Options
+#### Keyword arguments
  - `DELTAT`: time correction for converting to Ephemeris Time (days)
  - `CORRECTIONS`: use nodal corrections from OTIS/ATLAS or GOT models
 
-#### Outputs
+#### Returns
  - `ht`: tide values reconstructed using the nodal corrections

doc/source/user_guide/predict_tide_drift.md

@@ -1,8 +1,8 @@
 predict_tide_drift.py
 ===============
 
- - Predict tides at multiple times and locations using harmonic constants  
- - Can be used to calculate tidal corrections for airborne and satellite altimetry  
+ - Predict tides at multiple times and locations using harmonic constants
+ - Can be used to calculate tidal corrections for airborne and satellite altimetry
 
 #### Calling Sequence
 ```python
@@ -11,14 +11,14 @@ ht = predict_tide_drift(time,hc,con)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/predict_tide_drift.py)
 
-#### Inputs
+#### Arguments
  1. `time`: days relative to Jan 1, 1992 (48622mjd)
  2. `hc`: harmonic constant vector (complex)
  3. `constituents`: tidal constituent IDs
 
-#### Options
+#### Keyword arguments
  - `DELTAT`: time correction for converting to Ephemeris Time (days)
  - `CORRECTIONS`: use nodal corrections from OTIS/ATLAS or GOT models
 
-#### Outputs
+#### Returns
  - `ht`: time series reconstructed using the nodal corrections

doc/source/user_guide/read_FES_model.md

@@ -9,18 +9,17 @@ read_FES_model.py
 #### Calling Sequence
 ```python
 from pyTMD.read_FES_model import read_FES_model
-amp,ph = read_FES_model(ilon,ilat,directory,model_files,TYPE='z',
+amp,ph = read_FES_model(ilon, ilat, model_files, TYPE='z',
     VERSION=version,METHOD='spline',GZIP=True,SCALE=1.0/100.0)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/read_FES_model.py)
 
-#### Inputs
+#### Arguments
   1. `ilon`: longitude to interpolate
   2. `ilat`: latitude to interpolate
-  3. `directory`: data directory for tide data files
-  4. `model_files`: list of model files for each constituent
+  3. `model_files`: list of model files for each constituent
 
-#### Options
+#### Keyword arguments
 - `TYPE`: tidal variable to read
    * `'z'`: heights
    * `'u'`: horizontal transport velocities
@@ -37,6 +36,6 @@ amp,ph = read_FES_model(ilon,ilat,directory,model_files,TYPE='z',
  - `GZIP`: input files are compressed
  - `SCALE`: scaling factor for converting to output units
 
-#### Outputs
+#### Returns
 - `amplitude`: amplitudes of tidal constituents
 - `phase`: phases of tidal constituents

doc/source/user_guide/read_GOT_model.md

@@ -1,30 +1,30 @@
 read_GOT_model.py
 =================
 
- - Reads files for Richard Ray's Global Ocean Tide (GOT) models  
- - Spatially interpolates tidal constituents to input coordinates  
+ - Reads files for Richard Ray's Global Ocean Tide (GOT) models
+ - Spatially interpolates tidal constituents to input coordinates
 
 #### Calling Sequence
 ```python
 from pyTMD.read_GOT_model import read_GOT_model
-amp,ph = read_GOT_model(ilon,ilat,directory,model_files,METHOD='spline')
+amp,ph,c = read_GOT_model(ilon,ilat,model_files,METHOD='spline')
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/read_GOT_model.py)
 
-#### Inputs
+#### Arguments
   1. `ilon`: longitude to interpolate
   2. `ilat`: latitude to interpolate
-  3. `directory`: data directory for tide data files
-  4. `model_files`: list of model files for each constituent
+  3. `model_files`: list of model files for each constituent
 
-#### Options
+#### Keyword arguments
  - `METHOD`: interpolation method
     * `'bilinear'`: quick bilinear interpolation
     * `'spline'`: scipy bivariate spline interpolation
     * `'linear'`, `'nearest'`: scipy regular grid interpolations
  - `GZIP`: input files are compressed
  - `SCALE`: scaling factor for converting to output units
 
-#### Outputs
+#### Returns
 - `amplitude`: amplitudes of tidal constituents
 - `phase`: phases of tidal constituents
+- `constituents`: list of model constituents

doc/source/user_guide/read_iers_EOP.md

@@ -1,8 +1,8 @@
 read_iers_EOP.py
 ================
 
- - Provides the [daily earth orientation parameters (EOP) from IERS](http://www.usno.navy.mil/USNO/earth-orientation/eo-products/weekly)  
- - Data format: http://maia.usno.navy.mil/ser7/readme.finals  
+ - Provides the [daily earth orientation parameters (EOP) from IERS](http://www.usno.navy.mil/USNO/earth-orientation/eo-products/weekly)
+ - Data format: http://maia.usno.navy.mil/ser7/readme.finals
 
 #### Calling Sequence
 ```python
@@ -11,10 +11,10 @@ MJD,x,y,flag = read_iers_EOP(input_file)
 ```
 [Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/read_iers_EOP.py)
 
-#### Inputs
+#### Arguments
  1. `input_file`:  full path to IERS EOP "finals" file
 
-#### Outputs
+#### Returns
  - `MJD`: modified Julian date of EOP measurements
  - `x`: Angular coordinate [arcsec]
  - `y`: Angular coordinate [arcsec]