[Greater-commits] r3794 - trunk/packaging/doc
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Oct 13 10:58:09 CEST 2011
Author: aheinecke
Date: 2011-10-13 10:58:08 +0200 (Thu, 13 Oct 2011)
New Revision: 3794
Modified:
trunk/packaging/doc/greater-installation.tex
Log:
Expand the installation documentation for the release
Modified: trunk/packaging/doc/greater-installation.tex
===================================================================
--- trunk/packaging/doc/greater-installation.tex 2011-10-06 14:04:53 UTC (rev 3793)
+++ trunk/packaging/doc/greater-installation.tex 2011-10-13 08:58:08 UTC (rev 3794)
@@ -13,13 +13,13 @@
\def\CVS$#1: #2 ${\expandafter\def\csname CVS#1\endcsname{#2}}
-\CVS$Id: svn trunk $
+\CVS$Id: 1.0.0$
%----------------------------------------------
% Document DATE and VERSION
% set these values when releasing a new version
-\newcommand{\documentdate}{19. July, 2011}
+\newcommand{\documentdate}{13. October, 2011}
\newcommand{\documentversion}{}
\newcommand{\softwareversion}{GREAT-ER 3.0.0}
\newcommand{\documentID}{\CVSId}
@@ -141,46 +141,92 @@
\chapter{Installation on Windows}
\label{chap:installation_windows}
For the installation of \GREATER\ under Microsoft Windows an installation package
-is provided containing all neccessary Data. If you did not recive a copy of this
-installer along with this document you can obtain it from the \GREATER\ Homepage.
-\footnote{\tt http://www.great-er.org}
+is provided containing all necessary Data.
-To Install \GREATER\ on your system it is reccommended that you execute
+To Install \GREATER\ on your system it is recommended that you execute
the Installer with an administrative account. Or on systems with User
Account Control allow the \GREATER\-Installer to make changes to your
-system.
+system. The Database setup will fail if greater is not installed with
+an Administrative privileges.
-The installation Dialog will ask you where it should install GREATER and
-it's components. The default is:
-"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}" all
-Greater Data will be placed into this directory.
+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.eps}}{
+ \GREATER\ Installation Welcome screen}
+\end{center}
+
+Please follow the instructions on the screen and accept the license
+of GREAT-ER. GREAT-ER is completely free software and licensed under
+the GNU General Public License (GPL) version 2.
+
\section{Installation Types}
\GREATER\ can be installed in three variants. For a normal single user
-installation it is reccomended to use the "Full Installation" which
+installation it is recommended to use the "Full Installation" which
will install everything that is necessary to use \GREATER\ on the system.
-\textit{All installation types Install Python 2.7 which provides the
-runtime enviornment for GREAT-ER. If you already have Python 2.7
-installed you can disable the installation of this component by
-unchecking it in the installation Dialog but this is not
-recommended.}
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/setup2.eps}}{
+ \GREATER\ Installation Components}
+\end{center}
+\subsection{GREAT-ER Sediment Ext.}
+The \GREATER\ Sediment Extension is a derived Version of the
+\GREATER\ Standard Client. Its new features include:
+\begin{itemize}
+ \item Water column concentrations for sorbed/dissolved
+ fractions available in the GUI.
+
+ \item Derived per stretch sediment concentrations based on
+ equilibrium partitioning.
+
+ \item Various modes to specify the most important parameter for
+ fractioning: Suspended solids concentration.
+
+ \item Include diffuse inputs as provided by the
+ TERRACE\footnote{{\bf TE}rrestrial {\bf R}unoff
+ Modelling for {\bf R}isk {\bf A}ssessment
+ of {\bf C}hemical {\bf E}xposure} project.
+\end {itemize}
+Since those extensions did not undergo the same review process as
+the components of the \GREATER\ standard it has to be viewed
+as an experimental Version. For more details on the Sediment
+Extensions please refer to the \GREATER\ Manual.
+
\begin{itemize}
\item Full Installation (\textbf{recommended}) \\
Install the \GREATER\-Desktop client, a
PostgreSQL Database Server the Simulation Models and default catchments.
-\item Client Installation \\
+
+\item Client only Installation \\
Install only the \GREATER\-Desktop client. To
-use it for simulations you need to have access to a seperate simulation
-Server as well as a seperate Database.
-\item Server Installation
-Install the Postgres Database for GREAT-ER, with
-the default datasets.
+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
+a standalone client installation.
+\item Server Installation \\
+Install the PostgreSQL Database for GREAT-ER, with the default datasets.
+And the Administration Tool.
+\item Custom Installation \\
+To install only specific components you can deselect the parts you do
+not wish to install by unchecking the checkbox of that component.
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/setup3.eps}}{
+ Installation with only the standard desktop client.}
+\end{center}
+
\end{itemize}
+\subsection{Installation location}
+The installation Dialog will ask you where it should install GREATER and
+it's components. The default is:
+"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}" all
+Greater Data will be placed into this directory.
+
\newpage
-\subsection{Automatic Authentification}
+\section{Configuration}
+\subsection{Automatic Authentication}
You can use \GREATER\ to automatically authenticate to a database when it
is started. This can be useful for local installations where security
is not an issue. By default the \GREATER\ client will try to connect
@@ -195,8 +241,12 @@
username/password@<database\_connect\_string> \\
Example: "mpowers/Ietoye8e at 192.168.10.50:5423" \\
\end{center}
-TODO: Screenshot
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config1.eps}}{
+ Automatic Authentication settings}
+\end{center}
+
\newpage
\section{Server Configuration}
\GREATER\ has two components that can run on a Server as standalone
@@ -220,7 +270,7 @@
or when Shortcuts were installed in your \GREATER\ Start Menu folder.
When launching pgAdminIII you will see one Server (localhost:5432)
-to which you can connect by doubleclicking on its Icon.
+to which you can connect by double-clicking on its Icon.
The default password for the user \emph{greater} is \textit{greater}.
To change the password to something secure. Use the
@@ -232,69 +282,61 @@
There are also options to finely configure access rights for just some users
or Databases, please refer to the PostgreSQL Documentation\footnote{\tt
http://www.postgresql.org/docs/9.0/static} for more information.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config2.eps}}{
+ PostgreSQL connection settings}
+\end{center}
-TODO: Screenshot
-
\subsection{Simulation server setup}
+\GREATER\ has the ability to remotely run simulation calculations.
+To run a remote simulation you have to launch the client on the server
+and connect it to a database. Once it is connected to a database it will
+accept TCP connections on port TODO if your firewall rules
+allow it.
-TODO:
+On the client system you can select \"Simulation -> Select Simulation Server\"
+from the menu to connect to a simulation server on a another machine.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config3.eps}}{
+ Simulation server connection settings}
+\end{center}
+
\newpage
-\chapter{Uninstallation}
-To uninstall \GREATER\ you can either use the Microsoft Windows Software
+\chapter{Uninstallation on Microsoft Windows}
+To Uninstall \GREATER\ you can either use the Microsoft Windows Software
(Programs and Functions on Windows Vista/7) Menu or run the \"Uninstall.exe\"
-located in your Installation Directory.
+located in your Installation Directory.\\
+It will start an Uninstallation Wizard that will allow you to completely
+remove \GREATER\ and all of its components. \\
+You can select if you also want to uninstall the PostgreSQL Database.\\
-\chapter{Manual Installation}
+{\bf Warning:} This will remove all you local modified data saved sessions and catchments!
-\section{Dependencies}
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/uninstall1.eps}}{
+ Uninstallation Options.}
+\end{center}
+\newpage
\section{Database Setup}
-\GREATER\ is implemented in Python and makes use of various Free Software
-add-ons to this programming language. See the {\tt\small README} files
-of the packages {\sffamily GREAT-ER}, {\sffamily GREAT-ERModel},
-{\sffamily GREAT-ER-DB}, {\sffamily dagreater} and {\sffamily Thuban} for details.
-In conclusion required are:
-\begin{itemize}
- \item Python\footnote{\tt http://www.python.org}
- (version 2.2.1 or higher)
- \item wxPython\footnote{\tt http://www.wxpython.org}
- (version 2.4.0 or higher,
- this implies a wxWindows of the same version)
- \item SQLite\footnote{\tt http://www.hwaci.com/sw/sqlite/}
- (version 2.8)
- \item SQLite Python bindings\footnote{\tt http://pysqlite.sourceforge.net/}
- (version 0.4.1)
- \item proj\footnote{\tt http://www.remotesensing.org/proj/} (version 4.4)
- \item Python Numeric Package\footnote{\tt http://numpy.sourceforge.net}
- (version 23.0)
- \item Python Imaging
- Library\footnote{\tt http://www.pythonware.com/products/pil/}
- (PIL, version 1.14)
- \item ReportLab\footnote{\tt http://reportlab.sourceforge.net/}
- (version 1.17)
- \item Twisted\footnote{\tt http://twistedmatrix.com/} (version 1.0.0)
- \item Oracle 8.x client libraries.
-\end{itemize}
+The default database setup after installation includes two databases.
-\section{Installation without installer package\label{setup}}
-\begin{enumerate}
- \item Install Thuban so that the thubaninit module is on
- Python's module path. One way to do that is to use the
- {\tt\small python setup.py install\_local}
- command to build Thuban and to add the directory
- containing the Thuban sources to the PYTHONPATH
- environment variable.
+\begin{center}
+\begin{tabular}{|c|c|c|c|}
+\hline
+Database Name & Default Username & Default Password & Comment \\
+\hline
+greater & greater & greater & The standard database with default catchments\\
+\hline
+greater-sediment & greater & greater & Extended Database with parameters for the sediment extension\\
+\hline
+\end{tabular}
+\end{center}
- \item Put the packages GREAT-ER-DB, GREAT-ERModel and
- GREAT-ER into the same directory.
-
- \item Build GREAT-ER-DB (see {\tt\small GREAT-ER-DB/README} for
- details).
-\end{enumerate}
-
+\newpage
\renewcommand{\documentID}{gnufdl.tex version 1.2}
\include{gnufdl}
\renewcommand{\documentID}{\CVSId}
More information about the Greater-commits
mailing list