Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only.
UsEquityStrategies is the QuantStrategyLab US equity strategy package. It provides reusable strategy implementations and runtime metadata for QuantStrategyLab US equity platforms.
It is one layer of a multi-repository system:
- Strategy packages: hold reusable strategy code, metadata, and runtime entrypoints.
- Snapshot pipelines: produce feature snapshots, rankings, backtests, and release evidence.
- Platform runtimes: connect strategies to brokers, dry-run checks, notifications, and live deployment controls.
- Shared infrastructure: keeps contracts, settings, adapters, plugins, and audit workflows reusable across repositories.
This repository owns strategy code and metadata. It does not hold broker credentials, submit orders by itself, or replace the snapshot/backtest evidence required before a profile is enabled for live runtime settings.
These profiles can run from market history, portfolio snapshots, or other runtime inputs without a separate feature-snapshot build step.
| Profile | Name | Notes |
|---|---|---|
global_etf_rotation |
Global ETF Rotation | runtime-enabled ETF rotation using market history. |
tqqq_growth_income |
TQQQ Growth Income | runtime-enabled QQQ/TQQQ dual-drive profile with defensive and income sleeves. |
soxl_soxx_trend_income |
SOXL/SOXX Semiconductor Trend Income | runtime-enabled semiconductor ETF trend profile. |
nasdaq_sp500_smart_dca |
Nasdaq/S&P 500 Smart DCA | runtime-enabled buy-only DCA profile for broad US equity ETFs. |
These profiles depend on artifacts produced by UsEquitySnapshotPipelines before downstream platforms should use them.
| Profile | Name | Notes |
|---|---|---|
russell_1000_multi_factor_defensive |
Russell 1000 Multi-Factor | runtime-enabled feature-snapshot stock selector. |
mega_cap_leader_rotation_top50_balanced |
Mega Cap Leader Rotation Top50 Balanced | runtime-enabled feature-snapshot mega-cap leader rotation. |
Research-only profiles may stay in code for reproducibility and future review, but they should not appear in current configurable live profiles.
| Profile | Name | Notes |
|---|---|---|
tech_communication_pullback_enhancement |
Tech/Communication Pullback Enhancement | archived research-only; no longer a catalog/entrypoint runtime profile. |
Execution platforms consume this package through strategy loaders and runtime metadata. Current downstream platforms: CharlesSchwabPlatform, InteractiveBrokersPlatform, LongBridgePlatform, and FirstradePlatform.
Use the platform repositories for broker credentials, dry-run/live switches, order submission, and deployment settings.
Use this README as a map of the project, not as live performance data. Before enabling or changing a live profile, rerun the relevant snapshot/backtest pipeline and review short, medium, and long windows: return, max drawdown, benchmark-relative return, turnover, data freshness, and artifact version. If evidence is stale, incomplete, or the profile is marked research-only, keep it out of live runtime settings.
src/: library and runtime code.tests/: unit, contract, and regression tests.docs/: runbooks, design notes, evidence, and integration contracts..github/workflows/: CI, scheduled jobs, release, or deployment workflows.
python -m pip install -e .
python -m pytest -qdocs/tqqq_ai_extensions.mddocs/us_equity_contract_gap_matrix.mddocs/us_equity_notification_i18n_contract.mddocs/us_equity_notification_i18n_contract.zh-CN.mddocs/us_equity_portability_checklist.mddocs/us_equity_runtime_archive.zh-CN.mddocs/us_equity_strategy_status.zh-CN.mddocs/us_equity_strategy_template.md
- Keep secrets, account identifiers, tokens, cookies, and broker credentials out of Git and logs.
- Prefer small, reviewable changes with tests or reproducible evidence.
- For strategy changes, include the command or artifact used to validate behavior.
- See CONTRIBUTING.md for pull request scope, local verification, and documentation expectations.
- Follow CODE_OF_CONDUCT.md for maintainer and contributor conduct.
- Report credential, automation, broker, exchange, or cloud-resource vulnerabilities through SECURITY.md; do not open public issues for secrets or live-execution risk.
See LICENSE.