Files
sanguo_quant_live/README.md
T
2026-05-01 13:06:57 +08:00

107 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# sanguo_quant_live - 量化实战项目
> 项目目录说明 | 最后更新: 2026-05-01
## 项目简介
三国量化团队的实战交易项目,包含策略开发、风控模块、数据平台、基础设施等。
## 目录结构
```
sanguo_quant_live/
├── README.md # 本文件
├── .gitignore # Git 忽略规则
├── data_platform/ # 数据平台(开发中)
├── guanyu-risk/ # 关羽:风控模块
│ ├── common/ # 通用风控组件
│ ├── realtime-system/ # 实时风控系统
│ └── research/ # 风控调研
├── jiangwei-platform/ # 姜维:基础设施
│ ├── scripts/ # 部署脚本(Docker、Windows Node 等)
│ ├── research/ # 平台调研
│ └── reports/ # 部署报告
├── management/ # 项目管理
│ ├── cicd/ # CI/CD 部署脚本(NAS 同步、自动回测)
│ └── workflow-rules.md # 工作流规则
├── pangtong-value/ # 庞统:价值投资研究
│ ├── research/ # 调研(策略回测结果、多因子分析)
│ ├── scripts/ # 策略脚本
│ └── reports/ # 研究报告
├── scripts/ # 全局通用脚本
├── simayi-quality/ # 司马懿:质量评审
├── strategies/ # 策略代码(通用)
├── zhangfei-technical/ # 张飞:技术分析
├── zhaoyun-data/ # 赵云:数据管理
│ ├── data/ # 数据文件(raw/running_data/processed
│ ├── scripts/ # 数据获取脚本
│ ├── research/ # 数据源调研
│ └── reports/ # 数据报告
└── archive/ # 历史归档(只读,不修改)
```
## 目录规则
### 1. 谁的目录谁负责
| 目录 | 负责人 | 放什么 |
|------|--------|--------|
| `guanyu-risk/` | 关羽 | 风控模块代码、风控调研 |
| `jiangwei-platform/` | 姜维 | 基础设施脚本、部署配置 |
| `pangtong-value/` | 庞统 | 策略研究、多因子分析 |
| `simayi-quality/` | 司马懿 | 评审文档 |
| `zhangfei-technical/` | 张飞 | 技术分析、策略编码 |
| `zhaoyun-data/` | 赵云 | 数据脚本、数据文件 |
| `data_platform/` | 共建 | 数据平台框架 |
| `strategies/` | 共建 | 通用策略代码 |
### 2. 不该放进项目的
| 禁止 | 原因 | 替代方案 |
|------|------|---------|
| ❌ 第三方仓库 clone | 占空间、不是自己的代码 | 放 `~/.openclaw/knowledge_base/` |
| ❌ 大数据文件(CSV>10MB) | git 不适合存大数据 | 放 NAS `/Volumes/stock/` |
| ❌ `__pycache__/``.pyc` | 编译缓存 | 已在 .gitignore |
| ❌ 日志文件 | 运行时产物 | 已在 .gitignore |
| ❌ 临时调试脚本 | 一次性产物 | 用完即删 |
| ❌ 在别人目录下写文件 | 职责混乱 | 通过 Sanguo Mail 协作 |
### 3. 调研产物处理
- 调研时的第三方参考代码 → `~/.openclaw/knowledge_base/`
- 调研报告 → 自己目录下的 `research/``reports/`
- 回测结果 → 自己目录下或 NAS,不进 git
### 4. 归档规则
过时文件统一移到 `archive/`,命名格式:`{来源}-{日期}/`
```
archive/
├── management-tasks-202603/ # 2026年3月的历史任务
├── management-workflow-202603/ # 早期工作流脚本
├── legacy-mail-system/ # 废弃的邮件系统
└── ...
```
## CI/CD
`management/cicd/` 包含部署和同步脚本:
- `sanguo_nas_ci_cd.sh` — NAS CI/CD 主脚本
- `sync_and_redeploy.sh` — 同步并重新部署
- `sync_strategy_only.sh` — 只同步策略文件
- `run_backtest_auto.py` — 自动回测
## 远程仓库
- **Gitee**: `cfdaily/sanguo_quant_live`
- **自动同步**: 通过 PM2 `sanguo-git-sync` 管理