Merge pull request #948 from vkbo/doc_fixes

rdemaria · web-flow · commit 6bc81064bc13 · 2019-08-23T09:51:06.000+02:00
Doc fixes
diff --git a/README.md b/README.md
@@ -64,7 +64,8 @@ In applying this licence, CERN does not waive the privileges and immunities gran
 
 ## Quick Build
 
-To build the standard release version of SixTrack with default options, run the script `defaultBuild.sh`.
+To build the standard release version of SixTrack, run the script `cmake_six` with no additional options.
+This will build the SixTrack 64 bit executable with the singletrackfile, zlib support, as well as the crlibm math library.
 
 ## Resources
 
diff --git a/doc/build_sixtrack.md b/doc/build_sixtrack.md
@@ -30,19 +30,20 @@ Builds SixTrack release with gfortran, with checkpoint/restaring support and wit
 
 ### Options Enabled by Default
 
-* **TILT**:          Allow elements to be tilted (by error
-* **FAST**:          Which implementation of drifts to use in thin6d
+* **TILT**:          Allow elements to be tilted (by error)
 * **CRLIBM**:        Use correctly rounded libmath instead of system libmath
 * **SIXDA**:         Build differential algebra version (NOT dynamic aperture!)
 * **STF**:           Single Track File. Write all tracks for postprocessing to singletrackfile.dat instead of 32 separate files (fort.59 - fort.90). This option is required for more than 64 particles.
+* **ZLIB**:          Link with zlib and minizip, and is required for BOINC and the ZIPF.
+* **NAFF**:          Link to external NAFFlib for FMA.
+* **DISTLIB**:       Link to external DISTlib for the beam distribution.
+* **HASHLIB**:       Build the md5 hash library (used for tests and BOINC).
 
 ### Options Disabled by Default
 
 * **BUILD_TESTING**: Enable the test suite.
 * **BOINC**:         Builds BOINC version of SixTrack.
 * **CR**             Enables checkpoint/restart support. Required for BOINC.
-* **LIBARCHIVE**:    Link with LIBARCHIVE, and is required for BOINC and ZIPF block if ZIPF is off.
-* **ZLIB**:          Link with zlib and minizip, and is required for BOINC and the ZIPF block if LIBARCHIVE is off.
 * **BEAMGAS**:       Beam-gas scattering.
 * **FIO**:           Use FortranIO from Fortran2003 to correctly round ASCII input/output. this option overrides CRLIBM when reading/writing.
 * **CERNLIB**:       Link to external CERNLIB library for PAW plots. Otherwise use internally defined dummy functions.
@@ -52,9 +53,9 @@ Builds SixTrack release with gfortran, with checkpoint/restaring support and wit
 * **HDF5**:          Adds support for the HDF5 block which enables writing output to a single HDF5 file.
 * **ROOT**:          Adds support for writing to ROOT files. Experimental and undocumented.
 * **MERLINSCATTER**: Interaction physics for collimation from Merlin.
-* **G4COLLIMAT**:    Interaction physics for collimation from Geant4.
+* **G4COLLIMATION**: Interaction physics for collimation from Geant4.
 * **FLUKA**:         Couple to FLUKA for beam collimation.
-
+* **PYTHIA**:        Link with Pythia8 for SCATTER module.
 
 ### Binary Type
 
diff --git a/doc/old-SixTest-README.txt b/doc/old-SixTest-README.txt
diff --git a/doc/user_manual/chInitialConditions.tex b/doc/user_manual/chInitialConditions.tex
@@ -49,7 +49,7 @@ \section{Simulation Parameters} \label{Input:SIMU}
 \setlength\LTleft{0pt}
 \setlength\LTright{0pt}
 \begin{longtable}{@{\extracolsep{\fill}}|l|p{10cm}|l|}
-    \caption{Available arguents in the SIMU block.}
+    \caption{Available arguments in the SIMU block.}
     \label{Table:SIMU} \\*
     \hline
     \rowcolor{blue!30}
@@ -1115,7 +1115,7 @@ \subsection{Filling the Columns}
     \texttt{INT} & \texttt{value [first last]} \\*
     \hline
     \multicolumn{2}{|>{\raggedright}p{\textwidth}|}{%
-        Sets all values to a fixed integer.\\
+        Sets all values to a fixed integer.
         Can be used with column formats \texttt{ION\_A}, \texttt{ION\_Z}, \texttt{CHARGE} and \texttt{PDGID}.
     } \\*
     \hline
@@ -1124,7 +1124,7 @@ \subsection{Filling the Columns}
     \texttt{FLOAT} & \texttt{value [first last]} \\*
     \hline
     \multicolumn{2}{|>{\raggedright}p{\textwidth}|}{%
-        Sets all values to a fixed floating point value.\\
+        Sets all values to a fixed floating point value.
         Can be used with all floating point column formats.
     } \\*
     \hline
@@ -1133,7 +1133,7 @@ \subsection{Filling the Columns}
     \texttt{GAUSS} & \texttt{sigma mu [cut] [first last]} \\*
     \hline
     \multicolumn{2}{|>{\raggedright}p{\textwidth}|}{%
-        Generates a normal random distribution with width \texttt{sigma} and offset \texttt{mu}, with an optional sigma \texttt{cut}.\\
+        Generates a normal random distribution with width \texttt{sigma} and offset \texttt{mu}, with an optional sigma \texttt{cut}.
         Can be used with all floating point column formats except \texttt{MASS}.
     } \\*
     \hline
@@ -1142,7 +1142,7 @@ \subsection{Filling the Columns}
     \texttt{UNIFORM} & \texttt{lower upper [first last]} \\*
     \hline
     \multicolumn{2}{|>{\raggedright}p{\textwidth}|}{%
-        Generates a uniform random distribution between the values \texttt{lower} and \texttt{upper}.\\
+        Generates a uniform random distribution between the values \texttt{lower} and \texttt{upper}.
         Can be used with all floating point column formats except \texttt{MASS}.
     } \\*
     \hline
@@ -1151,7 +1151,7 @@ \subsection{Filling the Columns}
     \texttt{LINEAR} & \texttt{lower upper [first last]} \\*
     \hline
     \multicolumn{2}{|>{\raggedright}p{\textwidth}|}{%
-        Fills the array with floating point values ranging between the values \texttt{lower} and \texttt{upper} in equal steps.\\
+        Fills the array with floating point values ranging between the values \texttt{lower} and \texttt{upper} in equal steps.
         Can be used with all floating point column formats except \texttt{MASS}.
     } \\*
     \hline
@@ -1160,7 +1160,7 @@ \subsection{Filling the Columns}
     \texttt{COUNT} & \texttt{start step [first last]} \\*
     \hline
     \multicolumn{2}{|>{\raggedright}p{\textwidth}|}{%
-        Fills the array with integer values starting from \texttt{start}, with a given \texttt{step}.\\
+        Fills the array with integer values starting from \texttt{start}, with a given \texttt{step}.
         Can be used with column format \texttt{ID}.
     } \\*
     \hline
