Skip to content

Commit d28cccb

Browse files
author
committed
Update documentation
0 parents  commit d28cccb

File tree

265 files changed

+56201
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

265 files changed

+56201
-0
lines changed

.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 2116aff26f83ec397cc5d8b9f9612df7
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

.nojekyll

Whitespace-only changes.

_sources/api/data/deribit.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
================
2+
Deribit
3+
================
4+
5+
.. currentmodule:: quantflow.data.deribit
6+
7+
.. autoclass:: Deribit
8+
:members:
9+
:member-order: groupwise
10+
:autosummary:
11+
:autosummary-nosignatures:

_sources/api/data/fmp.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
================
2+
FMP
3+
================
4+
5+
.. currentmodule:: quantflow.data.fmp
6+
7+
.. autoclass:: FMP
8+
:members:
9+
:member-order: groupwise
10+
:autosummary:
11+
:autosummary-nosignatures:

_sources/api/data/fred.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
================
2+
Fred
3+
================
4+
5+
.. currentmodule:: quantflow.data.fred
6+
7+
.. autoclass:: Fred
8+
:members:
9+
:member-order: groupwise
10+
:autosummary:
11+
:autosummary-nosignatures:

_sources/api/data/index.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
==============
2+
Data fetching
3+
==============
4+
5+
.. currentmodule:: quantflow.data
6+
7+
The :mod:`quantflow.data` module provides classes and functions for fetching data from various sources.
8+
To use the module the package must be installed with the optional `data` extra.
9+
```
10+
pip install quantflow[data]
11+
```
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
16+
fmp
17+
fred
18+
deribit

_sources/api/index.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
API Reference
3+
==============
4+
5+
.. grid::
6+
7+
.. grid-item-card::
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
sp/index
13+
14+
.. grid-item-card::
15+
16+
.. toctree::
17+
:maxdepth: 2
18+
19+
options/index
20+
.. grid-item-card::
21+
22+
.. toctree::
23+
:maxdepth: 2
24+
25+
ta/index
26+
.. grid::
27+
28+
.. grid-item-card::
29+
30+
.. toctree::
31+
:maxdepth: 2
32+
33+
data/index
34+
35+
.. grid-item-card::
36+
37+
.. toctree::
38+
:maxdepth: 2
39+
40+
utils/index

_sources/api/options/black.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
==================================
2+
Black Pricing
3+
==================================
4+
5+
.. module:: quantflow.options.bs
6+
7+
.. autofunction:: black_price
8+
9+
.. autofunction:: black_vega
10+
11+
.. autofunction:: implied_black_volatility
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
==================================
2+
Vol Model Calibration
3+
==================================
4+
5+
.. module:: quantflow.options.calibration
6+
7+
.. autoclass:: VolModelCalibration
8+
:members:
9+
:member-order: groupwise
10+
:autosummary:
11+
:autosummary-nosignatures:
12+
13+
14+
.. autoclass:: HestonCalibration
15+
:members:
16+
:member-order: groupwise
17+
:autosummary:
18+
:autosummary-nosignatures:

_sources/api/options/index.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
==================================
2+
Option Pricing
3+
==================================
4+
5+
.. currentmodule:: quantflow.options
6+
7+
The :mod:`options` module provides classes and functions for pricing and analyzing options.
8+
The main class is the :class:`.VolSurface` class which is used to represent
9+
a volatility surface for a given asset.
10+
A volatility surface is usually created via a :class:`.VolSurfaceLoader` object.
11+
12+
.. toctree::
13+
:maxdepth: 1
14+
15+
vol_surface
16+
black
17+
pricer
18+
calibration

0 commit comments

Comments
 (0)