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 separately)

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.1.0.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.1.0-py3-none-any.whl (1.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wqbkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fdbf1135445f94dcb1c77159e37be955175a781985cd50f094c75693fd734f93
MD5 804bf5a8301c4ffd278c28fb9ac64602
BLAKE2b-256 f03c3fc13325eab9263f90be5363b52f52457e7ca4648d4f050d7cb111617915

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wqbkit-0.1.0-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.2

File hashes

Hashes for wqbkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24cb42a0792b31e57007015d06c9277db1439516f3c05446d593c5ade2726bf9
MD5 87478e92b4aebc543fc100c923dbb568
BLAKE2b-256 838d2932cf49d4588ed8f1a757bb2c25c08b60a75f1026856d8fd198e23945e4

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