[Greater-commits] r3801 - trunk/greater-pre-processing/doc
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Oct 13 18:24:04 CEST 2011
Author: aheinecke
Date: 2011-10-13 18:24:04 +0200 (Thu, 13 Oct 2011)
New Revision: 3801
Modified:
trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex
trunk/greater-pre-processing/doc/howto.tex
trunk/greater-pre-processing/doc/resultfiles.tex
trunk/greater-pre-processing/doc/sourcefiles.tex
trunk/greater-pre-processing/doc/theory.tex
Log:
Update documentation for greater 3.0
Modified: trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex
===================================================================
--- trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex 2011-10-13 14:29:03 UTC (rev 3800)
+++ trunk/greater-pre-processing/doc/greater-preprocessing-manual.tex 2011-10-13 16:24:04 UTC (rev 3801)
@@ -120,7 +120,7 @@
Version: \documentversion \\
Date: \documentdate \\
-Authors: Jan-Oliver Wagner $\cdot$ Frank Koormann
+Authors: Jan-Oliver Wagner $\cdot$ Frank Koormann $\cdot$ Andre Heinecke
\vfill
@@ -152,6 +152,11 @@
\verb"http://great-er.intevation.org/"
+\begin{center}
+{\bf Note:} {\texthl The Catchment Format between Version 2 of
+the GREAT-ER Software and Version 3 stayed the same. So when preparing
+data for GREAT-ER III the correct format is 2.0}
+\end{center}
%
% *************************************************************************
%
Modified: trunk/greater-pre-processing/doc/howto.tex
===================================================================
--- trunk/greater-pre-processing/doc/howto.tex 2011-10-13 14:29:03 UTC (rev 3800)
+++ trunk/greater-pre-processing/doc/howto.tex 2011-10-13 16:24:04 UTC (rev 3801)
@@ -1,12 +1,12 @@
-\renewcommand{\documentID}{\$Id: howto.tex,v 1.9 2007-06-06 16:30:05 frank Exp $ $}
+\renewcommand{\documentID}{}
\chapter{How-To}
\label{chap:HowTo}
-
\section{Software Requirements}
\begin{itemize}
- \item Python $\ge$ 2.2.1
+ \item Python $\ge$ 2.7
+ \item wxWidgets $\ge$ 2.8
\item GNU Awk $\ge$ 3.1.0
\item gen2shp $\ge$ 0.3.0 \newline
(\verb"http://intevation.de/~jan/gen2shp/")
@@ -19,78 +19,51 @@
\item GNU sh-utils (echo) $\ge$ 2.0.11
\end{itemize}
-(all the programs must be somewhere in your search path)
+(If you've installed GREAT-ER with the Windows installer
+all required Software was installed automatically
+together with greater-pre-processing)
-\section{Prerequisites}
-\label{sec:prerequisites}
-
-As a first step you have to copy greater-pre-processing.py somewhere
-into you PATH or extend the PATH to where you have installed
-the greater-pre-processing package:
-
- \verb+cp greater-pre-processing.py /some/where/in/your/search/path+
-
- OR
-
- \verb+export PATH=$PATH:/some/where/greater-pre-processing+
-
-Next, set this environment variable that points to where you have
-installed the greater-pre-processing package:
-
- \verb+export GREATER_PRE_PROC=/some/where/greater-pre-processing+
-
-You then are able to execute
-
- \verb+greater-pre-processing.py+
-
-in a directory with the pre-defined files for your catchment
-(you will be given further info on how to use the program).
-
\section{Running the Data Preprocessing}
-{\footnotesize
-\begin{verbatim}
-$ greater-pre-processing.py help
-greater-pre-processing 1.2.0
+On Windows a shortcut called \"Catchment Pre Processing\" 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
+\"greater-pre-processing.py\" from your installation directory.
-Found 'catchment.desc':
- ID = aire
- Name = Catchment of River Aire including River Calder
- Description = The Aire catchment is in Yorkshire, UK
- Format version src = 1.0
- Format version result = 2.0
-description complete.
+Once started you will be asked to select a directory containing
+the catchment you want to pre-process.
-greater-pre-processing [check|help|run|run-without-cleanup|clean]
- help print this text
- check test for completeness and correct syntax of source files
- run execute catchment pre-processing
- run-without-cleanup execute catchment pre-processing not removing
- temporary files
- clean remove all temporary and all results files
-\end{verbatim}
-}
+In the GREAT-ER Windows installation an example dataset of the river Itter
+is placed in the installation directory of greater-pre-processing.
+You can copy it to a location where you have write access and use it
+as an example.
-\section{Integrate a catchment into GREAT-ER 1.0}
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/gpp1.png}}{
+ Catchment folder selection dialog}
+\end{center}
-First, make sure, that OUT-VERSION in catchment.desc
-is set to 1.0, then process the data.
+This folder must contain a file named catchment.desc.\\
+(see section \ref{sec:catchment.desc} and \ref{sec:gisfilelist} for details).
-Now copy all files *.shp, *.shx, *.dbf into \%GHOME\%/catchments/ID
-where ID is the name of the new catchment.
-Finally, add the new catchment to \%GHOME\%/catchments.dbf,
-see http://great-er.intevation.org/catchments\_dbf.html for how to
-do this.
+A basic check will be done and the the first page of the wizard
+will then appear and give information about syntax errors etc.
-\section{Integrate a catchment into GREAT-ER 2.0}
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/gpp2.png}}{
+ Catchment folder selection dialog}
+\end{center}
-First, make sure, that OUT-VERSION in catchment.desc
-is set to 2.0, then process the data.
+\section{Integrate a catchment into GREAT-ER}
-Before uploading the data make sure that relevant values
-(GISFILELIST, STRETCH\_TAB, DISCH\_TAB) are set in catchment.desc
-(see section \ref{sec:catchment.desc} and \ref{sec:gisfilelist} for details).
+Once the data pre processing is done you can upload your catchment
+into the GREAT-ER Database.
+Relevant values for the upload
+(GISFILELIST, STRETCH\_TAB, DISCH\_TAB) should have been written into
+catchment.desc
+
The upload process will perform the following steps:
\begin{itemize}
\item Create a new Catchment entry in the CATCH\_TAB.
@@ -101,22 +74,35 @@
\item Upload all GIS data (shapefiles) and additional binary files.
\end{itemize}
-Change to the directory of the data to be uploaded. If path values are set
-according to the prerequisites (section \ref{sec:prerequisites}), run:
+To start the upload process either run \"Upload Catchment\" from the
+Start Menu or execute upload-cachment.py from your greater-pre-processing
+directory.
- \verb+upload-catchment.py+
+The Wizard will first ask for the directory containing the catchment.desc
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/upload1.png}}{
+ Catchment folder selection dialog}
+\end{center}
-If running the upload under MicroSoft Windows it might be necessary to include
-the Python binary, e.g.:
+On the next page you will be asked to enter the database credentials.
+In a default Microsoft Windows installation those are user greater
+with password greater for the database greater.
- \verb+..\..\Python22\python.exe ..\..\upload\upload-catchment.py+
-\\
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/upload2.png}}{
+ Database connection settings}
+\end{center}
-A wizard guides you through the upload:
-\begin{itemize}
-\item Upload information screen
-\item Parameters for database connection
-\item Upload confirmation. Selecting {\em Next} the upload is started!
-\item After displaying the progress the status of the upload is reported.
-\end{itemize}
+The upload confirmation checked some additional values to ensure
+that your data is correctly prepared and ready to be uploaded.
+Selecting \"Next\" in this dialog will start the upload.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/upload3.png}}{
+ Upload confirmation}
+\end{center}
+After displaying the progress the status of the upload is reported.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{images/upload3.png}}{
+ Upload confirmation}
+\end{center}
Modified: trunk/greater-pre-processing/doc/resultfiles.tex
===================================================================
--- trunk/greater-pre-processing/doc/resultfiles.tex 2011-10-13 14:29:03 UTC (rev 3800)
+++ trunk/greater-pre-processing/doc/resultfiles.tex 2011-10-13 16:24:04 UTC (rev 3801)
@@ -1,4 +1,4 @@
-\renewcommand{\documentID}{\$Id: resultfiles.tex,v 1.3 2003-07-17 14:21:58 jan Exp $ $}
+\renewcommand{\documentID}{}
\chapter{Catchment Result Files Formats}
@@ -6,7 +6,7 @@
OUT-VERSION = 1.0: creates catchment datasets compatible with GREAT-ER 1.
-OUT-VERSION = 2.0: creates catchment datasets compatible with GREAT-ER 2.
+OUT-VERSION = 2.0: creates catchment datasets compatible with GREAT-ER 2 and 3.
The difference is additional columns down1 and down2 in river.dbf
and different Stretch-Types for lakes. Furthermore, no background
file backgroundlst.dbf is created.
@@ -19,7 +19,7 @@
Another special results file is catchment.thuban, which is a session
file for Thuban, a viewer for geographic information (thuban.intevation.org).
-GREAT-ER 2 is implemented ontop of Thuban.
+GREAT-ER 3 is implemented ontop of Thuban.
\section{Map Layers}
@@ -92,11 +92,11 @@
\section{Discharge Classes, File wwtp.dbf}
This file is created as a constant file by the pre-processing.
-For GREAT-ER 2, the classes are already incorporated into the
+For GREAT-ER 3, the classes are already incorporated into the
database and will likely not require an update.
For units and further description, please refer to the corresponding
-documentation of GREAT-ER 1 and GREAT-ER 2, respectively.\\
+documentation of GREAT-ER 3.\\
\begin{tabular}{l|l|p{10cm}}
Fieldname & Type & Description \\
@@ -135,11 +135,11 @@
\section{River Classes, File rivclass.dbf}
This file is created as a constant file by the pre-processing.
-For GREAT-ER 2, the classes are already incorporated into the
+For GREAT-ER 3, the classes are already incorporated into the
database and will likely not require an update.
For units and further description, please refer to the corresponding
-documentation of GREAT-ER 1 and GREAT-ER 2, respectively.\\
+documentation of GREAT-ER 3.\\
\begin{tabular}{l|l|p{10cm}}
Fieldname & Type & Description \\
Modified: trunk/greater-pre-processing/doc/sourcefiles.tex
===================================================================
--- trunk/greater-pre-processing/doc/sourcefiles.tex 2011-10-13 14:29:03 UTC (rev 3800)
+++ trunk/greater-pre-processing/doc/sourcefiles.tex 2011-10-13 16:24:04 UTC (rev 3801)
@@ -1,4 +1,4 @@
-\renewcommand{\documentID}{\$Id: sourcefiles.tex,v 1.7 2007-06-06 16:30:05 frank Exp $ $}
+\renewcommand{\documentID}{}
\chapter{Catchment Source Files Formats}
\label{chap:PredefinedFormats}
@@ -34,7 +34,7 @@
NAME=Catchment of River Went
DESCRIPTION=The Went catchment is a small, rural area in Yorkshire, UK.
IN-VERSION=1.0
-OUT-VERSION=1.0
+OUT-VERSION=2.0
\end{verbatim}
{\bf ID} is the basename for the actual data source files suffixed with
@@ -47,7 +47,7 @@
{\bf OUT-VERSION} defines the output format.
The information set has been enhanced for uploading catchment data into
-a \GREATER\ 2.0 database. A sample of additional pairs of keys and values:
+a \GREATER\ 3.0 database. A sample of additional pairs of keys and values:
\begin{verbatim}
STRETCH_TAB=river2.att
Modified: trunk/greater-pre-processing/doc/theory.tex
===================================================================
--- trunk/greater-pre-processing/doc/theory.tex 2011-10-13 14:29:03 UTC (rev 3800)
+++ trunk/greater-pre-processing/doc/theory.tex 2011-10-13 16:24:04 UTC (rev 3801)
@@ -1,4 +1,4 @@
-\renewcommand{\documentID}{\$Id: theory.tex,v 1.5 2003-07-17 14:20:42 jan Exp $ $}
+\renewcommand{\documentID}{}
\chapter{Preprocessing Basics}
More information about the Greater-commits
mailing list