Skip to content

Commit c6bcd93

Browse files
rolandlichtersjenkins
authored andcommitted
update Example 42
1 parent 2b4f03e commit c6bcd93

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

Docs/UserGuide/userguide.tex

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3136,29 +3136,31 @@ \subsection{ORE Python Module}% Example 42
31363136
{\tt cd Example\_42}
31373137

31383138
\medskip
3139-
The examples require Python 3, the actual ORE Python module is then installed with a one-liner, see below. However, to separate ORE from any other Python environments on your machine, we recommend creating a virtual environment first. In that case the steps are as follows:
3139+
The examples require Python 3. The ORE Python module is then installed with a one-liner, see step 3 below. However, to separate ORE from any other Python environments on your machine, we recommend creating a virtual environment first. In that case the steps are as follows.
31403140

3141-
\begin{itemize}
3141+
\begin{enumerate}
31423142
\item To create a virtual environment: {\tt python -m venv env1}
31433143
\item To activate this environment on Windows: {\tt .{\bs}env1{\bs}Scripts{\bs}activate.bat} \\
31443144
or on macOS/Linux: {\tt ./env1/bin/activate }
3145-
\item Then install ORE:\\
3145+
\item Then install the latest release of ORE:\\
31463146
{\tt pip install open-source-risk-engine }
3147-
\item And try examples:\\
3147+
\item Try examples:\\
31483148
\begin{itemize}
31493149
\item {\tt python ore.py} \\
31503150
This demonstrates the Python-wrapped version of the ORE application that is also used in the command line application {\tt ore.exe}. We use it here to re-run the Swap exposure of {\tt Example\_1}.
3151+
\item {\tt python ore2.py} \\
3152+
This extends the previous example and shows how to access and post-process ORE in-memory results in the Python framework without reading files.
31513153
\item {\tt python commodityforward.py} \\
3152-
The ORE Python module also allows lower-level access to the QuantLib and QuantExt libraries, demonstrated here for a CommodityForward instrument defined QuantExt.
3154+
The ORE Python module also allows lower-level access to the QuantLib and QuantExt libraries, demonstrated here for a CommodityForward instrument defined in QuantExt.
3155+
Note that the ORE Python module contains the entire QuantLib Python functionality.
31533156
\end{itemize}
3154-
More use cases of the ORE Python module, including Jupyter notebooks, can be found in the ORE SWIG repository, in particular in folder OREAnalytics-SWIG/Python/Examples.
3155-
\item Finally you can deactivate the environment:
3156-
{\tt deactivate} \\
3157+
More use cases of the ORE Python module including Jupyter notebooks can be found in the ORE SWIG repository, in particular in folder OREAnalytics-SWIG/Python/Examples.
3158+
\item You can deactivate the environment with {\tt deactivate} \\
31573159
or even fully remove the environment again by removing the {\tt env1} folder.
3158-
\end{itemize}
3160+
\end{enumerate}
31593161

3160-
You can build the Python module and installable packages yourself following the instructions in sections \ref{sec:oreswig}, \ref{sec:win_wheel}, \ref{sec:nix_wheel}
3161-
based on your local ORE code. {\tt pip install open-source-risk-engine } will always provide the latest release.
3162+
Finally, you can build the Python module and installable packages yourself following the instructions in sections \ref{sec:oreswig}, \ref{sec:win_wheel}, \ref{sec:nix_wheel}
3163+
based on your local ORE code.
31623164

31633165
\clearpage
31643166
%========================================================

0 commit comments

Comments
 (0)