Changeset 1278

Timestamp:

07/09/09 17:13:18 (16 years ago)

Author:

Mathieu Morlighem

Message:

update beginning

File:

• issm/trunk/doc/userguide/userguide.tex (modified) (6 diffs)

issm/trunk/doc/userguide/userguide.tex

@@ -1 +1 @@
 %%% Debut du preambule %%%
 
-\documentclass[letterpaper]{report}     % Classe du document
-\usepackage[T1]{fontenc}            % Encodage de sortie (l'encodage T1 convient mieux aux langues autres que l'Anglais)
-\usepackage{aeguill,aecompl}        % Fontes virtuelles (nuit aux recherches et aux copies de texte dans le document PDF) pour PDF:
-                                    % ameliore la qualite de la visualisation avec Acrobat Reader
-
-%\hypersetup{colorlinks=true,linkcolor=blue,citecolor=magenta}
-
-
+\documentclass[letterpaper]{report}
+\usepackage[T1]{fontenc}
+\usepackage{aeguill,aecompl}
 \title{ISSM documentation}
 \author{Larour, Morlighem, Seroussi, Khazendar}
@@ -25 +20 @@
 \usepackage{fancyhdr}
 
-\lhead{\leftmark{}} %en haut a gauche, titre de section
-\rhead{\thepage}   %en haut a droite, page
-\lfoot{NASA - Jet Propulsion Laboratory} %en bas a gauche
-\rfoot{\scriptsize{\today}} %en bas a droite
-\cfoot{ISSM Documentation} %en bas, au milieu
-\setcounter{tocdepth}{4}                     %pour afficher la table des matiere au niveau subsection
+\lhead{\leftmark{}} 
+\rhead{\thepage}
+\lfoot{NASA - Jet Propulsion Laboratory} 
+\rfoot{\scriptsize{\today}}
+\cfoot{ISSM Documentation}
+\setcounter{tocdepth}{4}
 \setcounter{secnumdepth}{4}
 
@@ -72 +67 @@
 \smallskip
 {\bf \large H\'el\`ene Seroussi$^{2,4}$} \\
-\smallskip
-{\bf \large Ala Khazendar$^{2}$} \\
 \smallskip
 {\bf \large \'Eric Rignot$^{2,3}$} \\
@@ -92 +85 @@
 $^{4}$Laboratoire de M\'ecanique des sols, Structures et  mat\'eriaux (MSSMat)\\
 \'Ecole Centrale Paris, CNRS UMR 8579\\
-Grande Voie des Vignes, 92295 Châtenay-Malabry Cedex, FRANCE\\
+Grande Voie des Vignes, 92295 Chtenay-Malabry Cedex, FRANCE\\
 
 \vspace{0.5cm}
@@ -112 +105 @@
 \tableofcontents
 
-%\pagestyle{headings}
-%\chapter*{Introduction}
-%\markboth{CHAPTER 1: Introduction}{}
-%\vspace{.5in}
-
 \pagestyle{headings}
 \chapter{Installation}
@@ -124 +112 @@
 \vspace{.5in}
 
-\section{Fetching code from repository}  
-\label{Fetching_Code_From_Repository}
-
-$ISSM$ is actively managed using a code versioning  system called CVS. The code is stored in a repository, and can 
-be remotely fetched, modified, updated, and uploaded. This allows for multiple users to develop the code in an 
-organized way. In order to fetch a version of the code, users will need to install CVS on their machine. This versioning 
-system is available at the following address: \url{http://www.nongnu.org/cvs/}. 
-Once CVS, issue the following command:
-\begin{verbatim}> cvs -d useraccount@wilkes.jpl.nasa.gov:/home/larour/Ice_Repository  co -r ice2 -P ice1 \end{verbatim}
-This command will download the stable version of the code $ISSM$ named $ice2$ from the repository on the wilkes machine, located 
-in the $/home/larour/Ice_Repository$ directory, onto the current local directory (replace $useraccount$ by your user name on wilkes). Users are free to choose whichever location they want and to rename $ice1$.  Users should not forget the $-P$ option. Failing to do so would allow CVS to fetch empty directories. 
-This would result in a code structure not intended by the developers.
-
-\section{Setting up $ISSM$}  
-In the main directory of $ISSM$ (initially named $ice1$), open the file $install.sh$ and modify the configuration if you need to:
-\begin{itemize}
-\item $CONFIG="config\_linux32.mk"$ for a 32 bits linux OS, 
+\section{Downloading the code}  
+
+To download \emph{ISSM}, you can either use the link on in the upper menu "Installation/Download" on \emph{ISSM} website: \url{www.issm.jpl.nasa.gov} or use \href{http://subversion.tigris.org/}{SVN}. 
+\emph{ISSM} is actively managed using a code versioning  system called \href{http://subversion.tigris.org/}{SVN}.
+The code is stored in a repository, and can be remotely fetched, modified, updated, and uploaded.
+This allows for multiple users to develop the code in an organized way.
+In order to fetch a version of the code, users will need to install \href{http://subversion.tigris.org/}{SVN} on their machine.
+Once \href{http://subversion.tigris.org/}{SVN} has been installed, \emph{ISSM} can be downloaded by the following command:
+\begin{verbatim}$ svn checkout http://s383-rhat/issm/svn\end{verbatim}
+This command will download the last version of the code \emph{ISSM} from the repository, onto the current local directory.
+Users are free to choose whichever location they want and to rename issm.
+
+\section{Configuration of your .bashrc}
+In order for ISSM to work correctly, you should add the following lines in your shell
+environment script (.bashrc or .cshrc).
+\begin{verbatim}#ISSM
+export ISSM_DIR=ISSMPATH
+source $ISSM_DIR/etc/environment.sh\end{verbatim}
+Where \verb| ISSMPATH | is the path of ISSM main directory (ex: /home/user1/svn/issm/trunk).
+When this is done, type in the prompt:
+\begin{verbatim}$ bash\end{verbatim}
+
+\section{Setting up \emph{ISSM}}  
+In the main directory of \emph{ISSM} (initially named $ice1$), open the file $install.sh$ and modify the configuration if you need to:
+\begin{itemize}
+\item $CONFIG="config\_linux32.mk"$ for a 32 \verb| test test | test bits linux OS, 
 \item $CONFIG="config\_linux64.mk"$ for a 64 bits linux OS,
 \item $CONFIG="config\_mac.mk"$ for Mac OS X