[Greater-commits] r3834 - trunk/packaging/doc
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Mon Nov 28 09:22:23 CET 2011
Author: frank
Date: 2011-11-28 09:22:22 +0100 (Mon, 28 Nov 2011)
New Revision: 3834
Modified:
trunk/packaging/doc/Makefile
trunk/packaging/doc/greater-installation.tex
Log:
Updated default installation process dscription. Layout update
Modified: trunk/packaging/doc/Makefile
===================================================================
--- trunk/packaging/doc/Makefile 2011-11-25 09:54:14 UTC (rev 3833)
+++ trunk/packaging/doc/Makefile 2011-11-28 08:22:22 UTC (rev 3834)
@@ -4,7 +4,7 @@
LATEX = pdflatex
# the following line may look strange, but it works!
-#TEXINPUTS = /home/intevation/doc/sty:$(TEXINPU)
+TEXINPUTS = ../../shared/:$(TEXINPU)
DOCUMENTS = greater-installation.pdf
IMAGES =
@@ -21,14 +21,6 @@
%.ps: %.dvi
dvips -o $*.ps $*.dvi
-%.pdf: %.ps
- ( echo "<< /AutoFilterColorImages false"; \
- echo " /EncodeColorImages true"; \
- echo " /DownsampleColorImages false"; \
- echo " /ColorImageFilter /FlateEncode"; \
- echo ">> setdistillerparams" ) \
- | cat - $*.ps | ps2pdf - $*.pdf
-
all: $(DOCUMENTS)
clean:
Modified: trunk/packaging/doc/greater-installation.tex
===================================================================
--- trunk/packaging/doc/greater-installation.tex 2011-11-25 09:54:14 UTC (rev 3833)
+++ trunk/packaging/doc/greater-installation.tex 2011-11-28 08:22:22 UTC (rev 3834)
@@ -1,5 +1,6 @@
%vim:set tw=68:
-\documentclass[a4paper,11pt,oneside,openright,titlepage]{scrbook}
+\documentclass[11pt,oneside,openright,titlepage]{scrbook}
+\usepackage{a4}
\usepackage{lastpage}
\usepackage[latin1]{inputenc}
\usepackage{color}
@@ -8,7 +9,7 @@
\usepackage{fancyhdr}
\usepackage{natbib}
\usepackage{mdwlist}
-\usepackage{Manual}
+\usepackage{sty/Manual}
\usepackage{wasysym}
\def\CVS$#1: #2 ${\expandafter\def\csname CVS#1\endcsname{#2}}
@@ -20,8 +21,9 @@
\newcommand{\documentdate}{13. October, 2011}
\newcommand{\documentversion}{}
-\newcommand{\softwareversion}{GREAT-ER 3.0.0}
+\newcommand{\softwareversion}{GREAT-ER Desktop 3.0.0}
\newcommand{\documentID}{\CVSId}
+\newcommand{\documentname}{Installation}
\definecolor{stepBackground}{gray}{0.8}
@@ -47,7 +49,7 @@
% for some pages latex switches back to pagestyle plain :-(
\fancypagestyle{plain}{%
\fancyhf{} % clear all header and footer fields
- \fancyhead[RO,LE]{\footnotesize GREAT-ER Installation Manual\\ \leftmark}
+ \fancyhead[RO,LE]{\footnotesize GREAT-ER Desktop 3.0 \documentname \\ \leftmark}
\fancyfoot[RO,LE]{\footnotesize Intevation GmbH} % Author
\fancyfoot[CO,CE]{\footnotesize \thepage/\pageref{LastPage}}
% set the document title for the footer here!
@@ -58,9 +60,7 @@
% and now define pagestyle fancy
\fancyhead{} % clear all fields
-\fancyhead[RO,LE]{\footnotesize GREAT-ER Installation Manual\\ \leftmark}
-
-\fancyfoot{}% clear all fields
+\fancyhead[RO,LE]{\footnotesize GREAT-ER 3.0 \documentname \\ \leftmark}
\fancyfoot[RO,LE]{\footnotesize Intevation GmbH} % Author
\fancyfoot[CO,CE]{\footnotesize \thepage/\pageref{LastPage}}
% set the document title for the footer here!
@@ -75,32 +75,40 @@
\parindent0cm
+% TITLE PAGE
{
- \includegraphics[width=0.3\textwidth]{./intevation-logo.png}\\[0.1cm]
- {\tt http://intevation.net}\\[2.0cm]
-}
+% Icon
+\includegraphics[width=\textwidth]{artwork/great-er3_0-title.png}\\[4.5cm]
-% reenter the TITLE here
-{
+% Title
+\begin{center}
\sffamily\bfseries\Large
-% e.g.:
- GREAT-ER\\[0.5cm]
- \huge GREAT-ER Installation Manual\\[0.5cm]
- \large Geo-referenced Regional Exposure Assessment Tool for European Rivers\\[4cm]
+ \Huge \documentname \\[5.5cm]
+\end{center}
}
\thispagestyle{empty}
\vfill
+% Author
{\sffamily\small
- Intevation GmbH\\
- Neuer Graben 17\\
- D-49074 Osnabrück\\
- Germany\\
- \\
- Date: \documentdate
+\begin{tabular}{p{0.3\textwidth}p{0.3\textwidth}p{0.3\textwidth}}
+ \includegraphics[width=0.3\textwidth]{/home/intevation/logos/intevation/intevation_logo.png}
+&
+\parbox[b]{0.3\textwidth}{
+Intevation GmbH\\
+Neuer Graben 17\\
+49074 Osnabrück\\
+Germany\\
+www.intevation.de
}
+&
+{\sffamily\small
+\documentdate
+}
+\end{tabular}
+}
\newpage
@@ -119,7 +127,7 @@
Related documents:
\begin{itemize}
\item Thuban Manual, \\Intevation GmbH, 2011
-\item GREAT-ER Manual, \\Intevation GmbH, 2011
+\item GREAT-ER Desktop Manual, \\Intevation GmbH, 2011
\item GREAT-ER Administration, \\TechniData AG, 2003
\item GREAT-ER Preprocessing Manual, \\Intevation GmbH, 2011
\end{itemize}
@@ -140,37 +148,134 @@
\chapter{Installation on Windows}
\label{chap:installation_windows}
-To install GREAT-ER on your system it is recommended that you execute
+To install GREAT-ER Desktop on your system it is recommended that you execute
the Installer with an administrative account. Or on systems with User
Account Control allow the GREAT-ER-Installer to make changes to your
system. The Database setup will fail if GREAT-ER is not installed with
administrative privileges.
+\section{Installer Start}
+
+Start the installer with a double click in the GREAT-ER Icon:
+\begin{center}
+\includegraphics[scale=\imagescale]{screenshots/greater-icon.png}
+\end{center}
+
+The installer is designed as an assistant of numerous pages collecting
+information relevant for the desired installation. Each page contains a
+reasonable combination of three buttons:
+
+\begin{center}
+\FigNoEntry{
+ \includegraphics[scale=\imagescale]{screenshots/installer-buttons.png}}{
+ GREAT-ER Installer Buttons}
+\end{center}
+
+Usually use "Next" to proceed to the next page. If needed, "Back" allows you to
+go back to the previous page to revise your settings. "Cancel" will abort
+the installation.
+
After starting the installation you will see a welcome screen informing you
about the version you are about to install.
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/setup1.png}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup1.png}}{
GREAT-ER Installation Welcome Screen}
\end{center}
-Please follow the instructions on the screen and accept the license.
+\subsection{Licence Agreement}
+
GREAT-ER is completely Free Software and licensed under
the GNU General Public License (GPL) version 2.
-\section{Installation Types}
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup2.png}}{
+ GREAT-ER Licence Agreement Screen}
+\end{center}
+
+Please follow the instructions on the screen and accept the license.
+
+
+\section{GREAT-ER Desktop Standard Installation}
GREAT-ER can be installed in several variants. For a normal single user
-installation it is recommended to use the "Full Installation" which
-will install everything that is necessary to use GREAT-ER on the system.
+installation it is recommended to use the {\bf "Standard"} installation
+which is selected by default. This variant will install everything that
+is necessary to use GREAT-ER on your desktop system.
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/setup2.png}}{
- GREAT-ER Installation Components}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup3.png}}{
+ GREAT-ER Installation Components and Variants}
\end{center}
+Please simply click "Next" to proceed with the standard setup
+optimized for a local desktop installation. See section
+\ref{sec:installation_variants} below for enhanced and potentially
+more complex variants.
+
+\subsection{Installation Location}
+
+The installer suggest to install GREAT-ER in a folder into the default
+installation location on a Microsoft Windows system.
+All GREAT-ER Data will be placed into this folder.
+
+You can change the folder (click "Browse") if needed.
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup4.png}}{
+ GREAT-ER Installation Location}
+\end{center}
+
+
+\subsection{Shortcuts}
+
+For your convenience, the installer can place shortcuts and icons in
+different places of the user interface. Please select your prefered options.
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup5.png}}{
+ GREAT-ER Shortcut Options}
+\end{center}
+
+
+\subsection{Database Password}
+
+GREAT-ER can be setup with a default password, which might not meet your local
+password security policies. The installer offers to change the database
+password. Please repeat the password to check for correctness.
+
+For your convenience a automatic login on GREAT-ER startup can be configured.
+Please note that this will save the password in plain text under your account.
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup6.png}}{
+ GREAT-ER Database Passwort Settings}
+\end{center}
+
+
+\subsection{Installation}
+
+Please click {\bf "Install"} on the database password page
+to start the installation. A dialog reports the installation progress.
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup6.png}}{
+ GREAT-ER Installation Progress}
+\end{center}
+
+A final dialog reports the successful installation
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/GREAT-ERSetup6.png}}{
+ GREAT-ER 3.0 Desktop Installation completed.}
+\end{center}
+
+
+\section{Installation Variants and Extensions}
+\label{sec:installation_variants}
+
\subsection{GREAT-ER Sediment Ext.}
The GREAT-ER Sediment Extension is a derived version of the
-GREAT-ER Standard Client. Its new features include:
+standard GREAT-ER System. Its new features include:
\begin{itemize}
\item Water column concentrations for sorbed/dissolved
fractions available in the GUI.
@@ -191,15 +296,25 @@
experimental. For more details on the Sediment Extensions please
refer to the GREAT-ER manual.
+The GREAT-ER Sediment Extension can be installed in parallel to the standard
+GREAT-ER Desktop 3.0 with a separate database.
+
+\subsection{Variants}
+
+The default variant for GREAT-ER Desktop is the full installation with all
+components on a single (desktop) computer. The architecture of the
+GREAT-ER system allows advanced setups, on the one hand with some benefits, but
+also with higher administration requirements:
+
\begin{itemize}
\item Full Installation (\textbf{recommended}) \\
-Install the GREAT-ER-Desktop client, a
+Install the GREAT-ER Desktop client, a
PostgreSQL database server, the simulation models and default catchments.
-\item Client only Installation \\
-Install only the GREAT-ER-Desktop client. To
+\item Client-only Installation \\
+Install only the GREAT-ER Desktop client. To
use it for simulations you need to have access to a separate simulation
-server as well as a database. This installation type does {\bf not} provide
+server as well as to a database. This installation type does {\bf not} provide
a standalone client installation.
\item Server Installation \\
Install the PostgreSQL Database for GREAT-ER, with the default datasets
@@ -215,16 +330,6 @@
\end{itemize}
-\subsection{Installation location}
-The installation Dialog will ask you where it should install the Software.
-The default is:
-"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}". All
-GREAT-ER Data will be placed into this directory.\\
-
-After selecting the Installation location and GREAT-ER shortcut options
-you can start the installation. Depending on the selection of your components
-this might take some minutes.
-
\newpage
\section{Configuration}
\subsection{Firewall access}
More information about the Greater-commits
mailing list