From 9297b52a8e8a469c4875dfefb6bace9fbe915cea Mon Sep 17 00:00:00 2001 From: "JHM Darbyshire (MBP)" Date: Tue, 8 Aug 2023 07:53:07 +0200 Subject: [PATCH] DOC: move pricing mechanismn --- docs/source/g_mechanisms.rst | 12 ++++++++++++ docs/source/i_about.rst | 2 ++ 2 files changed, 14 insertions(+) diff --git a/docs/source/g_mechanisms.rst b/docs/source/g_mechanisms.rst index 0e1ede37..879c8d91 100644 --- a/docs/source/g_mechanisms.rst +++ b/docs/source/g_mechanisms.rst @@ -7,6 +7,18 @@ Pricing Mechanisms Summary ************************** +*Rateslib's* API design for valuing and obtaining risk sensitivities of *Instruments* +follows the first two :ref:`pillars of its design philosophy:` + +1) Maximise flexibility : minimise user input, +2) Prioritise risk sensitivities above valuation. + +This means the arguments required for the +:meth:`Instrument.npv()`, +:meth:`Instrument.delta()` and +:meth:`Instrument.gamma()` + + The pricing mechanisms in ``rateslib`` require ``Instruments`` and ``Curves``. ``fx`` objects (usually ``FXForwards``) may also be required (for multi-currency instruments), and these diff --git a/docs/source/i_about.rst b/docs/source/i_about.rst index 2fb88880..19f11f33 100644 --- a/docs/source/i_about.rst +++ b/docs/source/i_about.rst @@ -29,6 +29,8 @@ early 2024 under the working title of *Coding Interest Rates: FX, Swaps and Bond :target: https://www.amazon.com/Pricing-Trading-Interest-Rate-Derivatives/dp/0995455538 :width: 92 +.. _pillars-doc: + Five Pillars of Rateslib's Design Philosophy *********************************************