Author: bugman
Date: Thu May 1 12:57:34 2008
New Revision: 6021
URL: http://svn.gna.org/viewcvs/relax?rev=6021&view=rev
Log:
Converted the 'How to use relax' part from a chapter to a section.
Modified:
1.3/docs/latex/intro.tex
Modified: 1.3/docs/latex/intro.tex
URL:
http://svn.gna.org/viewcvs/relax/1.3/docs/latex/intro.tex?rev=6021&r1=6020&r2=6021&view=diff
==============================================================================
--- 1.3/docs/latex/intro.tex (original)
+++ 1.3/docs/latex/intro.tex Thu May 1 12:57:34 2008
@@ -1,13 +1,20 @@
-% The how to use relax chapter.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\chapter{How to use relax}
+% Introduction chapter.
+%%%%%%%%%%%%%%%%%%%%%%%
+
+\chapter{Introduction}
+
+
+
+% The relax HOWTO.
+%%%%%%%%%%%%%%%%%%
+
+\section{How to use relax}
% The prompt.
%~~~~~~~~~~~~
-\section{The prompt}
+\subsection{The prompt}
\index{prompt|textbf}
The primary interface of relax is the prompt. After typing \texttt{`relax'}
within a terminal\index{terminal} you will be presented with
@@ -39,7 +46,7 @@
% Python.
%~~~~~~~~
-\section{Python}
+\subsection{Python}
\index{Python|textbf}
relax has been designed such that knowledge about Python is not required to
be able to fully use the program. A few basics though will aid in
understanding relax.
@@ -67,7 +74,7 @@
% User functions.
%~~~~~~~~~~~~~~~~
-\section{User functions}
+\subsection{User functions}
\index{user functions|textbf}
For standard data analysis a large number of specially tailored functions
called `user functions' have been implemented. These are accessible from the
relax prompt by simply typing the name of the function. An example is
\texttt{`help()'}\index{help system}. An alphabetical listing of all
accessible user functions together with full descriptions is presented later
in this manual.
@@ -87,7 +94,7 @@
% The help system.
%~~~~~~~~~~~~~~~~~
-\section{The help system}
+\subsection{The help system}
\index{help system|textbf}
For assistance in using a function simply type
@@ -108,7 +115,7 @@
% Tab completion.
%~~~~~~~~~~~~~~~~
-\section{Tab completion}
+\subsection{Tab completion}
\index{tab completion|textbf}
Tab completion is implemented to prevent insanity as the function names can
be quite long -- a deliberate feature to improve usability. The behaviour of
the tab completion is very similar to that of the bash prompt.
@@ -142,7 +149,7 @@
% The `run'.
%~~~~~~~~~~~
-\section{The `run'}
+\subsection{The `run'}
\index{run|textbf}
Within relax the majority of operations are assigned to a special construct
called a `run'. For example to load relaxation data into the program it must
be committed to a pre-created `run'. Within one instance of relax multiple
runs can be created and various operations performed in sequence on these
runs. This is useful for operations such as model selection whereby the
function \texttt{`model\_selection'} can operate on a number of runs
corresponding to different models and then assign the results to a newly
created run.
@@ -180,7 +187,7 @@
% Scripting.
%~~~~~~~~~~~
-\section{Scripting}
+\subsection{Scripting}
\index{scripting|textbf}
What ever is done within the prompt is also accessible through scripting.
Just type your commands into a text file and then at the terminal type
@@ -234,7 +241,7 @@
% Sample scripts.
%~~~~~~~~~~~~~~~~
-\section{Sample scripts}
+\subsection{Sample scripts}
\index{scripting!sample scripts}
A few sample scripts have been provided in the directory `sample\_scripts'.
These can be copied and modified for different types of data analysis.
@@ -244,7 +251,7 @@
% The test suite.
%~~~~~~~~~~~~~~~~
-\section{The test suite}
+\subsection{The test suite}
\index{test suite}
To test that the program functions correctly, relax possesses an inbuilt
test suite. The suite is a collection of simple tests which execute or probe
different parts of the program checking that the software runs without
problem. The test suite is executed by running relax using the command
\texttt{`relax --test-suite'}.
@@ -254,7 +261,7 @@
% The GUI.
%~~~~~~~~~
-\section{The GUI}
+\subsection{The GUI}
\index{GUI}
relax has been designed primarily for scripting and, as such, no graphical
user interface (GUI) currently exists. The internal structure of the program
has been specifically designed so any type of control mechanism can be easily
added, including a GUI, therefore in the future one may be written. A GUI
will, however, detract from the power and flexibility inherent in the control
by scripting.
@@ -264,7 +271,7 @@
% Access to the internals of relax.
%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-\section{Access to the internals of relax}
+\subsection{Access to the internals of relax}
To enable advanced Python\index{Python} scripting and control almost every
part of relax has been designed in an object oriented fashion. If you would
like to play with internals of the program the entirety of relax is
accessible within the object called \texttt{`self.relax'}. To access the raw
objects within relax which contain the program data the object called
\texttt{`self.relax.data'} stores all the data.
r6021 - /1.3/docs/latex/intro.tex