Skip to content

Commit d9fc799

Browse files
author
Eric Ehlers
committed
add documentation for building and installing python wrappers and wheels
1 parent 2ce294e commit d9fc799

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

tutorials.03.build_windows.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ in your boost lib directory.
3434

3535
You need to grab the source code for ORE and ORESWIG, e.g:
3636

37-
git clone --recurse-submodules https://github.com/OpenSourceRisk/Engine.git
38-
git clone --recurse-submodules https://github.com/OpenSourceRisk/ORE-SWIG.git
37+
git clone --recurse-submodules https://github.com/OpenSourceRisk/Engine.git ore
38+
git clone --recurse-submodules https://github.com/OpenSourceRisk/ORE-SWIG.git oreswig
3939

4040
# Environment Variables
4141

@@ -111,6 +111,11 @@ Below are the commands to build ORESWIG.
111111
SET PYTHONPATH=%DEMO_ORE_SWIG_DIR%\OREAnalytics-SWIG\Python\build;%DEMO_ORE_SWIG_DIR%\OREAnalytics-SWIG\Python\build\Release
112112
python swap.py
113113

114+
When you run example script `ore.py`, it writes to directory `Output` a number
115+
of output files, including `cube.dat`. If you have compression enabled, as
116+
described above, then `cube.dat` is generated in compressed format (zip). If
117+
not then `cube.dat` is generated as a flat (plain text) file.
118+
114119
## Build ORESWIG Using setup.py
115120

116121
### Build ORESWIG

tutorials.04.build_posix.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ of `boost::iostreams` is zlib-enabled. The instructions for compiling
2626

2727
You need to grab the source code for ORE and ORESWIG, e.g:
2828

29-
git clone --recurse-submodules https://github.com/OpenSourceRisk/Engine.git
30-
git clone --recurse-submodules https://github.com/OpenSourceRisk/ORE-SWIG.git
29+
git clone --recurse-submodules https://github.com/OpenSourceRisk/Engine.git ore
30+
git clone --recurse-submodules https://github.com/OpenSourceRisk/ORE-SWIG.git oreswig
3131

3232
# Environment Variables
3333

@@ -102,6 +102,11 @@ Below are the commands to build ORESWIG.
102102
export LD_LIBRARY_PATH=$DEMO_ORE_DIR/build/OREAnalytics/orea:$DEMO_ORE_DIR/build/OREData/ored:$DEMO_ORE_DIR/build/QuantExt/qle:$DEMO_ORE_DIR/build/QuantLib/ql:$DEMO_BOOST_LIB
103103
python3 swap.py
104104

105+
When you run example script `ore.py`, it writes to directory `Output` a number
106+
of output files, including `cube.dat`. If you have compression enabled, as
107+
described above, then `cube.dat` is generated in compressed format (.tar.gz).
108+
If not then `cube.dat` is generated as a flat (plain text) file.
109+
105110
## Build ORESWIG Using setup.py
106111

107112
### Build ORESWIG

0 commit comments

Comments
 (0)