THSTrader 项目教程
1. 项目的目录结构及介绍
THSTrader 项目的目录结构如下:
THSTrader/
├── data/
│ └── ...
├── docs/
│ └── ...
├── scripts/
│ └── ...
├── src/
│ ├── data_processing/
│ │ └── ...
│ ├── strategies/
│ │ └── ...
│ ├── backtest/
│ │ └── ...
│ └── live_trading/
│ └── ...
├── tests/
│ └── ...
├── .gitignore
├── README.md
├── requirements.txt
└── setup.py
目录介绍
- data/: 存放项目所需的数据文件。
- docs/: 存放项目的文档文件。
- scripts/: 存放一些辅助脚本。
- src/: 项目的源代码目录,包含以下子目录:
- data_processing/: 数据处理模块。
- strategies/: 策略编写模块。
- backtest/: 回测模块。
- live_trading/: 实盘交易模块。
- tests/: 存放测试代码。
- .gitignore: Git 忽略文件配置。
- README.md: 项目说明文档。
- requirements.txt: 项目依赖包列表。
- setup.py: 项目安装脚本。
2. 项目的启动文件介绍
项目的启动文件通常位于 src/
目录下,具体文件名可能为 main.py
或 run.py
。以下是一个示例启动文件的内容:
# src/main.py
import sys
from data_processing import DataProcessor
from strategies import Strategy
from backtest import BacktestEngine
from live_trading import LiveTrading
def main():
# 初始化数据处理器
data_processor = DataProcessor()
# 初始化策略
strategy = Strategy()
# 初始化回测引擎
backtest_engine = BacktestEngine(data_processor, strategy)
# 运行回测
backtest_engine.run()
# 初始化实盘交易
live_trading = LiveTrading(data_processor, strategy)
# 运行实盘交易
live_trading.run()
if __name__ == "__main__":
main()
启动文件介绍
- main.py: 项目的入口文件,负责初始化和调用各个模块。
- 初始化数据处理器 (
DataProcessor
)。 - 初始化策略 (
Strategy
)。 - 初始化回测引擎 (
BacktestEngine
) 并运行回测。 - 初始化实盘交易 (
LiveTrading
) 并运行实盘交易。
- 初始化数据处理器 (
3. 项目的配置文件介绍
项目的配置文件通常为 config.py
或 settings.py
,位于项目根目录或 src/
目录下。以下是一个示例配置文件的内容:
# config.py
# 数据源配置
DATA_SOURCE = {
'type': 'tushare',
'api_key': 'your_tushare_api_key'
}
# 回测配置
BACKTEST_CONFIG = {
'start_date': '2020-01-01',
'end_date': '2023-01-01',
'initial_capital': 100000,
'commission_rate': 0.001
}
# 实盘交易配置
LIVE_TRADING_CONFIG = {
'broker': 'your_broker',
'account_id': 'your_account_id',
'password': 'your_password'
}
配置文件介绍
- config.py: 项目的配置文件,包含以下配置项:
- DATA_SOURCE: 数据源配置,包括数据源类型和 API 密钥。
- BACKTEST_CONFIG: 回测配置,包括回测开始日期、结束日期、初始资金和手续费率。
- LIVE_TRADING_CONFIG: 实盘交易配置,包括券商名称、账户 ID