Changeset 1742 for XIOS/dev/dev_trunk_omp/doc/XIOS_testcase_user_guide.tex

Timestamp:

10/15/19 11:37:29 (5 years ago)

Author:

yushan

Message:

Doc updated

File:

• XIOS/dev/dev_trunk_omp/doc/XIOS_testcase_user_guide.tex (modified) (6 diffs)

XIOS/dev/dev_trunk_omp/doc/XIOS_testcase_user_guide.tex

@@ -19 +19 @@
 %   read geometry.pdf for detailed page layout information
 
-\usepackage{graphicx} % support the \includegraphics command and optionsi
+\usepackage{graphicx} % support the \includegraphics command and options
 
 % \usepackage[parfill]{parskip} % Activate to begin paragraphs with an empty line rather than an indent
@@ -26 +26 @@
 \usepackage{booktabs} % for much better looking tables
 \usepackage{array} % for better arrays (eg matrices) in maths
-\usepackage{paralist} % very flexible & customisable lists (eg. enumerate/itemize, etc.)
+\usepackage{paralist} % very flexible & customizable lists (eg. enumerate/itemize, etc.)
 \usepackage{verbatim} % adds environment for commenting out blocks of text & for better verbatim
 \usepackage{subfig} % make it possible to include more than one captioned figure/table in a single float
@@ -34 +34 @@
 \usepackage{fancyhdr} % This should be set AFTER setting up the page geometry
 \pagestyle{fancy} % options: empty , plain , fancy
-\renewcommand{\headrulewidth}{0pt} % customise the layout...
+\renewcommand{\headrulewidth}{0pt} % customize the layout...
 \lhead{}\chead{}\rhead{}
 \lfoot{}\cfoot{\thepage}\rfoot{}
@@ -117 +117 @@
 
 The XIOS generic testcase is a set of unit tests that test functionalities of 
-XIOS. It is reserved for XIOS developpers and it is designed to ensure that the 
+XIOS. It is reserved for XIOS developers and it is designed to ensure that the 
 XIOS does not introduce errors after each code modification. 
 
-\section{Orgnization of the testcase}
+\section{Organization of the testcase}
 The XIOS generic testcase is located in the \verb|GENERIC_TESTCASE| folder inside 
 the XIOS directory. Inside the \verb|GENERIC_TESTCASE| folder, we have for the moment 
@@ -157 +157 @@
 
 Besides of the default value, one can also set a temporal value for the configuration variables in the file \verb|user_params.def|.
-In this file, each variable can have multiple values seperated by a semecolon. For example, \verb|NumberServers=2,4,6|.
+In this file, each variable can have multiple values separated by a semicolon. For example, \verb|NumberServers=2,4,6|.
 From such definition, the testcase will generate 3 different configurations and tests will be run for each configuration.
 
 
 \subsection{Define the output file check list}
-The validation of the testcase is ensured by the comparaison between the newly generated output 
-\verb|NetCDF| files and the prestored reference results. In some cases, one maybe interested in only one or serveral output files.
-It will not be necessary to compare all output files for this will slow down the whole test execuition.
+The validation of the testcase is ensured by the comparison between the newly generated output 
+\verb|NetCDF| files and the pre-stored reference results. In some cases, one maybe interested in only one or several output files.
+It will not be necessary to compare all output files for this will slow down the whole test execution.
 To specify the output files to compare with the reference, one can modify the \verb|checkfile.def| file.
-If nothing is set in this file, or \verb|all| is set, then all output files will be examinated.
+If nothing is set in this file, or \verb|all| is set, then all output files will be examined.
 
 \section{How to launch XIOS testcase}
@@ -204 +204 @@
 \end{lstlisting}
 
-This Ctest style summary report shows the overall execution status of all unit tests. 
+This CTest style summary report shows the overall execution status of all unit tests. 
 Besides of this console output, we also have \verb|report.html| which can be viewed
 by any web browser.