Skip to content

Commit 79ab6fb

Browse files
mgronckijenkins
authored andcommitted
Update userguide
1 parent 24958bc commit 79ab6fb

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

Docs/UserGuide/userguide.tex

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -709,9 +709,9 @@ \subsubsection*{Generate Visual Studio Projects with CMake}
709709
\item Navigate to the ORE root directory
710710
\item Run CMake command:
711711
\begin{itemize}
712-
\item 32-bit: \\
713-
{\tt cmake -G "Visual Studio 17 2022" -A x64 -DBOOST\_INCLUDEDIR=\%BOOST\% -DBOOST\_LIBRARYDIR=\%BOOST\_LIB64\% -DQL\_ENABLE\_SESSIONS=ON -DMSVC\_LINK\_DYNAMIC\_RUNTIME=true -B build}
714712
\item 64-bit: \\
713+
{\tt cmake -G "Visual Studio 17 2022" -A x64 -DBOOST\_INCLUDEDIR=\%BOOST\% -DBOOST\_LIBRARYDIR=\%BOOST\_LIB64\% -DQL\_ENABLE\_SESSIONS=ON -DMSVC\_LINK\_DYNAMIC\_RUNTIME=true -B build}
714+
\item 32-bit: \\
715715
{\tt cmake -G "Visual Studio 17 2022" -A x32 -DBOOST\_INCLUDEDIR=\%BOOST\% -DBOOST\_LIBRARYDIR=\%BOOST\_LIB32\% -DQL\_ENABLE\_SESSIONS=ON -DMSVC\_LINK\_DYNAMIC\_RUNTIME=true -B build}
716716
\end{itemize}
717717
Replace the generator "Visual Studio 17 2022" with the actual installed version.
@@ -806,19 +806,34 @@ \subsubsection*{Building on Windows with CMake}
806806
{\tt \hspace{2cm} -D CMAKE\_BUILD\_TYPE=Release }\textbackslash\\
807807
{\tt \hspace{2cm} -D MSVC\_LINK\_DYNAMIC\_RUNTIME=true} \textbackslash\\
808808
{\tt \hspace{2cm} -D QL\_ENABLE\_SESSIONS=ON} \textbackslash\\
809-
{\tt \hspace{2cm} -G Ninja ..} \\
809+
{\tt \hspace{2cm} -G "Visual Studio 17 2022" ..} \\
810810
\medskip
811811
where the -G option allows choosing the desired build system generator.
812812
\item Build all ORE libraries including QuantLib by invoking \\
813813
\medskip
814-
{\tt ninja} \\
814+
{\tt cmake --build build -v --config Release} \\
815815
\medskip
816-
Ninja automatically utilizes all available threads, unless specified with the -j option.
817816

818817
\item Run all test suites by invoking \\
819818
\medskip {\tt ctest -j4}
820819
\end{enumerate}
821820

821+
\subsubsection*{ZLIB support}
822+
823+
To enable zlib support configure CMake with the flag {\tt -DORE\_USE\_ZLIB=ON}.
824+
825+
If zlib is not installed on the system, it can be installed with the package manager VCPKG:
826+
827+
\begin{itemize}
828+
\item Install vcpkg: https://vcpkg.io/en/getting-started.html
829+
\item Install dependencies with invoking the command \\
830+
\medskip
831+
{\tt vcpkg install --triplet x64-windows zlib} \\
832+
\medskip
833+
\end{itemize}
834+
835+
To make VCPKG visible to CMAKE in Visual studio, create an environment variable {\tt VCPKG\_ROOT} pointing to the root of the vcpkg directory and configure ORE with the flag {\tt -DCMAKE\_TOOLCHAIN\_FILE=\%VCPKG\_ROOT\%/scripts/buildsystems/vcpkg.cmake}.
836+
822837
\subsection{Python and Jupyter}\label{sec:python}
823838

824839
Python (version 3.5 or higher) is required to use the ORE Python language bindings in section \ref{sec:oreswig},

0 commit comments

Comments
 (0)