Commit 051b5baa authored by Chris Cantwell's avatar Chris Cantwell
Browse files

Merge branch 'update-user-guide' into 'master'

Update user guide

A quick update of the user guide to reflect latest VS and boost releases as well as additional steps to be undertaken for compiling under Windows

See merge request !692
parents 263ed281 61727ab3
......@@ -55,6 +55,11 @@ v4.4.0
- Add module to stretch homogeneous direction (!609)
- Add module to add composite ID of elements as a field (!674)
- Update build instructions in user guide for Windows (!692)
......@@ -12,6 +12,7 @@ dependencies are required:
\item texlive-base
\item texlive-latex-extra
\item texlive-science
\item texlive-fonts-recommended
\item imagemagick
......@@ -369,7 +369,7 @@ automatically in the build process.
& & \multicolumn{2}{c}{Installation} & \\ \cmidrule(r){3-4}
Package & Req. & User & Auto. & Note \\
MS Visual Studio & \cmark & \cmark & & 2012 and 2013 known working\\
MS Visual Studio & \cmark & \cmark & & 2012, 2013 and 2015 known working\\
CMake $\geq 3.0$ & \cmark & \cmark & & \\
BLAS & \cmark & \cmark & \cmark & \\
LAPACK & \cmark & \cmark & \cmark & \\
......@@ -382,10 +382,10 @@ ModMETIS & \cmark & \cmark & \cmark & \\
\subsubsection{Detailed instructions}
\item Install Microsoft Visual Studio 2013 (preferred) or 2012 (known to
\item Install Microsoft Visual Studio 2015 (preferred), 2013 or 2012 (known to
work). This can be obtained from Microsoft free of charge by using their
Express developer tools from
Community developer tools from
\item Install WinRAR from \url{}.
\item Install CMake 3.0+ from \url{}. When
prompted, select the option to add CMake to the system PATH.
......@@ -395,14 +395,21 @@ ModMETIS & \cmark & \cmark & \cmark & \\
to the PATH.
\item (Optional) If you do not wish to build boost during the compilation
process (which can take some time), then boost binaries can be found at
\url{}. By
\url{}. By
default these install into \inlsh{C:\textbackslash local\textbackslash
boost\_1\_57\_0}. If you use these libraries, you will need to:
boost\_1\_61\_0}. If you use these libraries, you will need to:
\item Rename \texttt{libs-msvc12.0} to \texttt{lib}
\item Rename \texttt{libs-msvc14.0} to \texttt{lib}
\item Inside the \texttt{lib} directory, create duplicates of
\texttt{boost\_zlib.dll} and \texttt{boost\_bzip2.dll} called
\texttt{zlib.dll} and \texttt{libbz2.dll}.
\texttt{zlib.dll} and \texttt{libbz2.dll}
\item Add a \inlsh{BOOST\_HOME} environment variable. To do so,
navigate to \emph{Control Panel > System and Security > System}, select
\emph{Advanced System Settings}, and in the \emph{Advanced} tab click the
\emph{Environment Variables}. In the \emph{System Variables} box, click
\emph{New}. In the \emph{New System Variable} window, type \inlsh{BOOST\_HOME}
next to \emph{Variable name} and \inlsh{C:\textbackslash local\textbackslash
boost\_1\_61\_0} next to\emph{Variable value}.
\item Unpack \inlsh{nektar++-\nekver.tar.gz} using WinRAR.
......@@ -415,8 +422,8 @@ ModMETIS & \cmark & \cmark & \cmark & \\
\item Create a \inlsh{builds} directory within the \inlsh{nektar++-\nekver}
\item Open a Visual Studio terminal. From the start menu, this can be found in
\emph{All Programs > Visual Studio 2013 > Visual Studio Tools > Developer
Command Prompt for VS2013}.
\emph{All Programs > Visual Studio 2015 > Visual Studio Tools > Developer
Command Prompt for VS2015}.
\item Change directory into the \texttt{builds} directory and run the CMake
graphical utility:
......@@ -424,8 +431,8 @@ ModMETIS & \cmark & \cmark & \cmark & \\
cmake-gui ..
\item Select the build system you want to generate build scripts for. Note
that \emph{Visual Studio 2013} is listed as \emph{Visual Studio 12} in the
drop-down list. If you have a 64-bit installation of Windows 7, you should
that \emph{Visual Studio 2015} is listed as \emph{Visual Studio 14} in the
drop-down list. If you have a 64-bit installation of Windows, you should
select the \emph{Win64} variant, otherwise 32-bit executables will be
generated. Select the option to use the native compilers.
\item Click the \emph{Configure} button, then the \emph{Generate} button.
......@@ -450,7 +457,7 @@ ModMETIS & \cmark & \cmark & \cmark & \\
\item \inlsh{builds\textbackslash dist\textbackslash lib\textbackslash nektar++-\nekver}
\item \inlsh{builds\textbackslash dist\textbackslash bin}
\item Optionally, if you installed Boost from the binary packages,
\inlsh{C:\textbackslash local\textbackslash boost\_1\_57\_0 \textbackslash lib}
\inlsh{C:\textbackslash local\textbackslash boost\_1\_61\_0 \textbackslash lib}
\item To run the test suite, open a \textbf{new} command line window, change
to the \inlsh{builds} directory, and then issue the command
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment