Skip to content

Commit b6ec63c

Browse files
authored
Add strategies (#41)
1 parent de84c45 commit b6ec63c

27 files changed

Lines changed: 783 additions & 365 deletions

.github/copilot-instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,8 @@ applyTo: '/**'
2929
* Do not use em dashes (—) in documentation files or docstrings. Use colons, parentheses, or restructure the sentence instead.
3030
* Math in documentation and docstrings uses `$...$` for inline and `$$...$$` or `\begin{equation}...\end{equation}` for block equations. Do not use `.. math::` or `:math:` (RST syntax).
3131
* To rebuild doc examples run `uv run ./dev/build-examples` — runs all scripts in `docs/examples/` and writes their output to `docs/examples_output/`
32+
33+
## Package structure
34+
35+
* Strategy runtime markdown descriptions (read by `load_description()` at runtime) live inside the package at `quantflow/options/strategies/docs/` — they must be inside the package to be accessible when the library is installed
36+
* mkdocs documentation pages live in `docs/api/options/` — do not mix these two locations
Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,8 @@
1-
---
2-
jupytext:
3-
text_representation:
4-
extension: .md
5-
format_name: myst
6-
format_version: 0.13
7-
jupytext_version: 1.16.6
8-
kernelspec:
9-
display_name: Python 3 (ipykernel)
10-
language: python
11-
name: python3
12-
---
13-
141
# Glossary
152

163
## Characteristic Function
174

18-
The [characteristic function](../theory/characteristic.md) of a random variable $x$ is the Fourier transform of ${\mathbb P}_x$,
5+
The [characteristic function](../theory/characteristic) of a random variable $x$ is the Fourier transform of ${\mathbb P}_x$,
196
where ${\mathbb P}_x$ is the distrubution measure of $x$.
207

218
\begin{equation}
@@ -47,24 +34,24 @@ Check this study on the [Hurst exponent with OHLC data](../applications/hurst).
4734

4835
## Moneyness
4936

50-
Moneyness is used in the context of option pricing and it is defined as
37+
Moneyness, or log strike/forward ratio, is used in the context of option pricing and it is defined as
5138

5239
\begin{equation}
5340
\ln\frac{K}{F}
5441
\end{equation}
5542

56-
where $K$ is the strike and $F$ is the Forward price. A positive value implies strikes above the forward, which means put options are in the money and call options are out of the money.
43+
where $K$ is the strike and $F$ is the Forward price. A positive value implies strikes above the forward, which means put options are in the money (ITM) and call options are out of the money (OTM).
5744

5845

59-
## Moneyness Time Adjusted
46+
## Moneyness Vol Adjusted
6047

61-
The time-adjusted moneyness is used in the context of option pricing in order to compare options with different maturities. It is defined as
48+
The vol-adjusted moneyness is used in the context of option pricing in order to compare options with different maturities. It is defined as
6249

6350
\begin{equation}
64-
\frac{1}{\sqrt{T}}\ln\frac{K}{F}
51+
\frac{1}{\sigma\sqrt{T}}\ln\frac{K}{F}
6552
\end{equation}
6653

67-
where $K$ is the strike and $F$ is the Forward price and $T$ is the time to maturity.
54+
where $K$ is the strike and $F$ is the Forward price and $T$ is the time to maturity and $\sigma$ is the implied Black volatility.
6855

6956
The key reason for dividing by the square root of time-to-maturity is related to how volatility and price movement behave over time.
7057
The price of the underlying asset is subject to random fluctuations, if these fluctuations follow a Brownian motion than the

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ nav:
111111
- Hurst: examples/hurst
112112
- Supersmoother: examples/supersmoother
113113
- Volatility Surface: examples/volatility-surface
114+
- Glossary: glossary.md
114115
- Contributing: contributing.md
115116
- Bibliography: bibliography.md
116117
markdown_extensions:

notebooks/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

notebooks/_config.yml

Lines changed: 0 additions & 65 deletions
This file was deleted.

notebooks/_toc.yml

Lines changed: 0 additions & 46 deletions
This file was deleted.

notebooks/conf.py

Lines changed: 0 additions & 38 deletions
This file was deleted.

notebooks/examples/heston_vol_surface.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

notebooks/index.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

0 commit comments

Comments
 (0)