Skip to content

Commit 5edf9e1

Browse files
rolandlichtersjenkins
rolandlichters
authored and
jenkins
committed
QPR-12392 Publish Tutorials For ORE Builds
1 parent 18abf6c commit 5edf9e1

6 files changed

Lines changed: 255 additions & 0 deletions

‎tutorials/ore_gpgpu.png‎

20.4 KB
Loading

‎tutorials/tutorials.010.build_windows.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
2+
# Building ORE on Windows
3+
4+
This tutorial explains how to build ORE on Windows.
5+
6+
[Back to tutorials index](../tutorials_index.md)
7+
8+
# Prerequisites
9+
10+
This build requires:
11+
12+
- Visual Studio
13+
- Boost
14+
- CMake
15+
16+
# Source code
17+
18+
You need to grab the source code for ORE, e.g:
19+
20+
git clone --recurse-submodules https://github.com/OpenSourceRisk/Engine.git ore
21+
22+
# Environment Variables
23+
24+
For purposes of this tutorial, create environment variables pointing to the ORE
25+
and boost directories, e.g:
26+
27+
SET ORE_ROOT_DIR=C:\repos\ore
28+
SET BOOST_INCLUDEDIR=C:\repos\boost\boost_1_72_0
29+
SET BOOST_LIBRARYDIR=C:\repos\boost\boost_1_72_0\lib64-msvc-14.2
30+
31+
# Build ORE
32+
33+
## Configure ORE
34+
35+
Below are the commands to configure the ORE build using cmake:
36+
37+
mkdir %ORE_ROOT_DIR%\build
38+
cd %ORE_ROOT_DIR%\build
39+
cmake ..
40+
41+
## Build ORE
42+
43+
Below are the commands to build ORE:
44+
45+
cd %ORE_ROOT_DIR%\build
46+
cmake --build . --config Release
47+
48+
# Run tests
49+
50+
## QuantLib
51+
52+
cd to the test directory:
53+
54+
cd %ORE_ROOT_DIR%\build\QuantLib\test-suite\Release
55+
56+
Run all unit tests:
57+
58+
quantlib-test-suite.exe
59+
60+
Or run a selected test, e.g:
61+
62+
quantlib-test-suite.exe --log_level=all --run_test="QuantLib test suite/Swap tests"
63+
64+
## QuantExt
65+
66+
cd %ORE_ROOT_DIR%/build/QuantExt/test/Release
67+
quantext-test-suite.exe
68+
69+
## OREData
70+
71+
cd %ORE_ROOT_DIR%/build/OREData/test/Release
72+
ored-test-suite.exe
73+
74+
## OREAnalytics
75+
76+
cd %ORE_ROOT_DIR%/build/OREAnalytics/test/Release/
77+
orea-test-suite.exe
78+

‎tutorials/tutorials.015.build_posix.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
2+
# Building ORE on Posix Systems (e.g. MacOS and Linux)
3+
4+
This tutorial explains how to build ORE on Posix systems such as MacOS and
5+
Linux. The commands listed here were tested on Ubuntu and you will likely have
6+
to modify the commands slightly on other systems.
7+
8+
[Back to tutorials index](../tutorials_index.md)
9+
10+
# Prerequisites
11+
12+
This build requires:
13+
14+
- gcc
15+
- Boost
16+
- CMake
17+
18+
# Source code
19+
20+
You need to grab the source code for ORE, e.g:
21+
22+
git clone --recurse-submodules https://github.com/OpenSourceRisk/Engine.git ore
23+
24+
# Environment Variables
25+
26+
For purposes of this tutorial, create environment variable
27+
`ORE_ROOT_DIR`pointing to the root directory of your build, e.g:
28+
29+
ORE_ROOT_DIR=/home/repos/ore
30+
31+
If you installed boost from packages (e.g. `sudo apt install
32+
libboost-all-dev`), then your build will probably find boost automatically. If
33+
you built boost yourself from source, then export some environment variables
34+
pointing to the boost include and lib directories, e.g:
35+
36+
export BOOST_INCLUDEDIR=/home/repos/boost/install/include
37+
export BOOST_LIBRARYDIR=/home/repos/boost/install/lib
38+
39+
# Build ORE
40+
41+
## Configure ORE
42+
43+
Below are the commands to configure the ORE build using cmake:
44+
45+
mkdir $ORE_ROOT_DIR/build
46+
cd $ORE_ROOT_DIR/build
47+
cmake ..
48+
49+
## Build ORE
50+
51+
Below are the commands to build ORE.
52+
53+
cd $ORE_ROOT_DIR/build
54+
cmake --build .
55+
56+
# Run tests
57+
58+
## QuantLib
59+
60+
cd to the test directory:
61+
62+
cd $ORE_ROOT_DIR/build/QuantLib/test-suite
63+
64+
Run all unit tests:
65+
66+
./quantlib-test-suite
67+
68+
Run a selected test, e.g:
69+
70+
./quantlib-test-suite --log_level=all --run_test="QuantLib test suite/Swap tests"
71+
72+
## QuantExt
73+
74+
cd $ORE_ROOT_DIR/build/QuantExt/test
75+
./quantext-test-suite
76+
77+
## OREData
78+
79+
cd $ORE_ROOT_DIR/build/OREData/test
80+
./ored-test-suite
81+
82+
## OREAnalytics
83+
84+
cd $ORE_ROOT_DIR/build/OREAnalytics/test
85+
./orea-test-suite
86+

‎tutorials/tutorials.020.build_windows_gpgpu.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# Building ORE with GPGPU Support on Windows
3+
4+
This tutorial explains how to build ORE with
5+
[GPGPU](https://en.wikipedia.org/wiki/General-purpose_computing_on_graphics_processing_units)
6+
support on Windows.
7+
8+
[Back to tutorials index](../tutorials_index.md)
9+
10+
This build is based upon the vanilla Windows build of ORE:
11+
12+
[Building ORE on Windows](tutorials.010.build_windows.md)
13+
14+
With the differences noted below:
15+
16+
# Build ORE
17+
18+
## Configure ORE
19+
20+
When you run cmake, add the flag `-DORE_ENABLE_OPENCL=ON`:
21+
22+
cmake .. -DORE_ENABLE_OPENCL=ON
23+
24+
# Run tests
25+
26+
Below are the commands to run the unit tests for the ORE GPGPU Framework:
27+
28+
cd %ORE_ROOT_DIR%\build\ore\QuantExt\test\Release
29+
quantext-test-suite.exe --log_level=message --run_test=QuantExtTestSuite/ComputeEnvironmentTest
30+
31+
# Design
32+
33+
Below is a UML Class Diagram for the ORE GPGPU Framework:
34+
35+
![ORE GPGPU Framework](ore_gpgpu.png "ORE GPGPU Framework")
36+

‎tutorials/tutorials.025.build_posix_gpgpu.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
# Building ORE with GPGPU Support on Posix Systems (e.g. MacOS and Linux)
3+
4+
This tutorial explains how to build ORE with
5+
[GPGPU](https://en.wikipedia.org/wiki/General-purpose_computing_on_graphics_processing_units)
6+
support on Windows.
7+
8+
[Back to tutorials index](../tutorials_index.md)
9+
10+
This build is based upon the vanilla Posix build of ORE:
11+
12+
[Building ORE on Posix Systems (e.g. MacOS and Linux)](tutorials.015.build_posix.md)
13+
14+
With the differences noted below:
15+
16+
# Build ORE
17+
18+
## Configure ORE
19+
20+
When you run cmake, add the flag `-DORE_ENABLE_OPENCL=ON`:
21+
22+
cmake .. -DORE_ENABLE_OPENCL=ON
23+
24+
# Run tests
25+
26+
## QuantExt
27+
28+
Below are the commands to run the unit tests for the ORE GPGPU Framework:
29+
30+
cd $ORE_ROOT_DIR/build/QuantExt/test
31+
./quantext-test-suite --log_level=message --run_test=QuantExtTestSuite/ComputeEnvironmentTest
32+
33+
# Design
34+
35+
Below is a UML Class Diagram for the ORE GPGPU Framework:
36+
37+
![ORE GPGPU Framework](ore_gpgpu.png "ORE GPGPU Framework")
38+

‎tutorials_index.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
# Tutorials Index
3+
4+
This page serves as the index for selected tutorials on building ORE.
5+
6+
## Vanilla Builds
7+
8+
[Building ORE on Windows](tutorials/tutorials.010.build_windows.md)
9+
10+
[Building ORE on Posix Systems (e.g. MacOS and Linux)](tutorials/tutorials.015.build_posix.md)
11+
12+
## GPGPU Support
13+
14+
[Building ORE With GPGPU Support on Windows](tutorials/tutorials.020.build_windows_gpgpu.md)
15+
16+
[Building ORE With GPGPU Support on Posix Systems (e.g. MacOS and Linux)](tutorials/tutorials.025.build_posix_gpgpu.md)
17+

0 commit comments

Comments
 (0)