注意,在进行下边步骤之前,您的本机需要有以下第三方软件才能运行代码:

  • Python 3.9+ - 如果您还没有安装或者不确定,请参考这篇文档
  • Postgresql / mysql - 如果您还没有安装,请参考这篇文档

第一步,将代码复制到本地

点击进入代码仓库 (二选一):

将代码复制到本地(两个仓库是类似方法,这里之后全部使用gitee做例子)

点击 “克隆/下载”

在弹出的窗口里选择下载zip文件到您的电脑后解压缩或者使用您的本地的命令行工具运行git clone命令

恭喜您完成了第一步,代码已经成功复制到了您的本地。

第二步,新建一个数据库

1. 新建一个数据库

本项目支持两种数据库:Postgresql(推荐)和Mysql
请您在本地安装其中一种数据库,然后使用管理工具(如PgAdmin 或 phpmyadmin 等等工具)进入您的数据库中新建一个数据库。
详细数据库操作方法请参考这篇文档

2. 在项目中配置您的数据库信息

  • 在项目的根目录下找到 userspace/config/database/ 
  • 拷贝 common.example.json 并且重命名为 common.json
  • 里边需要注明您要使用的是什么数据库,例如:
{
  "database_type": "postgresql" // 或是mysql
}
  • 接下来拷贝 postgresql.example.json (如果您用的是mysql,就使用mysql的example文件) 并且重命名为 postgresql.json(mysql.json)
  • 把您的数据库连接的用户名,密码和数据库名字等等这些基本信息填入json文件并保存

第三步,安装框架

在命令行工具里进入您上一步下载的工程根目录中:

cd <工程根目录的绝对路径>

注意:您需要在此网站注册会员后得到演示数据(3年)和更多演示策略(系统自带一个演示策略但不默认带演示数据)。

如果您已经注册会员,那么在您的个人页面会有下载数据和策略的超链接。请按照个人页面的说明将下载的数据和策略放入项目中的正确位置然后再进行下一步安装。如果您有自己的数据源(比如Tushare之类的,或者想使用免费的接口如Akshare,请忽略此步,直接运行下方命令,安装完成后需要自己接入数据源然后拉取数据才能运行回测)

请注意演示数据仅供快速安装和学习使用,请勿商用。

python3 install.py

程序会自动安装依赖以及数据(安装数据时间较久,请耐心等待)

第四步,检验安装

使用您的命令行工具进入项目的根目录可以轻易地使用start-cli运行命令:

查看命令帮助:

python3 start-cli.py -h 

运行模拟(注意您需要安装过演示数据或者接入您的数据源下载过数据才能有结果)

python3 start-cli.py -sp

运行过后您可以看到类似以下结果:

如果您看到了模拟结果,恭喜您已经成功安装好了这套框架,接下来就请随意试试其他功能吧

点击这里查看更多功能的用例。

请注意:在example策略以及注册后自带的另外两个策略(随机和动量策略)里您都会看到价格策略回测模拟ROI(收益)都是正的,但这并不代表这些策略在实际中可以获利。如果您使用 python3 start-cli.py -sa 命令跑动量策略,您就会发现在价格模拟回测(-sp)中ROI为正但实际收益模拟(-sa)中策略却会亏损,所以,不同策略的模拟有不同的作用。价格模拟回测更偏向想法可不可行,实盘带价格因子的模拟更接近于真实的操盘模拟,您可能会发现不同的资金管理策略会导致在价格模拟中出现的正收益实际变成负的盈利。这套框架是本着严谨的态度为大家能真实做出可盈利模型而去的,请大家在使用回测模型前理解每个回测的行为的意义,并做出相应改动从而真正获利。

最后还想说,通过模拟进行的策略制定还有很多其他的因子才能让它发挥真正的能力,例如纪律和执行力。模拟的结果更多是可行性和如何利益最大化的建议和验证,真正的盈利还需要更多因素的考虑。投资有风险,需务必谨慎