Skip to main content

WorldQuant Brain Alpha Research Automation Toolkit

Project description

wqb-toolkit

WorldQuant Brain Alpha Research Automation Toolkit

Overview

wqb-toolkit is a Python toolkit for automating alpha research workflows on the WorldQuant Brain (WQB) platform. It provides core infrastructure for:

  • Alpha Simulation: Multi-threaded batch simulation with queue-based result handling
  • Alpha Machine: Genetic iteration pipeline for alpha expression evolution
  • Correlation Analysis: Self, PPAC, prod, and self_web correlation calculations
  • Database Management: PostgreSQL ORM with SQLAlchemy for alpha metadata and PnL caching
  • Super Alpha Tools: Construction and simulation of SUPER-type alphas

Installation

pip install wqb-toolkit

Prerequisites

  • Python >= 3.10
  • PostgreSQL (for database features)
  • wqb SDK (WorldQuant Brain official SDK, install via pip)

Quick Start

from wqbkit.app.core.alpha_db_core import AlphaDbCore
from wqbkit.modules.correlation import AlphaCalcCorr

core = AlphaDbCore()
calcor = AlphaCalcCorr()

Configuration

Create a .env file in your project root:

DB_HOST=localhost
DB_PORT=5432
DB_NAME=WorldQuant
DB_USER=your_db_user
DB_PASSWORD=your_db_password
WQB_USERNAME=your_wqb_username
WQB_PASSWORD=your_wqb_password
WQB_API_BASE_URL=https://www.worldquantbrain.com

License

MIT

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

wqbkit-0.2.1.tar.gz (2.0 kB view details)

Uploaded Source

Built Distribution

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

wqbkit-0.2.1-py3-none-any.whl (1.8 kB view details)

Uploaded Python 3

File details

Details for the file wqbkit-0.2.1.tar.gz.

File metadata

  • Download URL: wqbkit-0.2.1.tar.gz
  • Upload date:
  • Size: 2.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for wqbkit-0.2.1.tar.gz
Algorithm Hash digest
SHA256 47f9308764018be8349c8cc56a595be37c7e5cf1fab8d1839e5258f5be3a1106
MD5 c147a3746a4db03a725e46b19a312e96
BLAKE2b-256 e98ee0c35d33486fed111fa91ab2943a20d316afabfc88817874df798f110cac

See more details on using hashes here.

File details

Details for the file wqbkit-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: wqbkit-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 1.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for wqbkit-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2ac0341e9f363383def7db8fc9d198dc6983f020512b98113a4619d75e11827
MD5 20d32770a096c8b9427622860e0ec442
BLAKE2b-256 604e94f1888bd5b864647e647f628a84c71fea82a15efd200fcdeb5ef6a40dea

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