documentation

Function header documentation edits to address Issue #19.

tmd_InferMinor.m

@@ -1,7 +1,9 @@
 function dh = tmd_InferMinor(hc,constituents,t,s,h,p,N)
-% tmd_InferMinor returns correction for 16 minor tidal constiuents. Zeros 
+% tmd_InferMinor returns correction for 16 minor tidal constituents. Zeros 
 % are returned if not enough input for inference. This is based on Richard
-% Ray's code perth2. 
+% Ray's code perth2. For further description, see Ray, Richard D. "Global 
+% ocean tide models on the eve of TOPEX/POSEIDON." IEEE transactions on 
+% Geoscience and Remote Sensing 31.2 (1993): 355-364.
 % 
 %% Syntax
 % 

tmd_astrol.m

@@ -48,7 +48,7 @@
 
 t_mjd = t - datenum(1992,1,1) + 48622;
 
-% Convert time from UTC in decimal MJD to ???
+% Convert time:
 T = t_mjd - 51544.4993;
 
 % Mean longitude of moon:

tmd_harp.m

@@ -9,7 +9,7 @@
 %% Description 
 % 
 % hhat = tmd_harp(t,hc,constituents,p,N) returns the time series hhat, which is
-% the sum of tidal constituents given by hc for times t.
+% the sum of tidal constituents given by hc for times t and has the units of hc.
 % 
 % Inputs:
 %    t:  time in Matlab's datenum format (size Tx1, where T is # of timesteps),

tmd_ll2ps.m

@@ -23,8 +23,8 @@
 %                                                                       
 %    Variable     I/O    Description                          
 %                                                                        
-%    lat           I     Geodetic Latitude (degrees, +90 to -90)
-%    lon           I     Geodetic Longitude (degrees, 0 to 360)
+%    lat           I     Geodetic Latitude (degrees, +90 to -90) Any input dimensions are allowed.  
+%    lon           I     Geodetic Longitude (degrees, 0 to 360) Any input dimensions are allowed.  
 %    SLAT          I     Standard latitude (typ. 71, or 70)
 %    SLON          I  
 %    HEMI          I     Hemisphere (char*1: 'N' or 'S' (not

tmd_nodal.m

@@ -15,7 +15,7 @@
 % as cell array (1xN constituents). Inputs p and N are the lunar perigee p 
 % and ascending lunar node N given by the tmd_astrol function, and are 
 % dimesnions Mx1, with one row per timestep. Nodal correction outputs pu,pf 
-% have units of radians and are are MxN dimensions, corresponding to M 
+% have units of radians and are MxN dimensions, corresponding to M 
 % timesteps and N constituents. 
 % 
 %% Author Info