通过 PyCharm 运行/调试

下载并搭建PyCharm环境

有众多Python IDE(集成开发环境)可以供您选择,但我们强烈建议您使用PyCharm,一方面PyCharm的功能强大且简洁易用,另一方面以下文档我们也选择PyCharm作为样例。

您可以在选择在官网下载PyCharm:https://www.jetbrains.com/pycharm/

选择community版本即可,如您有需要也可以购买专业版。

安装好以后我们十分建议您将主题颜色更改为【Darcula】,没有什么,就是看着爽。

https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/pycharm-theme.png

在PyCharm下搭建开发环境

我们假设您已经使用Anaconda搭建虚拟环境【rqalpha】,同时您已经成功安装了rqalpha并能成功运行。

如您在安装中遇到问题,请参考: 安装指南

1.新建一个项目:

File→ New Project, 比如项目叫做rqalpha-strategy

https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/create-project.jpeg

警告

在 Windows 环境下,并不存在 bin 目录,Interpreter 请指定 \anaconda\envs\rqalpha\Scripts\python.exe

2.对项目进行对应的python解释器的虚拟环境配置:

PyCharm Community Edition → Preferences → Project: rqalpha-strategy → Project Interpreter, 然后选择您创建的conda的虚拟环境,这个例子里面的话是放在:~/anaconda/envs/rqalpha/bin/python:

https://github.com/ricequant/rq-resource/blob/master/rqalpha/preferences.jpeg?raw=true

项目创建好以后,新建立一个简单的 rqalpha 策略吧,比如叫做 test.py: 右键点击rqalpha-strategy项目→ New→ File→ test.py:

在test.py策略里面import所有的rqalpha支持的API: from rqalpha.api import *,那么可以享受到代码的自动补全了:

策略必须添加 init,before_trading,ha`ndle_bar 函数来补全整个策略:

https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/import.jpeg

3.配置运行的命令行rqalpha的在conda环境中的位置:

警告

在 Windows 环境下

如果是 Python 2.7 则没有对应的入口脚本,需要找到对应的 __main__.py 文件,参考路径: c:\Users\xxx\Anaconda2\envs\rqalpha2_7\lib\site-packages\rqalpha\__init__.py

如果是 Python 3.5 及以上,在 /Scripts/ 目录下是存在 rqalpha-script.py 文件的,其可以作为入口文件。参考路径: C:\Users\xxx\Anaconda2\envs\rqalpha3_5\Scripts\rqalpha-script.py

相关 issue 讨论 请参考 Issue 7

Run/Debug Configurations → 选择策略文件 → Configuration → Script → 找到对应的conda环境的rqalpha命令

https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/config-one.jpeg

配置rqalpha-plus run的命令行:Run/Debug Configurations → 选择策略文件 → Configuration → Script parameters

https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/config-two.jpeg

Python interpreter 内容可按以下格式并修改您对应的参数:

run -f rqalpha-strategy/test.py -d /Users/your_count/.rqalpha/bundle -s 2016-06-01 -e 2016-12-01 --stock-starting-cash 100000 --benchmark 000300.XSHG

注意:您需要运行的策略应当填写您当前project目录下的策略,bundle目录您可以通过在命令行中获取绝对路径填入。

4.配置完成运行测试:

配置完成后点击运行

https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/run.jpeg https://raw.githubusercontent.com/ricequant/rq-resource/master/rqalpha/after-run.jpeg