132132\title{ORE User Guide}
133133%\author{Quaternion Risk Management Ltd.}
134134%\author{Acadia Inc.}
135- \date{16 October 2023 }
135+ \date{15 January 2024 }
136136\maketitle
137137
138138\newpage
@@ -156,6 +156,7 @@ \section*{Document History}
15615631 March 2023 & Acadia & updates for release 9\\
15715716 June 2023 & Acadia & updates for release 10\\
15815816 October 2023 & Acadia & updates for release 11\\
159+ 15 January 2024 & Acadia & updates for release 12\\
159160\hline
160161\end{supertabular}
161162\end{center}
@@ -1257,6 +1258,16 @@ \section{Examples}\label{sec:examples}
12571258\hline
1258125952 & Scripted Trades \\
12591260\hline
1261+ 53 & Curve Building using FRAs tailored to Central Bank Meeting Dates\\
1262+ \hline
1263+ 54 & Scripted Trade Exposure with AMC: Bermudan Swaption and LPI Swap \\
1264+ \hline
1265+ 55 & Scripted Trade Exposure with AMC: Fx TaRF \\
1266+ \hline
1267+ 56 & CVA Sensitivity using AAD \\
1268+ \hline
1269+ 57 & Base Scenario Analytic \\
1270+ \hline
12601271\end{tabular}
12611272\caption{ORE examples.}
12621273\label{tab_0}
@@ -3537,12 +3548,75 @@ \subsection{Scripted Trade}% Example 52
35373548 significantly more versatile, more examples and scripts to follow.
35383549
35393550%--------------------------------------------------------------------
3540- \subsection{GBP OIS Curve using MPC Swaps }% Example 53
3551+ \subsection{Curve Building around Central Bank Meeting Dates }% Example 53
35413552\label{example:53}
35423553%--------------------------------------------------------------------
35433554
35443555This example demonstrates the build of a GBP OIS curve using MPC Swaps at the short end.
35453556
3557+ %--------------------------------------------------------------------
3558+ \subsection{Scripted Trade Exposure with AMC: Bermudan Swaption and LPI Swap}% Example 54
3559+ \label{example:54}
3560+ %--------------------------------------------------------------------
3561+
3562+ This example demonstrates exposure simulation using AMC for selected scripted trade types
3563+ \begin{itemize}
3564+ \item Bermudan Swaption
3565+ \item LPI Swap
3566+ \end{itemize}
3567+ Both payoffs are defined in {\tt scriptlibrary.xml} which is referenced in {\tt portfolio.xml}. \\
3568+
3569+ To enable the AMC processing requires the following highlighted settings in {\tt ore.xml}.
3570+
3571+ \begin{minted}[fontsize=\scriptsize]{xml}
3572+ <Analytic type="simulation">
3573+ <Parameter name="active">Y</Parameter>
3574+ <!-- Set to Y to trigger AMC processing -->
3575+ <Parameter name="amc">Y</Parameter>
3576+ <Parameter name="simulationConfigFile">simulation.xml</Parameter>
3577+ <Parameter name="pricingEnginesFile">pricingengine.xml</Parameter>
3578+ <!-- Specify a separate pricing engine file for AMC engines -->
3579+ <Parameter name="amcPricingEnginesFile">pricingengine\_amc.xml</Parameter>
3580+ <!-- Specify trade types to be covered by the AMC processing -->
3581+ <Parameter name="amcTradeTypes">ScriptedTrade</Parameter>
3582+ <Parameter name="baseCurrency">EUR</Parameter>
3583+ <Parameter name="storeScenarios">N</Parameter>
3584+ <Parameter name="cubeFile">cube.csv.gz</Parameter>
3585+ <Parameter name="aggregationScenarioDataFileName">scenariodata.csv.gz</Parameter>
3586+ <Parameter name="aggregationScenarioDataDump">scenariodata.csv</Parameter>
3587+ </Analytic>
3588+ \end{minted}
3589+
3590+ Note that ORE can handle a mix of trades covered by AMC simulation and covered by ``classic'' simulation.
3591+ The respective NPV cubes are combined before generating results such as exposures or XVAs.
3592+
3593+ %--------------------------------------------------------------------
3594+ \subsection{Scripted Trade Exposure with AMC: Target Redemption Forward}% Example 55
3595+ \label{example:55}
3596+ %--------------------------------------------------------------------
3597+
3598+ This example demonstrates exposure simulation and XVA for another scripted product, an
3599+ FX Target Redemption Forward (TaRF). In contrast to the cases presented above, you won't see
3600+ the payoff script library in the Input folder, nor is the script embedded into the trade XML file.
3601+ The trade type in this case is {\tt FxTARF} which has its own implementation in OREData/ored/portfolio/tarf.xpp
3602+ and a separate trade schema. However, the scipted trade framework is used under the hood, and the payoff
3603+ script is embedded into the C++ code in OREData/ored/portfolio/tarf.cpp.
3604+
3605+ %--------------------------------------------------------------------
3606+ \subsection{CVA Sensitivity using AD}% Example 56
3607+ \label{example:56}
3608+ %--------------------------------------------------------------------
3609+
3610+ This example demonstrates a prototype CVA sensitivity calculation applying Adjoint Algorithmic Differentiation (AAD)
3611+ to a Swap instrument represented as scripted trade.
3612+
3613+ %--------------------------------------------------------------------
3614+ \subsection{Base Scenario Analytic}% Example 57
3615+ \label{example:57}
3616+ %--------------------------------------------------------------------
3617+
3618+ Demonstration of the {\tt Scenario} analytic which has been added to export the simulation market's base scenario
3619+ as a file.
35463620
35473621\clearpage
35483622%========================================================
0 commit comments