<p><b>mpetersen@lanl.gov</b> 2012-05-16 14:31:21 -0600 (Wed, 16 May 2012)</p><p>Cross-section visualization tool: Improve documentation at top of matlab functions.<br>
</p><hr noshade><pre><font color="gray">Modified: branches/tools/plot_mpas_cross_sections/find_cell_sections.m
===================================================================
--- branches/tools/plot_mpas_cross_sections/find_cell_sections.m        2012-05-15 19:55:24 UTC (rev 1915)
+++ branches/tools/plot_mpas_cross_sections/find_cell_sections.m        2012-05-16 20:31:21 UTC (rev 1916)
@@ -7,16 +7,16 @@
% specified in coord. The path is forced to travel through cells
% that are closest to the line connecting the beginning and end
% cells.
-
+%
% Mark Petersen, MPAS-Ocean Team, LANL, May 2012
-
+%
%%%%%%%%%% input arguments %%%%%%%%%
% The text string [wd '/' dir '/' netcdf_file ] is the file path,
% where wd is the working directory and dir is the run directory.
% sectionText a cell array with text describing each section
% coord(nSections,4) endpoints of sections, with one section per row as
% [startlat startlon endlat endlon]
-
+%
%%%%%%%%%% output arguments %%%%%%%%%
% sectionCellIndex(maxCells,nSections) cell index of each section
% nCellsInSection(nSections) number of cells in each section
Modified: branches/tools/plot_mpas_cross_sections/load_large_variables.m
===================================================================
--- branches/tools/plot_mpas_cross_sections/load_large_variables.m        2012-05-15 19:55:24 UTC (rev 1915)
+++ branches/tools/plot_mpas_cross_sections/load_large_variables.m        2012-05-16 20:31:21 UTC (rev 1916)
@@ -3,9 +3,9 @@
sectionCellIndex, nCellsInSection)
% Load large variables from netcdf file
-
+%
% Mark Petersen, MPAS-Ocean Team, LANL, May 2012
-
+%
%%%%%%%%%% input arguments %%%%%%%%%
% The text string [wd '/' dir '/' netcdf_file ] is the file path,
% where wd is the working directory and dir is the run directory.
@@ -14,7 +14,7 @@
% var_conv_factor multiply each variable by this unit conversion.
% sectionCellIndex(maxCells,nSections) cell index of each section
% nCellsInSection(nSections) number of cells in each section
-
+%
%%%%%%%%%% output arguments %%%%%%%%%
% sectionData(nVertLevels,max(nCellsInSection),nSections,nVars)
% data in each cross-section for each variable
Modified: branches/tools/plot_mpas_cross_sections/plot_mpas_cross_sections.m
===================================================================
--- branches/tools/plot_mpas_cross_sections/plot_mpas_cross_sections.m        2012-05-15 19:55:24 UTC (rev 1915)
+++ branches/tools/plot_mpas_cross_sections/plot_mpas_cross_sections.m        2012-05-16 20:31:21 UTC (rev 1916)
@@ -1,8 +1,14 @@
-% script plot_mpas_cross_sections
+function plot_mpas_cross_sections
-% Specify data files, coordinates and text, then call functions
-% to find sections, load data, and plot cross-sections.
-
+% Plot cross-sections of MPAS fields.
+%
+% This is the main function, where the user can specify data files,
+% coordinates and text, then call functions to find sections, load
+% data, and plot cross-sections.
+%
+% The final product is a set of plots as jpg files, a latex file,
+% and a compiled pdf file of the plots, if desired.
+%
% Mark Petersen, MPAS-Ocean Team, LANL, May 2012
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Modified: branches/tools/plot_mpas_cross_sections/sub_plot_cross_sections.m
===================================================================
--- branches/tools/plot_mpas_cross_sections/sub_plot_cross_sections.m        2012-05-15 19:55:24 UTC (rev 1915)
+++ branches/tools/plot_mpas_cross_sections/sub_plot_cross_sections.m        2012-05-16 20:31:21 UTC (rev 1916)
@@ -2,10 +2,10 @@
sectionCellIndex, nCellsInSection, latSection,lonSection, coord, plotDepth,...
var_name,var_lims,fid_latex)
-% Plot data on cross-sections
-
+% Plot cross-sections of MPAS fields.
+%
% Mark Petersen, MPAS-Ocean Team, LANL, May 2012
-
+%
%%%%%%%%%% input arguments %%%%%%%%%
% dir text string, name of simulation
% sectionText a cell array with text describing each section
</font>
</pre>