<p><b>mpetersen@lanl.gov</b> 2013-04-02 11:02:47 -0600 (Tue, 02 Apr 2013)</p><p>ocean user's guide: change overflow figures to python version, add global statistics, stub for forward.<br>
</p><hr noshade><pre><font color="gray">Modified: trunk/documents/users_guide/mpas_ocean_users_guide.tex
===================================================================
--- trunk/documents/users_guide/mpas_ocean_users_guide.tex        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/mpas_ocean_users_guide.tex        2013-04-02 17:02:47 UTC (rev 2702)
@@ -47,6 +47,9 @@
 }
 
 \maketitle
+
+\input{ocean/forward.tex}
+
 \tableofcontents
 
 \input{ocean/quick_start.tex}
@@ -63,6 +66,7 @@
 \input{ocean/variable_table_documentation.tex}
 
 \input{ocean/test_case_descriptions.tex}
+\input{ocean/global_statistics.tex}
 \input{ocean/cesm_coupling.tex}
 \input{ocean/troubleshooting.tex}
 \input{ocean/knownissues.tex}

Added: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_0hrs.png
===================================================================
(Binary files differ)

Index: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_0hrs.png
===================================================================
--- trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_0hrs.png        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_0hrs.png        2013-04-02 17:02:47 UTC (rev 2702)

Property changes on: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_0hrs.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_3hrs.png
===================================================================
(Binary files differ)

Index: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_3hrs.png
===================================================================
--- trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_3hrs.png        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_3hrs.png        2013-04-02 17:02:47 UTC (rev 2702)

Property changes on: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_3hrs.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_9hrs.png
===================================================================
(Binary files differ)

Index: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_9hrs.png
===================================================================
--- trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_9hrs.png        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_9hrs.png        2013-04-02 17:02:47 UTC (rev 2702)

Property changes on: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_ke_9hrs.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_0hrs.png
===================================================================
(Binary files differ)

Index: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_0hrs.png
===================================================================
--- trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_0hrs.png        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_0hrs.png        2013-04-02 17:02:47 UTC (rev 2702)

Property changes on: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_0hrs.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_3hrs.png
===================================================================
(Binary files differ)

Index: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_3hrs.png
===================================================================
--- trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_3hrs.png        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_3hrs.png        2013-04-02 17:02:47 UTC (rev 2702)

Property changes on: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_3hrs.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_9hrs.png
===================================================================
(Binary files differ)

Index: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_9hrs.png
===================================================================
--- trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_9hrs.png        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_9hrs.png        2013-04-02 17:02:47 UTC (rev 2702)

Property changes on: trunk/documents/users_guide/ocean/figures/MPAS-O_overflow_temperature_9hrs.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Deleted: trunk/documents/users_guide/ocean/figures/overflow_1km_0hr.pdf
===================================================================
(Binary files differ)

Deleted: trunk/documents/users_guide/ocean/figures/overflow_1km_3hr.pdf
===================================================================
(Binary files differ)

Deleted: trunk/documents/users_guide/ocean/figures/overflow_1km_9hr.pdf
===================================================================
(Binary files differ)

Added: trunk/documents/users_guide/ocean/global_statistics.tex
===================================================================
--- trunk/documents/users_guide/ocean/global_statistics.tex                                (rev 0)
+++ trunk/documents/users_guide/ocean/global_statistics.tex        2013-04-02 17:02:47 UTC (rev 2702)
@@ -0,0 +1,18 @@
+\chapter{Global Statistics}
+\label{chap:global_statistics}
+
+MPAS-Ocean simulations create global statistics in the following files:
+\begin{verbatim}
+stats_readme.txt
+stats_time.txt
+stats_min.txt
+stats_max.txt
+stats_sum.txt
+stats_avg.txt
+stats_colmin.txt
+stats_colmax.txt
+\end{verbatim}
+Frequency is controlled by \verb|_stats_\verb| flags in the namelist.  The files are simply text files formatted in columns and rows, where each row is a particular time, written to \verb|stats_time.txt\verb|, and each column is a variable, described in \verb|stats_readme.txt\verb|.
+
+{\color{red}TBA: put stats files above into a table with description of each.  stats\_readme.txt is not yet in code.  Add a longer description here about how to use cut, awk, and gnuplot to view data.}
+

Modified: trunk/documents/users_guide/ocean/test_cases/overflow.tex
===================================================================
--- trunk/documents/users_guide/ocean/test_cases/overflow.tex        2013-04-02 16:36:57 UTC (rev 2701)
+++ trunk/documents/users_guide/ocean/test_cases/overflow.tex        2013-04-02 17:02:47 UTC (rev 2702)
@@ -33,12 +33,20 @@
 \label{subsecc:overflow_results}
 Initially, a cold, dense volume of water is released at the top of a sill.  Within the course of an 18-hour simulation the cold water descends the steep mount and continues northward along the bottom.  The Coriolis parameter is set to zero so that rotational effects do not occur.  The speed of descent, or equivalently the time to reach the bottom, is a simple way to measure the amount of mixing that occurs as the plug of water descends.  In the two cases included with this release, the cold front reaches the bottom of the sill after eight hours for the high resolution case (1 km horizontal mesh, 100 layers), but after 16 hours for the low resolution case (10 km horizontal mesh, 40 layers).  Visualizations show that some ten-degree water remains after nine hours for the high-resolution case (Figure \ref{fig:overflow}), but has all mixed out for the low-resolution case (not shown).
 
+The python script \verb|visualize_overflow.py| is included in the test case files to visualize cross-sections of cell-centered variables, like those shown in Figure \ref{fig:overflow}.  These plots may be created at the unix prompt with, for example,
+\begin{verbatim}
+python visualize_overflow.py -f output.nc -v temperature --min=10 --max=20 --time=9
+\end{verbatim}
+The python script requires the libraries numpy, netCDF4, and matplotlib.
 
 \begin{figure}[H!]
         \centering
-        \includegraphics[scale=1.0]{ocean/figures/overflow_1km_0hr.pdf}\\
-        \includegraphics[scale=1.0]{ocean/figures/overflow_1km_3hr.pdf}\\
-        \includegraphics[scale=1.0]{ocean/figures/overflow_1km_9hr.pdf}
-        \caption{Overflow test case results, showing vertical cross-sections of temperature (left) and kinetic energy (right).  Each horizontal axis is distance in km, and each vertical axis is layer index. Rows show initial condition (top), 6 hours (middle) and 9 hours (bottom). {\color{red}TBA: these images were made with matlab.  Next version will use python.}}
+        \includegraphics[scale=0.4]{ocean/figures/MPAS-O_overflow_temperature_0hrs.png}
+        \includegraphics[scale=0.4]{ocean/figures/MPAS-O_overflow_ke_0hrs.png}\\
+        \includegraphics[scale=0.4]{ocean/figures/MPAS-O_overflow_temperature_3hrs.png}
+        \includegraphics[scale=0.4]{ocean/figures/MPAS-O_overflow_ke_3hrs.png}\\
+        \includegraphics[scale=0.4]{ocean/figures/MPAS-O_overflow_temperature_9hrs.png}
+        \includegraphics[scale=0.4]{ocean/figures/MPAS-O_overflow_ke_9hrs.png}
+        \caption{Overflow test case results for the high resolution case (1 km horizontal grid-cells), showing vertical cross-sections of temperature (left) and kinetic energy (right).  Rows show initial condition (top), 3 hours (middle) and 9 hours (bottom).}
         \label{fig:overflow}
 \end{figure}

</font>
</pre>