[Greater-commits] r3808 - trunk/greater-pre-processing/doc

[scm-commit@wald.intevation.org]

Author: aheinecke
Date: 2011-10-13 20:55:28 +0200 (Thu, 13 Oct 2011)
New Revision: 3808

Modified:
   trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex
   trunk/greater-pre-processing/doc/howto.tex
Log:
Expan Preprocessing section


Modified: trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex
===================================================================
--- trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex	2011-10-13 18:38:10 UTC (rev 3807)
+++ trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex	2011-10-13 18:55:28 UTC (rev 3808)
@@ -134,7 +134,7 @@
 
 \chapter{Introduction}
 
-The GREAT-ER pre-processing is a script-based routine to prepare
+The GREAT-ER Preprocessing is a script-based routine to prepare
 a GREAT-ER catchment dataset from raw data in a pre-defined text format.
 
 This document intends to enable the reader to prepare catchments

Modified: trunk/greater-pre-processing/doc/howto.tex
===================================================================
--- trunk/greater-pre-processing/doc/howto.tex	2011-10-13 18:38:10 UTC (rev 3807)
+++ trunk/greater-pre-processing/doc/howto.tex	2011-10-13 18:55:28 UTC (rev 3808)
@@ -25,17 +25,20 @@
 
 \section{Running the Data Preprocessing}
 
-On Windows a shortcut called \"Catchment Pre Processing\" should
+On Windows a shortcut called \"Catchment Preprocessing\" should
 have been installed in your Start Menu.
 If you deselected installing this shortcut or on another operating
-system you can start the pre-processing wizard by running
+system you can start the Preprocessing Wizard by running
 \"greater-pre-processing.py\" from your installation directory.
 
 Once started you will be asked to select a directory containing
 the catchment you want to pre-process.
 
+This folder must contain a file named catchment.desc.\\
+(see section \ref{sec:catchment.desc} and \ref{sec:gisfilelist} for details).
+
 In the GREAT-ER Windows installation an example dataset of the river Itter
-is placed in the installation directory of greater-pre-processing.
+is placed in the installation directory of GREAT-ER Preprocessing.
 You can copy it to a location where you have write access and use it
 as an example.
 
@@ -44,25 +47,39 @@
      Catchment folder selection dialog}
 \end{center}
 
-This folder must contain a file named catchment.desc.\\
-(see section \ref{sec:catchment.desc} and \ref{sec:gisfilelist} for details).
+Once a folder is selected the Wizard will start.
 
-A basic check will be done and the the first page of the wizard
-will then appear and give information about syntax errors etc.
-
 \begin{center}
 \Fig{\includegraphics[scale=\imagescale]{images/gpp2.png}}{
-     Catchment folder selection dialog}
+     Wizard welcome screen}
 \end{center}
 
+The next page allows you to enter/modify more details with
+regard to the catchment.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/gpp3.png}}{
+     Catchment Configuration dialog}
+\end{center}
+
+A syntax check is then performed to see if all files are in
+the correct Format.
+Clicking next in this dialog will start the Preprocessing.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/gpp4.png}}{
+    Syntax Check
+\end{center}
+
+When the preprocessing is completed you can close the Wizard
+and upload the catchment into the database.
+
 \section{Integrate a catchment into GREAT-ER}
 
-Once the data pre processing is done you can upload your catchment
+This section describes how to upload a cachment
 into the GREAT-ER Database.
 
 Relevant values for the upload
 (GISFILELIST, STRETCH\_TAB, DISCH\_TAB) should have been written into
-catchment.desc
+catchment.desc by the GREAT-ER Preprocessing script
 
 The upload process will perform the following steps:
 \begin{itemize}