From d1e9e810774873a0a60f631fba7c021ab8008272 Mon Sep 17 00:00:00 2001 From: "vn.py" Date: Tue, 2 Apr 2019 16:50:43 +0800 Subject: [PATCH] [Mod]update readme and docs --- README.md | 41 ++++++++++++++++++++++++++--------------- docs/csv_loader.md | 0 docs/cta_strategy.md | 24 +++++++++++++++++++++++- docs/gateway.md | 0 docs/index.md | 17 +++++++++++++---- docs/install.md | 18 +++++++++++++++++- docs/introduction.md | 14 ++++++++++++++ docs/quickstart.md | 21 ++++++++++++++++++++- docs/rpc.md | 0 9 files changed, 113 insertions(+), 22 deletions(-) create mode 100644 docs/csv_loader.md create mode 100644 docs/gateway.md create mode 100644 docs/rpc.md diff --git a/README.md b/README.md index 0f60458b..ae3dfc70 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@

-vn.py是一套基于Python的开源量化交易系统开发框架，自2015年1月正式发布以来，在开源社区5年持续不断的贡献下一步步成长为全功能量化交易平台，目前国内外金融机构用户已经超过300家，包括：私募基金、证券自营和资管、期货资管和子公司、高校研究机构、自营交易公司、交易所、Token Fund等。 +vn.py是一套基于Python的开源量化交易系统开发框架，于2015年1月正式发布，在开源社区5年持续不断的贡献下一步步成长为全功能量化交易平台，目前国内外金融机构用户已经超过300家，包括：私募基金、证券自营和资管、期货资管和子公司、高校研究机构、自营交易公司、交易所、Token Fund等。 2.0版本基于Python 3.7全新重构开发，目前功能还在逐步完善中。如需Python 2上的版本请点击：[长期支持版本v1.9.2 LTS](https://github.com/vnpy/vnpy/tree/v1.9.2-LTS)。 @@ -22,17 +22,23 @@ vn.py是一套基于Python的开源量化交易系统开发框架，自2015年1 2. 覆盖国内外所有交易品种的交易接口（vnpy.gateway）： - * CTP(ctpGateway)：国内期货、期权 + * CTP(ctp)：国内期货、期权 - * 富途证券(futuGateway)：港股、美股 + * 宽睿(oes)：A股 - * Interactive Brokers(ibGateway)：全球证券、期货、期权、外汇等 + * 富途证券(futu)：港股、美股 - * BitMEX (bitmexGateway)：数字货币期货、期权、永续合约 + * 老虎证券(tiger)：全球证券、期货、期权、外汇等 + + * Interactive Brokers(ib)：全球证券、期货、期权、外汇等 + + * BitMEX (bitmex)：数字货币期货、期权、永续合约 3. 开箱即用的各类量化策略交易应用（vnpy.app）： - * CtaStrategy：CTA策略引擎模块，在保持易用性的同时，允许用户针对CTA类策略运行过程中委托的报撤行为进行细粒度控制（降低交易滑点、实现高频策略） + * cta_strategy：CTA策略引擎模块，在保持易用性的同时，允许用户针对CTA类策略运行过程中委托的报撤行为进行细粒度控制（降低交易滑点、实现高频策略） + + * csv_loader：CSV历史数据加载器，用于加载CSV格式文件中的历史数据到平台数据库中，用于策略的回测研究以及实盘初始化等功能，支持自定义数据表头格式 4. Python交易API接口封装（vnpy.api），提供上述交易接口的底层对接实现。 @@ -44,11 +50,9 @@ vn.py是一套基于Python的开源量化交易系统开发框架，自2015年1 ## 环境准备 -* 推荐使用vn.py团队为量化交易专门打造的Python发行版[VNConda-2.0-Windows-x86_64](https://conda.vnpy.com/VNConda-2.0-Windows-x86_64.exe)，内置了最新版的vn.py，无需手动安装 +* 推荐使用vn.py团队为量化交易专门打造的Python发行版[VNConda-2.0.1-Windows-x86_64](https://conda.vnpy.com/temp/VNConda-2.0.1-Windows-x86_64.exe)，内置了最新版的vn.py框架以及VN Station量化管理平台，无需手动安装 * 支持的系统版本：Windows 7以上/Windows Server 2008以上/Ubuntu 18.04 LTS * 支持的Python版本：Python 3.7 64位（**注意必须是Python 3.7 64位版本**） -* 如需使用IB API，请在[Interactive Brokers Github](https://interactivebrokers.github.io/#)页面下载安装**IB API Latest** - ## 安装步骤 @@ -67,15 +71,20 @@ vn.py是一套基于Python的开源量化交易系统开发框架，自2015年1 1. 在[SimNow](http://www.simnow.com.cn/)注册CTP仿真账号，并在[该页面](http://www.simnow.com.cn/product.action)获取经纪商代码以及交易行情服务器地址。 -2. 在[vn.py社区论坛](https://www.vnpy.com/forum/)注册获得VN Station账号密码，论坛最新的注册邀请码为**El86Pa1p** +2. 在[vn.py社区论坛](https://www.vnpy.com/forum/)注册获得VN Station账号密码（论坛账号密码即是） 3. 启动VN Station（安装VNConda后会在桌面自动创建快捷方式），输入上一步的账号密码登录 -4. 点击底部的**VN Trader**按钮，选择运行目录（默认在系统用户目录即可）后，在对话框中勾选CTP接口以及CtaStrategy应用，点击右下方的**启动**按钮，开始你的交易！！！ +4. 点击底部的**VN Trader Lite**按钮，开始你的交易！！！ -5. 在VN Trader的运行过程中请勿关闭VN Station（会自动退出） +注意： +* 在VN Trader的运行过程中请勿关闭VN Station（会自动退出） +* 如需要灵活配置量化交易应用组件，请使用**VN Trader Pro** -6. 如选择了VNConda以外的安装方式（不推荐新手），可以在任意目录下创建run.py，写入以下示例代码后运行： + +## 脚本运行 + +除了基于VN Station的图形化启动方式外，也可以在任意目录下创建run.py，写入以下示例代码： ```Python from vnpy.event import EventEngine @@ -85,7 +94,7 @@ from vnpy.gateway.ctp import CtpGateway from vnpy.app.cta_strategy import CtaStrategyApp def main(): - """启动VN Trader""" + """Start VN Trader""" qapp = create_qapp() event_engine = EventEngine() @@ -103,11 +112,13 @@ if __name__ == "__main__": main() ``` +在该目录下打开CMD（按住Shift->点击鼠标右键->在此处打开命令窗口/PowerShell）后运行下列命令启动VN Trader： + python run.py ## 贡献代码 -vn.py使用github托管其源代码，如果希望贡献代码请使用github的PR(Pull Request)的流程: +vn.py使用Github托管其源代码，如果希望贡献代码请使用github的PR(Pull Request)的流程: 1. [创建 Issue](https://github.com/vnpy/vnpy/issues/new) - 对于较大的改动(如新功能，大型重构等)最好先开issue讨论一下，较小的improvement(如文档改进，bugfix等)直接发PR即可 diff --git a/docs/csv_loader.md b/docs/csv_loader.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/cta_strategy.md b/docs/cta_strategy.md index e10b99d0..62d6106d 100644 --- a/docs/cta_strategy.md +++ b/docs/cta_strategy.md @@ -1 +1,23 @@ -# Introduction +# CTA策略模块 + + +## 模块构成 + + +## 历史数据 + + + +## 策略开发 + + +## 回测研究 + + + +## 参数优化 + + + +## 实盘运行 + diff --git a/docs/gateway.md b/docs/gateway.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/index.md b/docs/index.md index b5eea238..c9ce72c3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,15 @@ # vn.py文档 -* [vn.py简介](introduction.md) -* [项目安装](install.md) -* [基本使用](quickstart.md) -* [CTA策略模块](cta_strategy.md) \ No newline at end of file +* 快速入门 + * [项目简介](introduction.md) + * [环境安装](install.md) + * [基本使用](quickstart.md) + +* 应用模块 + * [CTA策略](cta_strategy.md) + * [CSV载入](csv_loader.md) + +* [交易接口](gateway.md) + +* [RPC应用](rpc.md) +* [贡献代码](contribution.md) \ No newline at end of file diff --git a/docs/install.md b/docs/install.md index bf0de3b5..48a78528 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,8 +1,24 @@ # 安装指南 +## Windows + +### 使用VNConda + + +### 手动安装 + + + ## Ubuntu -如果是英文系统，请先运行下列命令安装中文编码： + +### 安装脚本 + +### TA-Lib + +### 中文编码 + +如果是英文系统（如阿里云），请先运行下列命令安装中文编码： ``` sudo locale-gen zh_CN.GB18030 diff --git a/docs/introduction.md b/docs/introduction.md index e10b99d0..02971c01 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1 +1,15 @@ # Introduction + + +## 目标用户 + + +## 应用场景 + + + +## 支持的接口 + + + +## 支持的应用 \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md index e10b99d0..9536f20e 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1 +1,20 @@ -# Introduction +# 基本使用 + + +## 启动VN Trader + + +## 连接接口 + + +## 订阅行情 + + +## 委托交易 + + +## 数据监控 + + +## 应用模块 + diff --git a/docs/rpc.md b/docs/rpc.md new file mode 100644 index 00000000..e69de29b