joss review

Updates in reference to Issue #11 and Issue #15.

README.md

@@ -53,6 +53,7 @@ If you're not sure what function name you're looking for, just type `tmd` into t
 Be sure to check out the documentation for each of the **Main functions**. There, you'll find multiple examples of how to use each function. In addition, the following tutorials and other documentation may be of interest: 
 
 * [TMD Getting Started](doc/tmd_getting_started.md)
+* [What's new in TMD 3.0?](doc/whats_new.md)
 * [TMD Model file format](doc/TMD_model_file_format.md)
 * [Tide Model Intercomparison](doc/tide_model_intercomparison.md)
 * [How to: Analyze ADCP current data](doc/tutorial_currents.md)
@@ -61,15 +62,6 @@ Be sure to check out the documentation for each of the **Main functions**. There
 * [How to: Calculate tidal range](doc/tutorial_tidal_range.md)
 * [How to: Animate tidal motion](doc/tmd_logo_animation.md)
 
-# What's new in TMD 3.0?
-TMD3.0 is a rewrite of the [Tide Model Driver for MATLAB v2.5](https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5). The goal of this update was to create a clean, efficient set of functions that are well documented, easy to use, and easy to debug. We also wanted to reduce the size, complexity, and overall hassle of dealing with multi-file or binary tide model data files. The biggest changes in this update to TMD3.0 are as follows: 
-
-* Introduced a new, [consolidated NetCDF model data format](doc/TMD_model_file_format.md).  
-* All functions rewritten for improved performance (*much faster* and lower memory usage than TMD2.5). 
-* Most functions were renamed and inputs have changed to make them more intuitive and easier to use.
-* All new documentation.
-* Updated the CATS2008 model, as described [here](doc/cats2008_updates.md).
-
 # Alternatives to MATLAB
 Don't like MATLAB? No worries, just try one of these alternatives: 
 

doc/whats_new.md

@@ -0,0 +1,35 @@
+[← Back to TMD3.0 Main Page](../README.md)
+
+# What's new in TMD3.0?
+TMD3.0 is a rewrite of the [Tide Model Driver for MATLAB v2.5](https://github.com/EarthAndSpaceResearch/TMD_Matlab_Toolbox_v2.5). The goal of this update was to create a clean, efficient set of functions that are well documented, easy to use, and easy to debug. We also wanted to reduce the size, complexity, and overall hassle of dealing with multi-file or binary tide model data files. The biggest changes in this update to TMD3.0 are as follows: 
+
+* Introduced a new, [consolidated NetCDF model data format](doc/TMD_model_file_format.md).  
+* All functions rewritten for improved performance (*much faster* and lower memory usage than TMD2.5). 
+* Most functions were renamed and inputs have changed to make them more intuitive and easier to use.
+* All new documentation.
+* Updated the CATS2008 model, as described [here](doc/cats2008_updates.md).
+
+# Converting from previous TMD releases
+Here's a table of how the new functions compare to previous versions of TMD: 
+
+| TMD3.0 function | Previous name | Major Changes                      |
+|:---------------:|:-----------:|:------------------------------------:|
+|`tmd_predict`  |`tmd_tide_pred   `| Changed the order of function inputs|
+|`tmd_interp`   | No direct previous equivalent| n/a |
+|`tmd_data`     | `h_in`, `grd_in`| n/a |
+|`tmd_conlist`  |No direct previous equivalent| n/a |
+|`tmd_ellipse`|`tmd_get_ellipse`| Now allows input geo coordinates |
+|`tidal_range`  |No direct previous equivalent| n/a |
+|`tidal_astrol`  |`astrol`| functionally equivalent  |
+|`tmd_constit`  |`constit`| functionally equivalent   |
+|`tmd_harp`  |`harp`, `harp1`| changed to `datenum` input format |
+|`tmd_InferMinor`  |`InferMinor`| functionally equivalent  |
+|`tmd_nodal`  |`nodal`, `nodal1`| now requires both p and N as inputs |
+|`tmd_ll2ps`  |`mapll`| functionally equivalent  |
+|`tmd_ps2ll`  |`mapxy`| functionally equivalent |
+
+#  Comparing TMD3.0 to previous versions 
+If you want to compare results of TMD3.0 to previous versions of TMD, feel free to use or modify [this script](../tide-model-conversions/testing/tmd30_vs_tmd24.m) we wrote for that exact purpose. 
+
+# Author Info
+This page was written by [Chad A. Greene](https://www.chadagreene.com), December 2023. 

tmd_harp.m

@@ -18,7 +18,7 @@
 %    p: lunar perigee p given by the tmd_astrol function. (size Tx1), 
 %    N: ascending lunar node N given by the tmd_astrol function (size Tx1), 
 %    ph: astronomical phase given by the tmd_constit function (size Cx1), 
-%    omega: frequency given by the tmd_constit function (size Cx1). 
+%    omega: frequency given by the tmd_constit function (size Cx1) units s^-1. 
 % 
 % Outpus: 
 %    hhat: reconstructed tide (size Tx1).

tmd_nodal.m

@@ -14,7 +14,7 @@
 % [pu,pf] = tmd_nodal(constituents,p,N) takes input constituents 
 % 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. Outputs pu,pf are MxN,
+% dimesnions Mx1, with one row per timestep. Nodal correction outputs pu,pf are MxN,
 % corresponding to M timesteps and N constituents. 
 % 
 %% Author Info