Skip to content

Commit 4daa471

Browse files
committed
Update of installation section
1 parent 670c26b commit 4daa471

File tree

2 files changed

+38
-31
lines changed

2 files changed

+38
-31
lines changed

Documents/Guide/Frames/Installing.tex

+32-28
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,49 @@
11
\section{Installation}
22

3-
CombLayer is predominately written for the Linux platform using {\tt C++}
4-
compilers that support {\tt C++11} or greater. The code is available from \\
5-
\href{https://github.com/SAnsell/CombLayer}{https://github.com/SAnsell/CombLayer}, \\ either as a download of a {\tt zip} file or
6-
by cloning/pulling the git repository.
3+
CombLayer is primarily designed for the Linux platform and requires a
4+
\CC compiler that supports {\CC}11 or later. The code is available at
5+
\href{https://github.com/SAnsell/CombLayer}{https://github.com/SAnsell/CombLayer},
6+
either as a downloadable
7+
\href{https://github.com/SAnsell/CombLayer/archive/master.zip}{zip
8+
file} or by cloning/pulling the Git repository:
9+
\begin{bash}
10+
git clone https://github.com/SAnsell/CombLayer.git
11+
\end{bash}
712

813
\subsection{Requirments}
914

10-
CombLayer needs to have the GNU Scietific Library [GSL] and the {\tt
11-
boost::regex} system along with the STL libraries from your {\tt
12-
C++} compiler. The GSL can be avoided with the {\tt -NS} flag in the
13-
{\tt getMk.pl} and the {\tt CMake.pl} script but some functionality will be
14-
lost, particularly in the choice of variance reduction methods.
15-
16-
Additionally, the primary build system uses {\tt cmake}. There is another
17-
that just uses {\tt make} but is significantly more time-consuming.
18-
19-
Functional documentation is supported using {\tt Doxygen} and the construction
20-
of new cmake text files can be done via PERL scripts.
21-
22-
Currenly it is know that {\tt gcc} version 4.6 and above can compile
23-
CombLayer as can {\tt clang} (all tested versions). {\tt gcc} 4.4 which is often
24-
the default on RedHat systems (2015) does not work.
15+
CombLayer requires the GNU Scientific
16+
Library~(\href{https://www.gnu.org/software/gsl}{GSL}),
17+
\href{https://www.boost.org}{boost::regex}, as well as the
18+
\href{https://github.com/fmtlib/fmt}{\{fmt\}} and STL libraries
19+
provided by your \CC compiler. The build process is managed with
20+
\href{https://cmake.org}{CMake}, and the class reference documentation
21+
is generated using \href{https://www.doxygen.nl}{Doxygen}.
22+
Both {\tt gcc} and {\tt clang} compilers are supported.
2523

2624
\subsection{Basic build method}
2725

28-
If a clean directory is made and then the {\tt .zip} file is uncompressed, the
29-
following commands should build a version of CombLayer.
26+
CombLayer can be built either in the source code directory or in a separate build directory. If built in the source directory, the command is
3027

3128
\begin{bash}
32-
./CMake.pl
3329
cmake ./
3430
make
3531
\end{bash}
3632

37-
This should make a number of executables, e.g. {\tt ess}, {\tt simple}, {\tt fullBuild} etc. These
38-
can be used to make a simple model with commands like
33+
or for a separate build directory
34+
3935
\begin{bash}
40-
./simple -r AA
36+
cmake -B/path/to/buildDirectory -S/path/to/srcDirectory
37+
make
4138
\end{bash}
42-
This will produce an output file {\tt AA1.x} which is a MCNP model.
43-
44-
4539

40+
This should make a number of executables, e.g. {\tt ess}, {\tt maxiv},
41+
{\tt reactor}, {\tt fullBuild} etc, which can be used to make a model
42+
with commands listed in the {\tt all.sh} script. For instance, the
43+
\begin{bash}
44+
singleItem --singleItem Octupole AA
45+
\end{bash}
46+
command generates an output file named {\tt AA1.x}, which is an MCNP
47+
model of an octupole magnet. To generate a FLUKA model, add the {\tt
48+
-fluka} argument, and for PHITS models, use the {\tt -phits}
49+
argument.

Documents/Guide/Guide.tex

+6-3
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,19 @@
77
\tikzstyle{arrow} = [red, ->, line width=2pt]
88

99
\usepackage{amsmath,enumerate,xspace,subfig,siunitx,lscape}
10-
\usepackage{listings}
10+
\usepackage{listings,xspace}
1111
\usepackage[absolute,overlay]{textpos}
1212
\usepackage[colorinlistoftodos]{todonotes}
1313

1414
\usepackage[colorlinks=true,linkcolor=red,pagecolor=red,
1515
citecolor=blue,urlcolor=blue,breaklinks=true,
1616
hyperfootnotes=false,pdftitle={CombLayer Guide},
17-
pdfauthor={Stuart Ansell},pdfkeywords={CombLayer,MCNP,MCNPX}]
17+
pdfauthor={Stuart Ansell},pdfkeywords={CombLayer,MCNP,MCNPX,FLUKA,PHITS,POV-Ray}]
1818
{hyperref}
19-
\renewcommand*{\rmdefault}{cmss}
19+
\renewcommand*{\rmdefault}{cmss}
20+
21+
\def\CC{{C\hspace{-.05em}\raisebox{.4ex}{\tiny\bf ++}}\xspace}
22+
2023

2124
\input{Frames/functions}
2225

0 commit comments

Comments
 (0)