Merge pull request #1596 from vnpy/docs

Docs
This commit is contained in:
vn.py 2019-04-15 11:05:37 +08:00 committed by GitHub
commit a0f941d8af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 61 additions and 13 deletions

View File

@ -91,10 +91,13 @@ $ bash Miniconda3-latest-Linux-x86_64.sh
安装过程中可以一直按“Enter”键继续下去除了以下这点
当询问是否把Miniconda设置为Python 默认环境时,把默认的"no"改成“yes”。原因是Ubuntu 18.04已有自带的Python 3.6与Python 2.7。
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/install.bat/install_Miniconda_ubuntu.png "enter image title here")
重启Ubuntu后打开终端直接输入"python" 然后按“Enter”键: 若出现如下图则表示成功把Miniconda设置为Python默认环境。
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/install.bat/Conda_Python_version.png "enter image title here")
 

View File

@ -1,7 +1,7 @@
# 基本使用
## 1.启动VN Trader
## 1. 启动VN Trader
### 1.1 VN Station模式
登陆VN Station后点击VN Trade Lite快速进入VN Trader只有CTP接口或者点击VN Trader Pro先选择如下图的底层接口和上层应用再进入VN Trader。
@ -19,7 +19,7 @@ python run.py
 
## 2.连接接口
## 2. 连接接口
以SinNow仿真交易账号登陆CTP接口为例点击菜单栏的“系统”->“连接CTP”后弹出如上图所示CTP接口的配置对话框输入以下内容后即可登录
- 用户名username111111 6位纯数字账号
- 密码password1111111 (需要修改一次密码用于盘后测试)
@ -34,7 +34,7 @@ python run.py
 
## 3.订阅行情
## 3. 订阅行情
在交易组件输入交易所和合约代码并且按“Enter”键即可订阅器行情。如订阅IF股指期货交易所CFFEX名称IF905铁矿石期货交易所DCE名称i1905。
此时行情组件会显示最新行情信息;交易组件会显示合约名称,并且在下方显示深度行情报价:如最新价、买一价、卖一价。(数字货币品种可以显示十档行情)
@ -45,7 +45,7 @@ python run.py
 
## 4.委托交易
## 4. 委托交易
交易组件适用于手动交易。除了在行情订阅中输入的交易所和合约代码以外还需要填写以下5个字段委托方向、开平仓类型、委托类型、委托价格和委托数量。若委托类型为市价单委托价格可不填。
发出委托同时本地缓存委托相关信息,并且显示到委托组件和活动组件,其委托状态为“提交中”,然后等待委托回报。
@ -59,11 +59,14 @@ python run.py
 
## 5.数据监控
## 5. 数据监控
数据监控由以下组件构成并且附带2个辅助功能选定以下任一组件鼠标右键可以选择“调整列宽”特别适用于屏幕分辨率较低或者选择“保存数据”csv格式
### 5.1行情组件
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/2_optiones.png "enter image title here")
### 5.1 行情组件
用于对订阅的行情进行实时监控如下图监控内容可以分成3类
- 合约信息:合约代码、交易所、合约名称
@ -75,12 +78,12 @@ python run.py
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/subcribe_contract_module.png "enter image title here")
### 5.2活动组件
### 5.2 活动组件
活动组件用于存放还未成交的委托,如限价单或者没有立刻成交的市价单,委托状态永远是“提交中”。在该组件中鼠标双击任一委托可以完成撤单操作。
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/active_order.png "enter image title here")
### 5.3成交组件
### 5.3 成交组件
成交组件用于存放已成交的委托需要注意3个字段信息价格、数量、时间。他们都是交易所推送过来的成交信息而不是委托信息。
注意有些接口会独立推送成交信息如CTP接口有些接口则需要从委托信息里面提取成交相关字段如Tiger接口。
@ -89,13 +92,13 @@ python run.py
### 5.4委托组件
### 5.4 委托组件
委托组件用于存放用户发出的所有委托信息,其委托状态可以是提交中、已撤销、部分成交、全部成交、拒单等等。
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/order.png "enter image title here")
### 5.5持仓组件
### 5.5 持仓组件
持仓组件用于记录其历史持仓。其中需要了解以下字段含义
- 方向:期货品种具有多空方向;而股票品种方向为“净”持仓。
- 昨仓:其出现衍生于上期所特有的平今、平昨模式的需要
@ -107,7 +110,7 @@ python run.py
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/query_position.png "enter image title here")
### 5.6资金组件
### 5.6 资金组件
资金组件显示了账号的基础信息如下图需要注意3个字段信息
- 可用资金:可以用于委托的现金
- 冻结:委托操作冻结的金额(与保证金不是一个概念)
@ -119,12 +122,54 @@ python run.py
### 5.7日志组件
### 5.7 日志组件
日志组件用于显示接口登陆信息以及委托报错信息,如下图。
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/write_log.png "enter image title here")
 
## 6.应用模块
## 6. 应用模块
vnpy官方目前提供2个应用模块组件分别是用于自动交易的“CTA策略”组件把第三方数据文件导入到数据库的“CSV载入”组件。在菜单栏中点击“功能”即显示应用模块如下图
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/application.png "enter image title here")
### 6.1 CTA策略
CTA策略组件默认使用RQData的数据进行自动交易故需要配置好RQData相关数据。
1 在用户目录下.vntrader文件夹找到vt_setting.json输入RQData的账号和密码保存退出后启动CTA策略组件会显示“RQData数据接口初始化成功”如图
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/RQData.png "enter image title here")
2在左上方的菜单栏选择策略如“AtrRsiStrategy”然后点击右边的“添加策略”按钮用于策略实例创建选择策略适用品种和修改该测试示例的参数如图
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/trader_2.PNG "enter image title here")
3每一个策略示例都有其“初始化”、“启动”、“停止”、“编辑”、“移除”按钮。注意在启动策略前必须先初始化移除策略前需要先停止策略。右上方菜单栏有批量处理功能方便用户快速启动、停止策略如图
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/turtle_strategy.png "enter image title here")
 
### 6.2 CSV载入
CSV文件是用户最主要的历史数据来源之一用户只需根据CSV文件中的表头字段以及时间格式灵活配置即可实现一键载入历史数据。
CSV载入操作分为3步
1打开CSV文件查看表头字段以及时间格式如图
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/csv_format.png "enter image title here")
2点击菜单栏的“功能”->“CSV载入”进入界面后选择要载入的CSV文件并且修改相关表头字段和时间格式若有需要的话。如下图
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/csv_loader.png "enter image title here")
3点击“载入数据”后成功界面如下图所示。
![enter image description here](https://vnpy-community.oss-cn-shanghai.aliyuncs.com/forum_experience/yazhang/quick_start/exito_csv_load.png "enter image title here")