Changeset 1742 for XIOS/dev/dev_trunk_omp/doc
- Timestamp:
- 10/15/19 11:37:29 (5 years ago)
- Location:
- XIOS/dev/dev_trunk_omp/doc
- Files:
-
- 1 added
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
XIOS/dev/dev_trunk_omp/doc/XIOS_graph_user_guide.tex
r1741 r1742 83 83 \usepackage[dvipsnames]{xcolor} 84 84 \newcommand{\visbutton}[1]{\colorbox[RGB]{92,184,92}{\color{white}{#1}}} 85 86 \usepackage{float} 85 87 %%% END Article customizations 86 88 … … 128 130 In the workflow graph, a node represents a XIOS filter. We have 7 categories of filters: 129 131 \begin{itemize} 130 \item source filter: when the field data is received from model or read from netcdffile132 \item source filter: when the field data is received from model or read from NetCDF file 131 133 \item pass through filter: when having a field reference 132 134 \item arithmetic filter: when arithmetic operations are performed on the field 133 135 \item temporal filter: when the field has a temporal operation (\textit{e.g.} average, maximum, minimum, ...) 134 136 \item spatial transform filter: when the field has a spatial transform applied upon (\textit{e.g.} zoom, interpolate, ...) 135 \item file write filter: when the field data is written to a netcdffile137 \item file write filter: when the field data is written to a NetCDF file 136 138 \item store filter: when the field data is send back to model 137 139 \end{itemize} … … 150 152 \end{lstlisting} 151 153 152 \subsection{Heritage by field refere cing}154 \subsection{Heritage by field referencing} 153 155 154 156 \begin{lstlisting}[language=XML] … … 169 171 \section{Visualization of workflow graph} 170 172 171 \begin{figure}[ht] 172 \centering 173 \includegraphics[scale=0.4]{inputs/images/graph_init} 174 \caption{Start state of the Visualization} 173 174 \subsection{Example of XIOS workflow graph output} 175 176 \begin{figure}[H] 177 \centering 178 \includegraphics[scale=0.45]{inputs/images/workflow_graph} 175 179 \end{figure} 176 180 177 The workflow graph can be viewed through the \verb|graph.html| script located in the XIOS 181 From this graph, we can gather several information directly: 182 \begin{itemize} 183 \item the workflow has 3 inputs fields and one output field; 184 \item \verb|filed_D = field_A + field_B + field_C|; 185 \item \verb|field_D| is outputted every time step (instant temporal filter); 186 \item the output NetCDF file is named \verb|output.nc|; 187 \item the date label of the time step is 2012-03-01 at 21 o'clock. 188 \end{itemize} 189 190 This graph shows how XIOS interprets the \verb|xml| inputs. Users can easily check if it corresponds to 191 their designed input configurations. 192 193 The workflow graph is viewed through the \verb|graph.html| script located in the XIOS 178 194 folder. The graph file \verb|graph_data.json| is stored in the same folder as the \verb|iodef.xml| file 179 195 which is used for configure the simulation. 180 Choose the graph file to start the Visualization by cli king the button \colorbox[RGB]{66,139,202}{\color{white}{Load a JSON XIOS file}}.196 Choose the graph file to start the Visualization by clicking the button \colorbox[RGB]{66,139,202}{\color{white}{Load a JSON XIOS file}}. 181 197 Several buttons are set to allow user to visualize the graph interactively. 198 199 \begin{figure}[H] 200 \centering 201 \includegraphics[scale=0.4]{inputs/images/graph_init} 202 \caption{Start state of the Visualization} 203 \end{figure} 182 204 183 205 \subsection{Enable/Disable all} … … 200 222 \visbutton{Enable input} shows all input nodes of the graph. The input nodes are 201 223 often, if not always, the source filters: data received from the model or read 202 from a netcdffile.224 from a NetCDF file. 203 225 204 226 \subsection{Enable output} 205 227 \visbutton{Enable output} shows all output nodes of the graph. The output nodes 206 are either the file writer filter: data written to a netcdffile; either the store228 are either the file writer filter: data written to a NetCDF file; either the store 207 229 filter: data send back to model. 208 230 … … 236 258 \end{lstlisting} 237 259 238 In this example, the graph will only include information between the 3rd and 5th time step.239 These attributes are not ma datory. If \verb|build_workflow_graph_start| is not define, the graph will start to record from the first iteration.240 Similarly, the def ualt value of \verb|build_workflow_graph_end| is the last iteration of the simulation.260 In this example, the graph will only include information between the 3rd and 5th time step. 261 These attributes are not mandatory. If \verb|build_workflow_graph_start| is not define, the graph will start to record from the first iteration. 262 Similarly, the default value of \verb|build_workflow_graph_end| is the last iteration of the simulation. 241 263 242 264 In case that two values of the same attribute are defined, we take the largest range. -
XIOS/dev/dev_trunk_omp/doc/XIOS_testcase_user_guide.tex
r1741 r1742 19 19 % read geometry.pdf for detailed page layout information 20 20 21 \usepackage{graphicx} % support the \includegraphics command and options i21 \usepackage{graphicx} % support the \includegraphics command and options 22 22 23 23 % \usepackage[parfill]{parskip} % Activate to begin paragraphs with an empty line rather than an indent … … 26 26 \usepackage{booktabs} % for much better looking tables 27 27 \usepackage{array} % for better arrays (eg matrices) in maths 28 \usepackage{paralist} % very flexible & customi sable lists (eg. enumerate/itemize, etc.)28 \usepackage{paralist} % very flexible & customizable lists (eg. enumerate/itemize, etc.) 29 29 \usepackage{verbatim} % adds environment for commenting out blocks of text & for better verbatim 30 30 \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 35 35 \pagestyle{fancy} % options: empty , plain , fancy 36 \renewcommand{\headrulewidth}{0pt} % customi se the layout...36 \renewcommand{\headrulewidth}{0pt} % customize the layout... 37 37 \lhead{}\chead{}\rhead{} 38 38 \lfoot{}\cfoot{\thepage}\rfoot{} … … 117 117 118 118 The XIOS generic testcase is a set of unit tests that test functionalities of 119 XIOS. It is reserved for XIOS develop pers and it is designed to ensure that the119 XIOS. It is reserved for XIOS developers and it is designed to ensure that the 120 120 XIOS does not introduce errors after each code modification. 121 121 122 \section{Org nization of the testcase}122 \section{Organization of the testcase} 123 123 The XIOS generic testcase is located in the \verb|GENERIC_TESTCASE| folder inside 124 124 the XIOS directory. Inside the \verb|GENERIC_TESTCASE| folder, we have for the moment … … 157 157 158 158 Besides of the default value, one can also set a temporal value for the configuration variables in the file \verb|user_params.def|. 159 In this file, each variable can have multiple values sep erated by a semecolon. For example, \verb|NumberServers=2,4,6|.159 In this file, each variable can have multiple values separated by a semicolon. For example, \verb|NumberServers=2,4,6|. 160 160 From such definition, the testcase will generate 3 different configurations and tests will be run for each configuration. 161 161 162 162 163 163 \subsection{Define the output file check list} 164 The validation of the testcase is ensured by the compar aison between the newly generated output165 \verb|NetCDF| files and the pre stored reference results. In some cases, one maybe interested in only one or serveral output files.166 It will not be necessary to compare all output files for this will slow down the whole test execu ition.164 The validation of the testcase is ensured by the comparison between the newly generated output 165 \verb|NetCDF| files and the pre-stored reference results. In some cases, one maybe interested in only one or several output files. 166 It will not be necessary to compare all output files for this will slow down the whole test execution. 167 167 To specify the output files to compare with the reference, one can modify the \verb|checkfile.def| file. 168 If nothing is set in this file, or \verb|all| is set, then all output files will be examin ated.168 If nothing is set in this file, or \verb|all| is set, then all output files will be examined. 169 169 170 170 \section{How to launch XIOS testcase} … … 204 204 \end{lstlisting} 205 205 206 This C test style summary report shows the overall execution status of all unit tests.206 This CTest style summary report shows the overall execution status of all unit tests. 207 207 Besides of this console output, we also have \verb|report.html| which can be viewed 208 208 by any web browser.
Note: See TracChangeset
for help on using the changeset viewer.