Updated commented descriptions.

Author: warmkar

complete_run.m

@@ -12,18 +12,16 @@ function complete_run(ssh_path, eddies_save_path, tracks_save_path, fake_eddies,
 % 4. Format and process saved data so that it can be viewed in Hung's
 %    viewer that we include
 %
-% NOTE: The process of turning NetCDF file data into MATLAB data is
-% partially left up to the user to do. A function will be provided that
-% will accomplish this for the user, but the user will have to provide the
-% variable names for what the SSH data is called, what the Latitude data is
-% called, and what the Longitude data is called. Also, the user will either
-% have to have this function generate a dates array (that is, what day each
-% day of SSH data relates to) for it, or they will have to generate their
-% own. Code will be provided in the NetCDf to MATLAB data function to
-% assist with generating this dates array.
-% Also, this script will not open the viewer for the user, it will leave
-% that action up to the user. To open the viewer, all the user has to do is
-% run the start_track_viewer script inside the tracks_viewer directory.
+% NOTE: The process of turning NetCDF file data into MATLAB data is not
+% accomplished in this function.
+% The function set_up_ssh_data is provided that will accomplish this for
+% the user, but the user will have to provide the variable names that match
+% the function inputs. Refer to the comments at the top of the function
+% set_up_ssh_data for a description of what each of the required variables are.
+%
+% This script will not open the viewer for the user.
+% To open the viewer, run the start_track_viewer script inside the
+% tracks_viewer directory.
 
 p = inputParser;
 defaultLat = NaN;
@@ -143,7 +141,7 @@ function complete_run(ssh_path, eddies_save_path, tracks_save_path, fake_eddies,
     cyclonic_tracks = vars.(s{1});
     eddies_save_path = modified_eddies_path;
 else
-    anticyclonic_tracks = track_lnn(eddies_save_path, 'anticyc', 1); % Change this so it can be an optional argument in input parser
+    anticyclonic_tracks = track_lnn(eddies_save_path, 'anticyc', 1); % Possibly change this so it can be an optional argument in input parser
     cyclonic_tracks = track_lnn(eddies_save_path, 'cyclonic', 1); % Same as above
 end
 save([tracks_save_path, 'anticyclonic_tracks.mat'], 'anticyclonic_tracks');

set_up_ssh_data.m

@@ -1,10 +1,22 @@
 function set_up_ssh_data(NetCDF_files_path, ssh_NetCDF_name, lat_NetCDF_name, lon_NetCDF_name, ssh_save_path)
 % Inputs:
-%   NetCDF_files_path: 
-%   ssh_NetCDF_name: 
-%   lat_NetCDF_name: 
-%   lon_NetCDF_name: 
-%   ssh_save_path: 
+%   NetCDF_files_path: The directory path to the NetCDF files.
+%   ssh_NetCDF_name: The name of the variable inside the NetCDF file that
+%                    corresponds to the SSH data.
+%   lat_NetCDF_name: The name of the variable inside the NetCDF file that
+%                    corresponds to the latitude data.
+%   lon_NetCDF_name: The name of the variable inside the NetCDF file that
+%                    corresponds to the longitude data.
+%   ssh_save_path: The directory where you want resulting SSH, latitude,
+%                  longitude, and other .mat data that is generated by this
+%                  function saved.
+%
+% If you do not understand how to provide these inputs, please refer to the
+% NetCDF data files you have, and check the variable names by running
+% either 'ncdump -h <nc_filename>' in a terminal, or by using MATLAB's
+% built in 'ncdisp(<nc_filename>)' command to read about the variable
+% names.
+
 if ~strcmp(NetCDF_files_path(end), '/')
     NetCDF_files_path = strcat(NetCDF_files_path, '/');
 end