Skip to main content

A quantitative finance library and cli for systematic trading

Project description

quantlib

PyPI version CI GHCR

Minimal, self-contained CLI tools and library for quantitative finance.

Subcommands

  • corr: Compute correlation matrices over time from returns.
  • costs: Calculate Sharpe Ratio (SR) costs for instruments based on spread and fees.

Modules

  • estimators: Volatility and Forecast Scalar estimators — contains robust_vol_calc and mixed_vol_calc for daily volatility estimation, and forecast_scalar for scaling forecasts.
  • accounts: P&L calculation framework — contains account_forecast for generating P&L curves from forecasts and prices.

Install (editable - for developers)

From the repo root:

  • cd quantlib
  • python -m pip install -e .

This installs the quantlib command.

  • uv sync --extra dev

Docker

Pull a published image from GitHub Container Registry:

  • docker pull ghcr.io/rodionlim/quantlib-st:latest

Run a quick correlation query by piping a CSV into the container (one-liner):

  • cat sample_data/returns_10x4.csv | docker run --rm -i ghcr.io/rodionlim/quantlib-st:latest corr --min-periods 3 --ew-lookback 10

When publishing the image the Makefile also tags and pushes :latest in addition to the versioned tag.

Package Sample Usage

Correlation

import pandas as pd
import numpy as np

from quantlib_st import correlation

# Sample data
data = pd.DataFrame(
    np.random.randn(100, 3),
    columns=['Asset_A', 'Asset_B', 'Asset_C'],
    index=pd.date_range(start='2020-01-01', periods=100, freq='D')  # daily dates
)
# Compute correlation matrix
corr_matrix = correlation.correlation_over_time(
    data,
    is_price_series=False,
    frequency='D', # resampling purpose
    interval_frequency='7D',
    date_method='expanding',
    ew_lookback=50,
    min_periods=10
)
print(corr_matrix.as_("jsonable"))
print(corr_matrix.as_("long"))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quantlib_st-1.12.0.tar.gz (171.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quantlib_st-1.12.0-py3-none-any.whl (232.2 kB view details)

Uploaded Python 3

File details

Details for the file quantlib_st-1.12.0.tar.gz.

File metadata

  • Download URL: quantlib_st-1.12.0.tar.gz
  • Upload date:
  • Size: 171.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for quantlib_st-1.12.0.tar.gz
Algorithm Hash digest
SHA256 a316e0f3d0bb6c26dc6c6a2b397d5522135d885b11755c3ba7b017ca401dda56
MD5 67465863009592dfe098d442fdf5b87f
BLAKE2b-256 4c3d084aa202c6d5f67339f21da915157cd7ad7463b1c6026970489541e43e90

See more details on using hashes here.

File details

Details for the file quantlib_st-1.12.0-py3-none-any.whl.

File metadata

  • Download URL: quantlib_st-1.12.0-py3-none-any.whl
  • Upload date:
  • Size: 232.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for quantlib_st-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6b644216fa476722d0bd8118b074dd92c01116e185cf3d53c117d6b4aa04054
MD5 43733474378f54b4ddefe265aeea2b17
BLAKE2b-256 0a4920446f29009bde3c40d0bb37c3bc731ea115028b62a0b39afc7d4f1c0b50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page