quantflow 0.8.0__tar.gz → 1.0.0__tar.gz

{quantflow-0.8.0 → quantflow-1.0.0}/.dockerignore

@@ -14,3 +14,5 @@ __pycache__
 .pytest_cache
 .codebuild
 .gihub
+frontend/node_modules
+frontend/src/.observablehq

{quantflow-0.8.0 → quantflow-1.0.0}/.github/copilot-instructions.md

@@ -12,7 +12,19 @@ applyTo: '/**'
 
 * Always run `make lint` after code changes — runs taplo, isort, black, ruff, and mypy
 * Never edit `readme.md` directly — it is generated from `docs/index.md` via `make docs`
-* To install all dependencies (including all optional extras) run `make install-dev` — runs `uv sync --all-extras`
+* To install all dependencies (including all optional extras) run `make install-dev`
+* Do not modify code unless the developer explicitly asks for a code change.
+* Never run `git commit` (or `git push`) unless the developer explicitly asks for it.
+  Preparing changes in the working tree is the deliverable; committing is the developer's action.
+* Never change code that works unless you have been asked by the developer to do so,
+  or you have a good reason to believe the code is wrong.
+* Concentrate on fixing the problem, not on making the code look nice unless you are
+  extremely confident that your code style is better than the original and that the original code style
+  is not serving a purpose (e.g. readability, consistency with other code, etc.).
+  If you are unsure, ask the developer or leave the code style as it is.
+
+## Run Tests
+
 * To run all tests use `make test` — runs all tests in the `tests/` directory using pytest
 * To run a specific test file, use `uv run pytest tests/path/to/test_file.py`
 
@@ -29,31 +41,44 @@ applyTo: '/**'
 * Documentation is built using [mkdocs](https://www.mkdocs.org/) and stored in the `docs/` directory. The documentation source files are written in markdown format.
 * Split prose into short paragraphs (one idea per paragraph) separated by blank lines. Never write a wall-of-text paragraph that strings together mechanism, rationale, caveats and usage advice. This applies to mkdocs tutorials, theory pages and long docstrings.
 * Do not use dashes (em dashes, en dashes, or hyphens used as dashes) in documentation files or docstrings. Use colons, parentheses, or restructure the sentence instead.
+* Always use `Annotated(..., Doc("..."))` for docstrings in code, never use triple-quoted strings below the definition of a function or class. For example:
+  ```python
+  from typing_extensions import Annotated, Doc
+
+  def foo(x: Annotated[int, Doc("This is the docstring for x")]) -> float:
+      """This is the docstring for foo"""
+      return float(x)
+  ```
+* Do not use Docstrings with markdown text that may generate headings (e.g. `# Heading`, `## Heading`, etc.)
 * Math in documentation and docstrings: always use `\begin{equation}...\end{equation}` for any formula or equation. Use `$...$` only for brief inline references to variables (e.g. $F$, $K$). Do not use `$$...$$`, `` `...` ``, or RST syntax (`.. math::`, `:math:`).
 * Math notation convention: use $\Phi$ for the characteristic function and $\phi$ for the characteristic exponent, where $\Phi = e^{-\phi}$.
 * Glossary entries in `docs/glossary.md` must be kept in alphabetical order.
-* Do not repeat concept definitions inline in tutorials or docstrings — link to the glossary instead using a relative markdown link (e.g. `[moneyness](../glossary.md#moneyness)`).
+* Do not repeat concept definitions inline in tutorials or docstrings, link to the glossary instead using a relative markdown link (e.g. `[moneyness](../glossary.md#moneyness)`).
+* Use relative links for all mkdocs page links (e.g. `[Option Pricing](../theory/option_pricing.md)`) — prefer relative over absolute URLs to keep links shorter and portable.
+* Prefer mkdocstrings relative cross-references whenever the target is visible from the current scope: write `[label][.member]` (same class) or `[label][..Sibling]` (same module) instead of repeating the fully-qualified path. Use the full path only when the target lives in a different module than the current docstring.
 * To rebuild doc examples run `uv run ./dev/build-examples` — runs all scripts in `docs/examples/` and writes their output to `docs/examples_output/`
 
 ## Pydantic models
 
-* Always document Pydantic fields with `Field(description=...)` — never use a docstring below a field assignment
+* Always document Pydantic fields with `Field(description=...)`, never use a docstring below a field assignment
 * Split long description strings across lines using implicit string concatenation rather than shortening the text
 * When a docstring line exceeds the line length limit, split it across multiple lines rather than shortening the text
+* Put Pydantic config options directly in the class definition, not as a `model_config = ConfigDict(...)` class variable:
+  ```python
+  # correct
+  class Foo(BaseModel, arbitrary_types_allowed=True): ...
+
+  # wrong
+  class Foo(BaseModel):
+      model_config = ConfigDict(arbitrary_types_allowed=True)
+  ```
 
 ## Package structure
 
 * 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
 * mkdocs documentation pages live in `docs/api/options/` — do not mix these two locations
 
-## Releasing
-
-The release procedure is fully driven by `make release` and the `release.yml` workflow:
-
-1. Bump `version` in `pyproject.toml` to the new release version.
-2. Add a `## vX.Y.Z` section to `docs/release-notes.md` with the notes for the release. The header text is matched verbatim by the workflow's `awk` extractor, so it must be `## vX.Y.Z` exactly (no trailing dash, no title after the version).
-3. Commit and merge to `main`.
-4. From `main`, run `make release` — it reads the version from `pyproject.toml`, prompts for confirmation, then creates an annotated `vX.Y.Z` tag and pushes it.
-5. The tag push triggers `.github/workflows/release.yml`, which runs lint and tests, publishes the package to PyPI (`make publish`), and posts the extracted `## vX.Y.Z` section as the GitHub Release body.
+## Code Conventions
 
-Do not publish to PyPI manually or via the old `head_commit.message == 'release'` flow — the tag-triggered workflow is the only supported path.
+* Always use `utcnow` from `quantflow.utils.dates` for getting the current UTC datetime, never use `datetime.utcnow()` or `datetime.now()`
+* Never import inside functions unless explicitly discussed; all imports should be at the top of the module

quantflow-1.0.0/.github/instructions/bibliography.instructions.md

@@ -0,0 +1,16 @@
+---
+name: quantflow-bibliography-instructions
+description: 'Instructions for bibliography in quantflow'
+applyTo: '/**'
+---
+
+Instructions for updating the bibliography for quantflow:
+
+* The bibliography for quantflow is maintained in `docs/references.bib`
+* Each entry must be added in alphabetical order of the label (the part after the first `{` in the bib entry).
+* Regenerate the markdown file `docs/bibliography.md` from the `bib` file using the
+  ```bash
+  make docs-bib
+  ```
+* Run this command every time you update the `bib` file to keep the markdown file in sync
+* Do not edit `docs/bibliography.md` directly as it is generated from `docs/references.bib`.

quantflow-1.0.0/.github/instructions/observable.instructions.md

@@ -0,0 +1,49 @@
+---
+name: quantflow-observable-instructions
+description: 'Instructions for Observable Framework pages in quantflow'
+applyTo: '/frontend/src/**'
+---
+
+
+# Observable Framework Instructions
+
+These instructions apply to markdown files in `frontend/src/`, which are rendered by Observable Framework.
+
+## Math
+
+Observable Framework uses KaTeX for math rendering. The syntax is different from standard markdown math (no `$...$` or `$$...$$`).
+
+- **Display math** (block, centered): use a `tex` fenced code block:
+
+  ````
+  ```tex
+  E = mc^2
+  ```
+  ````
+
+- **Inline math**: use the `tex` tagged template literal inside an inline expression:
+
+  ```
+  The smoothing factor ${tex`\alpha`} controls decay.
+  ```
+
+- Do not use `$...$` or `$$...$$` for math in Observable Framework pages.
+- Do not use `\begin{equation}...\end{equation}` (that convention applies only to mkdocs pages in `docs/`).
+
+## Downloads
+
+Always render download actions as a `<button>` element (not an `<a>` link). Use the pattern:
+
+```js
+const downloadData = () => {
+  const blob = new Blob([JSON.stringify(data, null, 2)], {type: "application/json"});
+  const url = URL.createObjectURL(blob);
+  const a = document.createElement("a");
+  a.href = url;
+  a.download = "filename.json";
+  a.click();
+  URL.revokeObjectURL(url);
+};
+
+display(html`<button onclick=${downloadData} style="cursor: pointer; background: var(--qf-primary); color: #fff; border: none; padding: 0.5em 1em; border-radius: 4px;">Download (JSON)</button>`);
+```

quantflow-1.0.0/.github/instructions/release.instructions.md

@@ -0,0 +1,48 @@
+# Release Instructions
+
+Releases are driven by `v*` git tags. Pushing a tag triggers
+`.github/workflows/release.yml`, which runs lint and the test suite, publishes
+the package to PyPI (`make publish`), then extracts the matching `## vX.Y.Z`
+section from `docs/release-notes.md` and publishes it as the GitHub Release
+body.
+
+## Cutting a release
+
+1. Bump `version` in `pyproject.toml` to the new release version.
+2. Add a `## vX.Y.Z` section at the top of `docs/release-notes.md` with the
+   notes for the release. The header text is matched verbatim by the
+   workflow's `awk` extractor, so it must be `## vX.Y.Z` exactly (no trailing
+   dash, no title after the version). The release workflow fails if this
+   section is missing.
+3. Commit and merge to `main`; let the `build` workflow pass.
+4. From `main`, run `make release` — it reads the version from
+   `pyproject.toml`, asks for confirmation, then creates an annotated `vX.Y.Z`
+   tag and pushes it. The `release` workflow takes it from there.
+
+Do not publish to PyPI manually, and do not revive the old
+`head_commit.message == 'release'` flow — the tag-triggered workflow is the
+only supported path.
+
+## Release-notes conventions
+
+The `## vX.Y.Z` section in `docs/release-notes.md` is rendered both on the
+docs site and as the GitHub Release body, so it must follow these conventions:
+
+- Open with a one-paragraph summary describing the theme of the release. If
+  the release contains breaking changes, point readers to the **Breaking
+  changes** section in that paragraph.
+- Group entries under H3 subsections in this order: `### Breaking changes`,
+  `### New features`, `### Improvements and fixes`,
+  `### Documentation and assets`. Omit any subsection that has no entries.
+- Every PR reference must be a markdown link of the form
+  `[#NN](https://github.com/quantmind/quantflow/pull/NN)` — never a bare
+  `(#NN)`. GitHub's auto-linking only works in some contexts, and the explicit
+  URL works everywhere. When one entry references multiple PRs, list them
+  comma-separated inside one set of parentheses, each as its own link.
+- Build the PR list by running `git log vPREV..HEAD --oneline` against the
+  previous release tag and following each squashed-merge commit back to its
+  PR. Cross-check with `gh pr list --state merged --base main` for any PRs
+  merged since the previous tag.
+- End the section with a
+  `[Full changelog](https://github.com/quantmind/quantflow/compare/vPREV...vX.Y.Z)`
+  link comparing the new tag against the previous one.

{quantflow-0.8.0 → quantflow-1.0.0}/.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: build
 on:
   push:
     branches-ignore:
-      - deploy
+      - main
     tags-ignore:
       - v*
 
@@ -31,6 +31,10 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      - name: Start Redis
+        uses: supercharge/redis-github-action@1.8.1
+        with:
+          redis-version: 7
       - name: Install uv
         run: pip install -U pip uv
       - name: Install dependencies
@@ -50,25 +54,7 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./build/coverage.xml
 
-  image:
-    if: github.ref == 'refs/heads/main'
-    uses: ./.github/workflows/docker-multiarch.yml
-    needs: build
+  examples:
+    uses: ./.github/workflows/examples.yml
     with:
-      image-name: quantflow
-
-  deploy:
-    name: Create Deployment
-    if: github.ref == 'refs/heads/main'
-    runs-on: ubuntu-latest
-    permissions:
-      deployments: write
-    needs: image
-    steps:
-      - uses: chrnorm/deployment-action@v2
-        name: Create GitHub deployment
-        id: deployment
-        with:
-          token: "${{ secrets.TOKEN_DEPLOYMENT }}"
-          environment: prod
-          payload: '{"tag": "main-${{ github.sha }}"}'
+      upload: false

{quantflow-0.8.0 → quantflow-1.0.0}/.github/workflows/docker-multiarch.yml

@@ -8,13 +8,24 @@ on:
         type: string
 
 jobs:
+  build-examples:
+    uses: ./.github/workflows/examples.yml
+    with:
+      upload: true
+
   build-amd64:
+    needs: build-examples
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{ github.token }}
 
     steps:
       - uses: actions/checkout@v4
+      - name: download examples output
+        uses: actions/download-artifact@v4
+        with:
+          name: examples-output
+          path: docs
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
         with:
@@ -31,6 +42,7 @@ jobs:
         run: rops docker push ${{ inputs.image-name }} --arch
 
   build-arm64:
+    needs: build-examples
     runs-on: ubuntu-24.04-arm
     env:
       GITHUB_TOKEN: ${{ github.token }}
@@ -38,6 +50,11 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+      - name: download examples output
+        uses: actions/download-artifact@v4
+        with:
+          name: examples-output
+          path: docs
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
         with:

quantflow-1.0.0/.github/workflows/examples.yml

@@ -0,0 +1,37 @@
+name: examples
+
+on:
+  workflow_call:
+    inputs:
+      upload:
+        description: Upload the generated outputs as an artifact
+        type: boolean
+        default: true
+
+jobs:
+  build-examples:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ github.token }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - name: Install uv
+        run: pip install -U pip uv
+      - name: Install dependencies
+        run: uv sync --frozen --no-install-project --group docs --extra data
+      - name: build examples
+        run: uv run ./dev/build-examples
+      - name: upload examples output
+        if: inputs.upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: examples-output
+          path: |
+            docs/assets/examples/
+            docs/examples/output/
+          if-no-files-found: error

quantflow-1.0.0/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  image:
+    uses: ./.github/workflows/docker-multiarch.yml
+    with:
+      image-name: quantflow
+
+  deploy:
+    name: Create Deployment
+    runs-on: ubuntu-latest
+    permissions:
+      deployments: write
+    needs: image
+    steps:
+      - uses: chrnorm/deployment-action@v2
+        name: Create GitHub deployment
+        id: deployment
+        with:
+          token: "${{ secrets.TOKEN_DEPLOYMENT }}"
+          environment: prod
+          payload: '{"tag": "main-${{ github.sha }}"}'

{quantflow-0.8.0 → quantflow-1.0.0}/.github/workflows/release.yml

@@ -16,6 +16,16 @@ permissions:
 jobs:
   release:
     runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
     env:
       PYTHON_ENV: ci
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{quantflow-0.8.0 → quantflow-1.0.0}/.gitignore

@@ -37,6 +37,11 @@ dist
 _build
 
 # builds
+docs/design
 app/docs
+app/examples
+frontend/node_modules
+frontend/src/.observablehq
 docs/assets/examples
 docs/examples/output
+docs/examples/cache

quantflow-1.0.0/CLAUDE.md

@@ -0,0 +1,7 @@
+@readme.md
+@.github/copilot-instructions.md
+@.github/instructions/bibliography.instructions.md
+@.github/instructions/makefile.instructions.md
+@.github/instructions/observable.instructions.md
+@.github/instructions/release.instructions.md
+@.github/instructions/tutorial.instructions.md

quantflow-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at luca@quantmind.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

{quantflow-0.8.0 → quantflow-1.0.0}/Makefile

@@ -5,11 +5,15 @@ help:
 	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
 	@echo ================================================================================
 
+.PHONY: app-serve
+app-serve:			## serve app
+	@MICRO_SERVICE_HOST=127.0.0.1 uv run python -m app
+
 .PHONY: docs
 docs:				## build documentation
 	@cp docs/index.md readme.md
 	@uv run ./dev/build-examples
-	@uv run mkdocs build
+	@uv run mkdocs build --strict
 
 .PHONY: docs-bib
 docs-bib:			## Regenerate docs bibliography
@@ -20,8 +24,17 @@ docs-examples:			## Regenerate docs examples
 	@uv run ./dev/build-examples
 
 .PHONY: docs-serve
-docs-serve:			## serve documentation
-	@uv run mkdocs serve --livereload --watch quantflow --watch docs
+docs-serve:			## serve docs, examples, and API with auto-reload
+	@bash ./dev/docs-serve
+
+.PHONY: frontend-build
+frontend-build:			## build Observable frontend examples
+	@rm -rf app/examples
+	@npm --prefix frontend run build
+
+.PHONY: frontend-serve
+frontend-serve:			## serve Observable frontend with auto-reload
+	@bash ./dev/frontend-serve
 
 .PHONY: install-dev
 install-dev:			## Install development dependencies
@@ -35,10 +48,6 @@ lint:				## Lint and fix
 lint-check:			## Lint check only
 	@uv run ./dev/lint
 
-.PHONY: marimo
-marimo:				## Run marimo for editing notebooks
-	@./dev/marimo edit
-
 .PHONY: outdated
 outdated:			## Show outdated packages
 	uv tree --outdated

quantflow-1.0.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: quantflow
+Version: 1.0.0
+Summary: quantitative analysis
+Project-URL: Homepage, https://github.com/quantmind/quantflow
+Project-URL: Repository, https://github.com/quantmind/quantflow
+Project-URL: Documentation, https://quantflow.quantmind.com
+Project-URL: Issues, https://github.com/quantmind/quantflow/issues
+Author-email: Luca Sbardella <luca@quantmind.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: finance,options,pricing,quantitative,stochastic,volatility
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.11
+Requires-Dist: ccy>=2.0.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pydantic>=2.0.2
+Requires-Dist: scipy>=1.14.1
+Requires-Dist: statsmodels<0.15.0,>=0.14.6
+Provides-Extra: data
+Requires-Dist: aio-fluid[http]>=2.4.0; extra == 'data'
+Provides-Extra: ml
+Requires-Dist: torch>=2.12.0; extra == 'ml'
+Description-Content-Type: text/markdown
+
+# <a href="https://quantmind.github.io/quantflow"><img src="https://raw.githubusercontent.com/quantmind/quantflow/main/docs/assets/logos/quantflow-lockup.svg" width=300 /></a>
+
+[![PyPI version](https://badge.fury.io/py/quantflow.svg)](https://badge.fury.io/py/quantflow)
+[![Python versions](https://img.shields.io/pypi/pyversions/quantflow.svg)](https://pypi.org/project/quantflow)
+[![Python downloads](https://static.pepy.tech/badge/quantflow/month)](https://pepy.tech/project/quantflow)
+[![build](https://github.com/quantmind/quantflow/actions/workflows/build.yml/badge.svg)](https://github.com/quantmind/quantflow/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/quantmind/quantflow/branch/main/graph/badge.svg?token=wkH9lYKOWP)](https://codecov.io/gh/quantmind/quantflow)
+
+Quantitative analysis and pricing tools.
+
+![btcvol](https://github.com/quantmind/quantflow/assets/144320/88ed85d1-c3c5-489c-ac07-21b036593214)
+
+## Installation
+
+```bash
+pip install quantflow
+```
+### Optional dependencies
+
+* `data` — data retrieval: `pip install quantflow[data]`
+* `ml` — training the Deep Implied Volatility model: `pip install quantflow[ml]`
+
+## Features
+
+* **Stochastic Processes**: a library of continuous-time models including Wiener processes, Poisson jumps, CIR mean-reverting dynamics, Heston stochastic volatility, jump-diffusion models, and the Barndorff-Nielsen & Shephard (BNS) model. Each process exposes its [characteristic function](https://quantflow.quantmind.com/theory/characteristic/) for analytical pricing.
+
+* **Option Pricing and Calibration**: Black-Scholes pricing, implied volatility surfaces, SVI parameterisation, put/call parity, and model calibration (Heston, Double Heston). Includes support for both inverse (crypto) and standard (equity) quoting conventions.
+
+* **Interest Rates**: yield curve construction via Nelson-Siegel and Vasicek models, discount factor calculation, and rate interpolation.
+
+* **Market Data**: connectors for [Deribit](https://www.deribit.com), [Yahoo Finance](https://finance.yahoo.com), [Financial Modeling Prep](https://financialmodelingprep.com) (FMP), [FRED](https://fred.stlouisfed.org), the [Federal Reserve](https://www.federalreserve.gov), and [US Fiscal Data](https://fiscaldata.treasury.gov) APIs.
+
+* **Time Series Analysis**: exponentially weighted moving averages (EWMA), Kalman filtering, super-smoothers, and OHLC bar utilities.
+
+* **JSON Serializable**: all models and pricers are built on [Pydantic](https://docs.pydantic.dev), making them fully serializable to and from JSON.
+
+## Contributing
+
+Contributions are welcome! See the [contributing guide](https://quantflow.quantmind.com/contributing/) for how to get started, including documentation contributions, which are a great entry point.
+
+## Citation
+
+If you use Quantflow in your research, please cite it using the metadata in [CITATION.cff](https://github.com/quantmind/quantflow/blob/main/CITATION.cff).
+
+## License
+
+Released under the [BSD 3-Clause License](https://github.com/quantmind/quantflow/blob/main/LICENSE).