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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wqbkit-0.2.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.2.0.tar.gz
Algorithm Hash digest
SHA256 ebc8d2c2a190d1bbc2ca609017b85bafa42a408d348dc6c59a65776304545b10
MD5 f39abd86b9dbd790e8de6700c1e6bd41
BLAKE2b-256 49cfe9183a127a5348d6f7e72f78f851a083199f15ef69bd25d83fdea93229ed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wqbkit-0.2.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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45427d92eb93aa9ce8a5f9d428aa3a818064a7f8d2c957bbd9add585284f8f29
MD5 de98dc81c9fa818659bfa1e3deab3b5f
BLAKE2b-256 e510f57d868ce47bcfdefaa7304ecd2fc3495d45e03d4e3eddd1171bdd696d00

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