documentation

Specifying phase units in the documentation in response to Issue #20.
chadagreene · Jan 8, 2024 · e599f8c · e599f8c
1 parent a3727af
commit e599f8c
Show file tree

Hide file tree

Showing 7 changed files with 198 additions and 52 deletions.
diff --git a/doc/html/tmd_data_documentation.html b/doc/html/tmd_data_documentation.html
@@ -136,7 +136,7 @@ <h2 id="2">Description</h2>
 <li>
 <tt>'hAm'</tt> amplitude of tidal height</li>
 <li>
-<tt>'hPh'</tt> phase of tidal height</li>
+<tt>'hPh'</tt> phase of tidal height (radians)</li>
 <li>
 <tt>'u'</tt> complex zonal velocity (m/s)</li>
 <li>
@@ -146,7 +146,7 @@ <h2 id="2">Description</h2>
 <li>
 <tt>'uAm'</tt> amplitude of zonal velocity</li>
 <li>
-<tt>'uPh'</tt> phase of zonal velocity</li>
+<tt>'uPh'</tt> phase of zonal velocity (radians)</li>
 <li>
 <tt>'U'</tt> complex zonal transport (m^2/s)</li>
 <li>
@@ -156,7 +156,7 @@ <h2 id="2">Description</h2>
 <li>
 <tt>'UAm'</tt> amplitude of zonal transport</li>
 <li>
-<tt>'UPh'</tt> phase of zonal transport</li>
+<tt>'UPh'</tt> phase of zonal transport (radians)</li>
 <li>
 <tt>'v'</tt> complex meridional velocity (m/s)</li>
 <li>
@@ -166,7 +166,7 @@ <h2 id="2">Description</h2>
 <li>
 <tt>'vAm'</tt> amplitude of meridional velocity</li>
 <li>
-<tt>'vPh'</tt> phase of meridional velocity</li>
+<tt>'vPh'</tt> phase of meridional velocity (radians)</li>
 <li>
 <tt>'V'</tt> complex meridional transport (m^2/s)</li>
 <li>
@@ -176,7 +176,7 @@ <h2 id="2">Description</h2>
 <li>
 <tt>'VAm'</tt> amplitude of meridional transport</li>
 <li>
-<tt>'VPh'</tt> phase of meridional transport</li>
+<tt>'VPh'</tt> phase of meridional transport (radians)</li>
 <li>
 <tt>'wct'</tt> water column thickness (m)</li>
 <li>

diff --git a/doc/html/tmd_interp_documentation.html b/doc/html/tmd_interp_documentation.html
diff --git a/doc/tmd_data_documentation.m b/doc/tmd_data_documentation.m
@@ -20,27 +20,27 @@
 % * |'hRe'| real part of tidal height
 % * |'hIm'| imaginary part of tidal height 
 % * |'hAm'| amplitude of tidal height
-% * |'hPh'| phase of tidal height
+% * |'hPh'| phase of tidal height (radians)
 % * |'u'|   complex zonal velocity (m/s) 
 % * |'uRe'| real part of zonal velocity 
 % * |'uIm'| imaginary part of zonal velocity 
 % * |'uAm'| amplitude of zonal velocity
-% * |'uPh'| phase of zonal velocity
+% * |'uPh'| phase of zonal velocity (radians)
 % * |'U'|   complex zonal transport (m^2/s) 
 % * |'URe'|  real part of zonal transport
 % * |'UIm'| imaginary part of zonal transport
 % * |'UAm'| amplitude of zonal transport
-% * |'UPh'| phase of zonal transport 
+% * |'UPh'| phase of zonal transport (radians) 
 % * |'v'|   complex meridional velocity (m/s) 
 % * |'vRe'| real part of meridional velocity 
 % * |'vIm'| imaginary part of meridional velocity
 % * |'vAm'| amplitude of meridional velocity
-% * |'vPh'| phase of meridional velocity 
+% * |'vPh'| phase of meridional velocity (radians) 
 % * |'V'|   complex meridional transport (m^2/s)
 % * |'VRe'| real part of meridional transport 
 % * |'VIm'| imaginary part of meridional transport
 % * |'VAm'| amplitude of meridional transport
-% * |'VPh'| phase of meridional transport
+% * |'VPh'| phase of meridional transport (radians)
 % * |'wct'| water column thickness (m) 
 % * |'mask'| binary land/ocean mask
 % * |'flexure'| ice shelf flexure coefficient from a linear elastic model applied to BedMachine ice thickness (can slightly exceed 1). Only for CATS model. 

diff --git a/doc/tmd_data_documentation.md b/doc/tmd_data_documentation.md
@@ -21,27 +21,27 @@ See also: [`tmd_interp`](tmd_interp_documentation.md) and [`tmd_predict`](tmd_pr
 * `'hRe'` real part of tidal height
 * `'hIm'` imaginary part of tidal height 
 * `'hAm'` amplitude of tidal height
-* `'hPh'` phase of tidal height
+* `'hPh'` phase of tidal height (radians)
 * `'u'`   complex zonal velocity (m/s) 
 * `'uRe'` real part of zonal velocity 
 * `'uIm'` imaginary part of zonal velocity 
 * `'uAm'` amplitude of zonal velocity
-* `'uPh'` phase of zonal velocity
+* `'uPh'` phase of zonal velocity (radians)
 * `'U'`   complex zonal transport (m^2/s) 
 * `'URe'`  real part of zonal transport
 * `'UIm'` imaginary part of zonal transport
 * `'UAm'` amplitude of zonal transport
-* `'UPh'` phase of zonal transport 
+* `'UPh'` phase of zonal transport (radians) 
 * `'v'`   complex meridional velocity (m/s) 
 * `'vRe'` real part of meridional velocity 
 * `'vIm'` imaginary part of meridional velocity
 * `'vAm'` amplitude of meridional velocity
-* `'vPh'` phase of meridional velocity 
+* `'vPh'` phase of meridional velocity (radians) 
 * `'V'`   complex meridional transport (m^2/s)
 * `'VRe'` real part of meridional transport 
 * `'VIm'` imaginary part of meridional transport
 * `'VAm'` amplitude of meridional transport
-* `'VPh'` phase of meridional transport
+* `'VPh'` phase of meridional transport (radians)
 * `'wct'` water column thickness (m) 
 * `'mask'` binary land/ocean mask
 * `'flexure'` ice shelf flexure coefficient from a linear elastic model applied to BedMachine ice thickness (can slightly exceed 1). Only for CATS model. 

diff --git a/doc/tmd_interp_documentation.m b/doc/tmd_interp_documentation.m
@@ -18,27 +18,27 @@
 % * |'hRe'| real part of tidal height
 % * |'hIm'| imaginary part of tidal height 
 % * |'hAm'| amplitude of tidal height
-% * |'hPh'| phase of tidal height
+% * |'hPh'| phase of tidal height (radians)
 % * |'u'|   complex zonal velocity (m/s) 
 % * |'uRe'| real part of zonal velocity 
 % * |'uIm'| imaginary part of zonal velocity 
 % * |'uAm'| amplitude of zonal velocity
-% * |'uPh'| phase of zonal velocity
+% * |'uPh'| phase of zonal velocity (radians)
 % * |'U'|   complex zonal transport (m^2/s) 
 % * |'URe'|  real part of zonal transport
 % * |'UIm'| imaginary part of zonal transport
 % * |'UAm'| amplitude of zonal transport
-% * |'UPh'| phase of zonal transport 
+% * |'UPh'| phase of zonal transport (radians) 
 % * |'v'|   complex meridional velocity (m/s) 
 % * |'vRe'| real part of meridional velocity 
 % * |'vIm'| imaginary part of meridional velocity
 % * |'vAm'| amplitude of meridional velocity
-% * |'vPh'| phase of meridional velocity 
+% * |'vPh'| phase of meridional velocity (radians) 
 % * |'V'|   complex meridional transport (m^2/s)
 % * |'VRe'| real part of meridional transport 
 % * |'VIm'| imaginary part of meridional transport
 % * |'VAm'| amplitude of meridional transport
-% * |'VPh'| phase of meridional transport
+% * |'VPh'| phase of meridional transport (radians)
 % * |'wct'| water column thickness (m) 
 % * |'mask'| binary land/ocean mask
 % * |'flexure'| ice shelf flexure coefficient from a linear elastic model applied to BedMachine ice thickness (can slightly exceed 1). Only for CATS model. 

diff --git a/doc/tmd_interp_documentation.md b/doc/tmd_interp_documentation.md
@@ -19,27 +19,27 @@ zi = tmd_interp(...,'coasts',MaskingMethod)
 * `'hRe'` real part of tidal height
 * `'hIm'` imaginary part of tidal height 
 * `'hAm'` amplitude of tidal height
-* `'hPh'` phase of tidal height
+* `'hPh'` phase of tidal height (radians)
 * `'u'`   complex zonal velocity (m/s) 
 * `'uRe'` real part of zonal velocity 
 * `'uIm'` imaginary part of zonal velocity 
 * `'uAm'` amplitude of zonal velocity
-* `'uPh'` phase of zonal velocity
+* `'uPh'` phase of zonal velocity (radians)
 * `'U'`   complex zonal transport (m^2/s) 
 * `'URe'`  real part of zonal transport
 * `'UIm'` imaginary part of zonal transport
 * `'UAm'` amplitude of zonal transport
-* `'UPh'` phase of zonal transport 
+* `'UPh'` phase of zonal transport (radians) 
 * `'v'`   complex meridional velocity (m/s) 
 * `'vRe'` real part of meridional velocity 
 * `'vIm'` imaginary part of meridional velocity
 * `'vAm'` amplitude of meridional velocity
-* `'vPh'` phase of meridional velocity 
+* `'vPh'` phase of meridional velocity (radians) 
 * `'V'`   complex meridional transport (m^2/s)
 * `'VRe'` real part of meridional transport 
 * `'VIm'` imaginary part of meridional transport
 * `'VAm'` amplitude of meridional transport
-* `'VPh'` phase of meridional transport
+* `'VPh'` phase of meridional transport (radians)
 * `'wct'` water column thickness (m) 
 * `'mask'` binary land/ocean mask
 * `'flexure'` ice shelf flexure coefficient from a linear elastic model applied to BedMachine ice thickness (can slightly exceed 1). Only for CATS model. 

diff --git a/tmd_interp.m b/tmd_interp.m
@@ -17,27 +17,27 @@
 %  * 'hRe' real part of tidal height
 %  * 'hIm' imaginary part of tidal height 
 %  * 'hAm' amplitude of tidal height
-%  * 'hPh' phase of tidal height
+%  * 'hPh' phase of tidal height (radians)
 %  * 'u'   complex zonal velocity (m/s) 
 %  * 'uRe' real part of zonal velocity 
 %  * 'uIm' imaginary part of zonal velocity 
 %  * 'uAm' amplitude of zonal velocity
-%  * 'uPh' phase of zonal velocity
+%  * 'uPh' phase of zonal velocity (radians)
 %  * 'U'   complex zonal transport (m^2/s) 
 %  * 'URe' real part of zonal transport
 %  * 'UIm' imaginary part of zonal transport
 %  * 'UAm' amplitude of zonal transport
-%  * 'UPh' phase of zonal transport 
+%  * 'UPh' phase of zonal transport (radians)
 %  * 'v'   complex meridional velocity (m/s) 
 %  * 'vRe' real part of meridional velocity 
 %  * 'vIm' imaginary part of meridional velocity
 %  * 'vAm' amplitude of meridional velocity
-%  * 'vPh' phase of meridional velocity 
+%  * 'vPh' phase of meridional velocity (radians) 
 %  * 'V'   complex meridional transport (m^2/s)
 %  * 'VRe' real part of meridional transport 
 %  * 'VIm' imaginary part of meridional transport
 %  * 'VAm' amplitude of meridional transport
-%  * 'VPh' phase of meridional transport
+%  * 'VPh' phase of meridional transport (radians)
 %  * 'wct' water column thickness (m) 
 %  * 'mask' binary land/ocean mask
 %  * 'flexure' ice shelf flexure coefficient from a linear elastic model applied to BedMachine ice thickness (can slightly exceed 1). Only for CATS model.