Skip to main content

Overview

The examples/community/ directory contains open-source Jupyter notebooks contributed by community members. Each notebook demonstrates a quantitative finance concept implemented as a working ClyptQ strategy or analysis. Community examples are designed to be:
  • Self-contained — each notebook runs independently with a single pip install clyptq
  • Educational — theoretical background alongside practical implementation
  • Copy-paste ready — use them as starting points for your own strategies

How It Works

Community members contribute notebooks to the examples/community/ directory via pull request. Each notebook follows a consistent structure:
  1. Theory section — mathematical background and intuition
  2. Implementation — ClyptQ graph construction with operators
  3. Backtest — full TradingSpec configuration and execution
  4. Analysis — performance metrics, visualizations, and interpretation

Browsing Examples

Browse the community examples on GitHub:
Topics range from foundational concepts (mean reversion, portfolio optimization, Kelly criterion) through advanced analysis (regime switching, factor models, IC analysis) to comprehensive alpha library backtests (Alpha101, Alpha191).

Contributing

To contribute a community example:
  1. Create a Jupyter notebook in examples/community/ following the naming convention: {number}_{descriptive_name}.ipynb
  2. Include theory, implementation, backtest, and analysis sections
  3. Submit a pull request

First Strategy

Official tutorial: build your first strategy step by step

Jupyter Workflow

How ClyptQ works inside Jupyter notebooks