dabb02e8f63dc8dec3818f63dd147ec277a6d70d
[unres.git] / doc / INSTALL / HOWTO_build_unres_with_cmake.tex
1 \documentclass{article}
2
3 \newcommand{\shellcmd}[1]{\medskip\texttt{\footnotesize #1}\medskip}
4
5 \begin{document}
6
7
8 \title{Building UNRESPACK with CMake}
9 \author{Dawid Jagiela}
10
11 \maketitle
12
13
14 \section{Requirements}
15
16 Starting with UNRESPACK 3.2, CMake (cross-platform, open-source build system ) can be used to build UNRESPACK. 
17 Building requires te folowing: 
18 \begin{itemize}  
19   \item CMake 2.8 or later 
20   \item Fortran compiler. Currently \emph{Intel Fortran Compiler} and \emph{GNU Fortran Compiler} are supported. The former one is recomended.  
21   \item ANSI C compiler   
22 \end{itemize} 
23
24 \section{Building}
25
26 \raggedright
27
28 Prepare the build directory 
29
30 \shellcmd{mkdir unrespack \\tar -xvzf unrespack-v.3.2.tar.gz -C unrespack \\cd unrespack \\mkdir build \&\& cd build}
31
32 Configure CMake 
33
34 \begin{itemize}
35   \item Using command line, interactive mode(recomended) \shellcmd{ccmake ..}
36   \item Using command line, non-interactive mode. This requires to pass all the variables to CMake
37         \shellcmd{ cmake -DCMAKE\_Fortran\_COMPILER=ifort -DUNRES\_MD\_FF=GAB .. } 
38 \end{itemize}
39
40 To compile the whole package run:
41
42 \shellcmd{make}
43
44
45
46
47 \end{document}
48