Changeset 1742 for XIOS/dev/dev_trunk_omp/doc/XIOS_graph_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_graph_user_guide.tex (modified) (6 diffs)

XIOS/dev/dev_trunk_omp/doc/XIOS_graph_user_guide.tex

@@ -83 +83 @@
 \usepackage[dvipsnames]{xcolor}
 \newcommand{\visbutton}[1]{\colorbox[RGB]{92,184,92}{\color{white}{#1}}}
+
+\usepackage{float}
 %%% END Article customizations
 
@@ -128 +130 @@
 In the workflow graph, a node represents a XIOS filter. We have 7 categories of filters:
 \begin{itemize}
-    \item source filter: when the field data is received from model or read from netcdf file
+    \item source filter: when the field data is received from model or read from NetCDF file
     \item pass through filter: when having a field reference
     \item arithmetic filter: when arithmetic operations are performed on the field
     \item temporal filter: when the field has a temporal operation (\textit{e.g.} average, maximum, minimum, ...)
     \item spatial transform filter: when the field has a spatial transform applied upon (\textit{e.g.} zoom, interpolate, ...)
-    \item file write filter: when the field data is written to a netcdf file
+    \item file write filter: when the field data is written to a NetCDF file
     \item store filter: when the field data is send back to model
 \end{itemize}
@@ -150 +152 @@
 \end{lstlisting}
 
-\subsection{Heritage by field referecing}
+\subsection{Heritage by field referencing}
 
 \begin{lstlisting}[language=XML]
@@ -169 +171 @@
 \section{Visualization of workflow graph}
 
-\begin{figure}[ht]
-\centering
-\includegraphics[scale=0.4]{inputs/images/graph_init}
-\caption{Start state of the Visualization}
+
+\subsection{Example of XIOS workflow graph output}
+
+\begin{figure}[H]
+    \centering
+    \includegraphics[scale=0.45]{inputs/images/workflow_graph}
 \end{figure}
 
-The workflow graph can be viewed through the \verb|graph.html| script located in the XIOS 
+From this graph, we can gather several information directly:
+\begin{itemize}
+    \item the workflow has 3 inputs fields and one output field;
+    \item \verb|filed_D = field_A + field_B + field_C|;
+    \item \verb|field_D| is outputted every time step (instant temporal filter);
+    \item the output NetCDF file is named \verb|output.nc|;
+    \item the date label of the time step is 2012-03-01 at 21 o'clock.
+\end{itemize}
+
+This graph shows how XIOS interprets the \verb|xml| inputs. Users can easily check if it corresponds to 
+their designed input configurations. 
+
+The workflow graph is viewed through the \verb|graph.html| script located in the XIOS 
 folder. The graph file \verb|graph_data.json| is stored in the same folder as the \verb|iodef.xml| file
 which is used for configure the simulation.
-Choose the graph file to start the Visualization by cliking the button \colorbox[RGB]{66,139,202}{\color{white}{Load a JSON XIOS file}}.
+Choose the graph file to start the Visualization by clicking the button \colorbox[RGB]{66,139,202}{\color{white}{Load a JSON XIOS file}}.
 Several buttons are set to allow user to visualize the graph interactively. 
+
+\begin{figure}[H]
+    \centering
+    \includegraphics[scale=0.4]{inputs/images/graph_init}
+    \caption{Start state of the Visualization}
+\end{figure}
 
 \subsection{Enable/Disable all}
@@ -200 +222 @@
 \visbutton{Enable input} shows all input nodes of the graph. The input nodes are
 often, if not always, the source filters: data received from the model or read 
-from a netcdf file.
+from a NetCDF file.
 
 \subsection{Enable output}
 \visbutton{Enable output} shows all output nodes of the graph. The output nodes 
-are either the file writer filter: data written to a netcdf file; either the store 
+are either the file writer filter: data written to a NetCDF file; either the store 
 filter: data send back to model.
 
@@ -236 +258 @@
 \end{lstlisting}
 
-In this example, the graph will only include information between the 3rd and 5th timestep.
-These attributes are not madatory. If \verb|build_workflow_graph_start| is not define, the graph will start to record from the first iteration.
-Similarly, the defualt value of \verb|build_workflow_graph_end| is the last iteration of the simulation.
+In this example, the graph will only include information between the 3rd and 5th time step.
+These attributes are not mandatory. If \verb|build_workflow_graph_start| is not define, the graph will start to record from the first iteration.
+Similarly, the default value of \verb|build_workflow_graph_end| is the last iteration of the simulation.
 
 In case that two values of the same attribute are defined, we take the largest range.