安装与环境
语言:简体中文 · English
quant-platform 是一个 Python 项目。推荐使用 uv 创建环境、安装锁定依赖并运行命令。
安装开发环境
在仓库根目录执行:
uv sync --locked --all-groups
验证公开入口可以导入:
uv run python -c "import portfolio_backtester; print('portfolio_backtester is ready')"
运行检查
uv run --locked ruff check .
uv run --locked ruff format --check .
uv run --locked ty check --error-on-warning
uv run --locked pytest -q
以上是 Python 源码检查。CI 还验证精简依赖与 ML 依赖模式、构建可选 Rust wheel,并审计导出的锁定依赖。Rust 测试需要单独安装 wheel,默认 Python 测试不能证明该后端通过验证。根项目没有配置覆盖率门槛。完整 CI 命令见 .github/workflows/ci.yml。
完整测试会覆盖回测、组合构造、成本、执行模拟、产物契约和迁移兼容行为。第一次使用时,可以先阅读第一个回测,不需要先理解整个测试套件。
可选依赖
部分能力通过可选依赖提供:
| 能力 | 安装方式 |
|---|---|
| Qlib 后端 | uv sync --locked --all-groups --extra qlib |
| 微观结构模型与 Python 模拟器 | uv sync --locked --all-groups --extra microstructure |
| Rust 微观结构后端 | 按开发说明单独构建和安装 wheel |
| 文档站 | uv sync --locked --all-groups |
仓库的公开平台代码不需要数据供应商凭证,也不要求先接入真实行情数据。新人教程使用合成数据,便于先理解接口和输出。
下一步
完成安装后,继续阅读运行第一个回测。