[Greater-commits] r3804 - trunk/packaging/doc
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Oct 13 19:09:16 CEST 2011
Author: aheinecke
Date: 2011-10-13 19:09:16 +0200 (Thu, 13 Oct 2011)
New Revision: 3804
Modified:
trunk/packaging/doc/greater-installation.tex
Log:
More spelling and style fixes
Modified: trunk/packaging/doc/greater-installation.tex
===================================================================
--- trunk/packaging/doc/greater-installation.tex 2011-10-13 16:39:56 UTC (rev 3803)
+++ trunk/packaging/doc/greater-installation.tex 2011-10-13 17:09:16 UTC (rev 3804)
@@ -11,7 +11,6 @@
\usepackage{Manual}
\usepackage{wasysym}
-
\def\CVS$#1: #2 ${\expandafter\def\csname CVS#1\endcsname{#2}}
\def\CVSId{1.0.0}
@@ -48,7 +47,7 @@
% for some pages latex switches back to pagestyle plain :-(
\fancypagestyle{plain}{%
\fancyhf{} % clear all header and footer fields
- \fancyhead[RO,LE]{\footnotesize \GREATER\ Installation Manual\\ \leftmark}
+ \fancyhead[RO,LE]{\footnotesize GREAT-ER Installation Manual\\ \leftmark}
\fancyfoot[RO,LE]{\footnotesize Intevation GmbH} % Author
\fancyfoot[CO,CE]{\footnotesize \thepage/\pageref{LastPage}}
% set the document title for the footer here!
@@ -59,7 +58,7 @@
% and now define pagestyle fancy
\fancyhead{} % clear all fields
-\fancyhead[RO,LE]{\footnotesize \GREATER\ Installation Manual\\ \leftmark}
+\fancyhead[RO,LE]{\footnotesize GREAT-ER Installation Manual\\ \leftmark}
\fancyfoot{}% clear all fields
\fancyfoot[RO,LE]{\footnotesize Intevation GmbH} % Author
@@ -121,8 +120,8 @@
\begin{itemize}
\item Thuban Manual, \\Intevation GmbH, 2011
\item GREAT-ER Manual, \\Intevation GmbH, 2011
-\item GREAT-ER Administration, \\TechniData AG / Intevation GmbH, 2011
-\item GREAT-ER Cat
+\item GREAT-ER Administration, \\TechniData AG, 2003
+\item GREAT-ER Preprocessing Manual, \\Intevation GmbH, 2011
\end{itemize}
\vfill
@@ -141,12 +140,9 @@
\chapter{Installation on Windows}
\label{chap:installation_windows}
-For the installation of \GREATER\ under Microsoft Windows an installation package
-is provided containing all necessary Data.
-
-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
+To Install GREAT-ER 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 greater is not installed with
an Administrative privileges.
@@ -155,26 +151,26 @@
\begin{center}
\Fig{\includegraphics[scale=\imagescale]{screenshots/setup1.png}}{
- \GREATER\ Installation Welcome screen}
+ GREAT-ER Installation Welcome screen}
\end{center}
-Please follow the instructions on the screen and accept the license
-of \GREATER\. \GREATER\ is completely free software and licensed under
-the GNU General Public License (GPL) version 2.
+Please follow the instructions on the screen and accept the license.
+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
+GREAT-ER can be installed in three variants. For a normal single user
installation it is recommended to use the "Full Installation" which
-will install everything that is necessary to use \GREATER\ on the system.
+will install everything that is necessary to use GREAT-ER on the system.
\begin{center}
\Fig{\includegraphics[scale=\imagescale]{screenshots/setup2.png}}{
- \GREATER\ Installation Components}
+ GREAT-ER 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:
+The GREAT-ER Sediment Extension is a derived Version of the
+GREAT-ER Standard Client. Its new features include:
\begin{itemize}
\item Water column concentrations for sorbed/dissolved
fractions available in the GUI.
@@ -191,17 +187,17 @@
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.
+the components of the GREAT-ER "Standard Version" it has to be viewed
+as an experimental Software. For more details on the Sediment
+Extensions please refer to the GREAT-ER manual.
\begin{itemize}
\item Full Installation (\textbf{recommended}) \\
-Install the \GREATER\-Desktop client, a
-PostgreSQL Database Server the Simulation Models and default catchments.
+Install the GREAT-ER-Desktop client, a
+PostgreSQL Database Server, the Simulation Models and default catchments.
\item Client only Installation \\
-Install only the \GREATER\-Desktop client. To
+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
a standalone client installation.
@@ -220,59 +216,60 @@
\end{itemize}
\subsection{Installation location}
-The installation Dialog will ask you where it should install GREATER and
-it's components. The default is:
+The installation Dialog will ask you where it should install the Software.
+The default is:
"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}" all
Greater Data will be placed into this directory.\\
-After selecting the Installation location and \GREATER\ Shortcut options
+After selecting the Installation location and GREAT-ER Shortcut options
you can start the installation. Depending on the selection of your components
-this can take some minutes.
+this might take some minutes.
\newpage
\section{Configuration}
\subsection{Firewall access}
Depending on your Firewall setup you might be asked on the first start
-of \GREATER to allow firewall access to \"pythonw.exe\". The settings you set
-there will determine who is able to connect to your simulation Server.
-If you allow it other systems in your network will be able to run
-simulations on your system.
+of GREAT-ER to allow firewall access to "pythonw.exe".
+If you allow access other systems in your network will be able to run
+simulations on your system, otherwise you will only be able to run
+simulations locally.
\begin{center}
\Fig{\includegraphics[scale=\imagescale]{screenshots/firewall.png}}{
- Installation with only the standard desktop client.}
+ Windows 7 Firewall configuration dialog.}
\end{center}
\subsection{Automatic Authentication}
-You can use \GREATER\ to automatically authenticate to a database when it
+You can use GREAT-ER 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
+is not an issue. By default the GREAT-ER client will try to connect
to the local database "greater" with username and password "greater".
This is the standard database setup if you have installed the PostgreSQL
-database with the \GREATER\ installer.
+database with the GREAT-ER installer.
To change this behaviour you can edit the greater shortcuts and change the
-command parameters. The Format for the login information is:
+command parameters with which the Software is started.
+The format for the login information is:
\begin{center}
-username/password@<database\_connect\_string> \\
+username/password at database\_connect\_string \\
Example: "mpowers/Ietoye8e at greater" \\
\end{center}
\begin{center}
\Fig{\includegraphics[scale=\imagescale]{screenshots/config1.png}}{
- Automatic Authentication settings}
+ Shortcut preferences with authentication settings}
\end{center}
\newpage
\section{Server Configuration}
-\GREATER\ has two components that can run on a Server as standalone
+GREAT-ER has two components that can run on a Server as standalone
applications. The database and the simulation models. Both are independent
of each other and also do not need to run on the same System.
\subsection{Configure database for remote connections}
The PostgreSQL \footnote{\tt http://www.postgresql.org} database
-coming with \GREATER\ is configured by default to accept only local
+coming with GREAT-ER is configured by default to accept only local
connections.
If you want to run it on a dedicated system you have to configure
the database for remote access.
@@ -283,7 +280,7 @@
\end{center}
To configure your database it is recommended that you use pgadmin3
-which is installed by the \GREATER\ PostgreSQL component.
+which is installed by the GREAT-ER PostgreSQL component.
You can find this application under:\\
\textit{c:\textbackslash Program Files\textbackslash GREAT-ER \textbackslash
postgres9\textbackslash bin\textbackslash pgAdmin3.exe}
@@ -298,11 +295,12 @@
\end{center}
To change the password to something secure. Use the
-\"File->Change Password\" menu option.
+"$File \rightarrow Change Password$" menu option.
To modify the connection settings for your database you can edit the
-Server configuration by choosing \"Tools->Server Configuration->pg\_hba.conf\"
-and add an entry with the field \"IP-Address\" set to the Network where you
+Server configuration by choosing
+"$Tools \rightarrow Server Configuration \rightarrow pg\_hba.conf$"
+and add an entry with the field "IP-Address" set to the Network where you
you want to accept connections from and restart the server afterwards.
\begin{center}
@@ -316,13 +314,13 @@
to administrate your Database.
\subsection{Simulation server setup}
-\GREATER\ has the ability to remotely run simulation calculations.
+GREAT-ER 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 {\bf 10101} if your firewall rules
allow it.
-On the client system you can select "Simulation -> Select Simulation Server"
+On the client system you can select "$Simulation \rightarrow Select Simulation Server$"
from the menu to connect to a simulation server on a another machine.
\begin{center}
@@ -332,7 +330,7 @@
\subsection{Connect to a remote database}
In the authentication dialog the format to describe a remote database
-connection is: databasename at ip:port \\
+connection is: \\databasename at ip:port\\
For example:\\
{\bf greater-sediment at 192.168.0.2:5432}\\
@@ -340,11 +338,11 @@
connections on port 5432 with the ip-address 192.168.0.2
\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\"
+To Uninstall GREAT-ER 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.\\
It will start an Uninstallation Wizard that will allow you to completely
-remove \GREATER\ and all of its components. \\
+remove GREAT-ER and all of its components. \\
You can select if you also want to uninstall the PostgreSQL Database.\\
More information about the Greater-commits
mailing list