Skip to content

Commit

Permalink
Merge branches 'develop' and 'master' of https://github.com/ricequant…
Browse files Browse the repository at this point in the history
…/rqalpha into develop
  • Loading branch information
EricWang committed Feb 27, 2017
2 parents a67d00b + 4d0f00d commit 2e59731
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 46 deletions.
55 changes: 35 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ RQAlpha 所有的策略都可以直接在 `Ricequant`_ 上进行回测和实盘

`Ricequant`_ 是一个开放的量化算法交易社区,为程序化交易者提供免费的回测和实盘模拟环境,并且会不间断举行实盘资金投入的量化比赛。

Feature
特点
============================

* 易于使用: RQAlpha让您集中于策略的开发,一行简单的命令就可以执行您的策略。
Expand All @@ -44,17 +44,7 @@ Feature
* 灵活的配置: RQAlpha 提供了一系列的配置选项,用户可以通过简单的配置来构建适合自己的交易系统。
* 强大的扩展性: RQAlpha 定义了一系列的 Mod Hook 接口,开发者可以基于 Mod 的开发模式,扩展 RQAlpha,无论是做实时监控,还是归因分析,RQAlpha 都可以通过扩展来实现。

Getting Help
============================

关于RQAlpha的任何问题可以通过以下途径来获取帮助

* 查看 `FAQ`_ 页面找寻常见问题及解答
* 可以通过 `索引`_ 或者 `搜索`_ 来查找特定问题
* 在 `Github Issue`_ 中提交issue
* RQAlpha 交流群「487188429」

Quick Guide
快速指引
============================

* `RQAlpha 介绍`_
Expand All @@ -68,20 +58,45 @@ RQAlpha API
* `参数配置`_ : 启动 RQAlpha 参数配置
* `API`_ : RQAlpha API 文档

Development
机构版
============================

* `How To Contribute`_ : 如何加入 RQAlpha 的开发
* `Basic Concept`_ : 基本概念
* `RQAlpha Mod`_ : 基于Mod来开发和扩展RQAlpha
目前 RQAlpha 开源版仅开放了日级别的历史数据和日回测功能,如果您是机构用户,需要做算法交易亦或是量化研究,都可以联系我们的机构端产品销售获得机构端产品功能支持。「销售电话」:0755-33967716 「QQ」:4848371

Extra
机构端产品功能:

*   可以本地部署,使用pycharm、anaconda等工具做本地策略研发、模拟以及实盘交易,效率大大加强,本地管理自己的策略提高保密性
*   极速调取经过清洗处理的历史数据接口服务,包括了:400多项指标的财务数据,股票、期货、ETF、LOF、分级基金等等10年+的日和分钟、tick级别的历史数据以及每日更新,股票、期货的实时数据支持,指数以及构成,板块分类,股本、换手率、融资融券等,天猫等电商销量数据,公募基金数据,舆情、公告类
* 股票、期货的实盘交易订单管理系统以及实盘下单支持,从回测到实盘交易的一条龙系统以及服务支持
* 策略的管理以及实盘的收益、风险计算等
* 交易数据的保存以及提取分析
* 业绩分析和风险管理系统
* 技术支持及定制化开发

加入开发
============================

* `如何贡献代码`_
* `基本概念`_
* `RQAlpha 基于 Mod 进行扩展`_

其他
============================

* `FAQ`_
* `History`_
* `TODO`_

获取帮助
============================

关于RQAlpha的任何问题可以通过以下途径来获取帮助

* 查看 `FAQ`_ 页面找寻常见问题及解答
* 可以通过 `索引`_ 或者 `搜索`_ 来查找特定问题
* 在 `Github Issue`_ 中提交issue
* RQAlpha 交流群「487188429」


.. _Github Issue: https://github.com/ricequant/rqalpha/issues
.. _Ricequant: https://www.ricequant.com/algorithms
Expand All @@ -99,9 +114,9 @@ Extra
.. _参数配置: http://rqalpha.readthedocs.io/zh_CN/stable/api/config.html
.. _API: http://rqalpha.readthedocs.io/zh_CN/stable/api/base_api.html

.. _How To Contribute: http://rqalpha.readthedocs.io/zh_CN/stable/development/make_contribute.html
.. _Basic Concept: http://rqalpha.readthedocs.io/zh_CN/stable/development/basic_concept.html
.. _RQAlpha Mod: http://rqalpha.readthedocs.io/zh_CN/stable/development/mod.html
.. _如何贡献代码: http://rqalpha.readthedocs.io/zh_CN/stable/development/make_contribute.html
.. _基本概念: http://rqalpha.readthedocs.io/zh_CN/stable/development/basic_concept.html
.. _RQAlpha 基于 Mod 进行扩展: http://rqalpha.readthedocs.io/zh_CN/stable/development/mod.html
.. _History: http://rqalpha.readthedocs.io/zh_CN/stable/history.html
.. _TODO: http://rqalpha.readthedocs.io/zh_CN/stable/todo.html

4 changes: 2 additions & 2 deletions docs/source/development/basic_concept.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _development-basic-concept:

==================
Basic Concept
基本概念
==================

Interface
接口
==================

.. module:: rqalpha.interface
Expand Down
4 changes: 2 additions & 2 deletions docs/source/development/make_contribute.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _development-make-contribute:

==================
How To Contribute
如何贡献代码
==================

.. _Ricequant: https://www.ricequant.com/algorithms
Expand All @@ -16,7 +16,7 @@ RQAlpha 所有的开发工作都将会在 `RQAlpha Github`_ 上进行,无论

.. _development-make-contribute-branch-management:

Branch Management
分支管理
--------------------------

`master 分支`_ 为最新稳定版本,只有团队成员在发布新版本时才会将充分测试的 `develop 分支`_ 合并到 `master 分支`_ 中。
Expand Down
29 changes: 15 additions & 14 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,11 @@ RQAlpha 所有的策略都可以直接在 `Ricequant`_ 上进行回测和实盘
`Ricequant`_ 是一个开放的量化算法交易社区,为程序化交易者提供免费的回测和实盘模拟环境,并且会不间断举行实盘资金投入的量化比赛。


Getting Help
==================

关于RQAlpha的任何问题可以通过以下途径来获取帮助

* 查看 :doc:`FAQ <faq>` 页面找寻常见问题及解答
* 可以通过 :ref:`genindex` 或者 :ref:`search` 来查找特定问题
* 在 `github issue page`_ 中提交issue
* RQAlpha 交流群「487188429」

Quick Guide
快速指引
==================

.. toctree::
:caption: Quick Guide
:caption: 快速指引
:hidden:

intro/overview
Expand Down Expand Up @@ -94,7 +84,7 @@ RQAlpha API
扩展API(开源版暂不支持,可以通过Ricequant平台或者商业版使用)


Development
扩展 RQAlpha
==================

.. toctree::
Expand All @@ -114,7 +104,7 @@ Development
:doc:`development/mod`
基于Mod来开发和扩展RQAlpha

Extra
其他
==================

.. toctree::
Expand All @@ -134,6 +124,17 @@ Extra
:doc:`todo`
TODO


获取帮助
==================

关于RQAlpha的任何问题可以通过以下途径来获取帮助

* 查看 :doc:`FAQ <faq>` 页面找寻常见问题及解答
* 可以通过 :ref:`genindex` 或者 :ref:`search` 来查找特定问题
* 在 `github issue page`_ 中提交issue
* RQAlpha 交流群「487188429」

.. _github issue page: https://github.com/ricequant/rqalpha/issues
.. _Ricequant: https://www.ricequant.com/algorithms

15 changes: 7 additions & 8 deletions docs/source/intro/detail_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ For CentOS
.. code-block:: bash
Welcome to Anaconda3 4.2.0 (by Continuum Analytics, Inc.)
In order to continue the installation process, please review the license
agreement.
Please, press ENTER to continue
>>>
Expand All @@ -74,13 +74,13 @@ For CentOS
echo "backend: Agg" > ~/.config/matplotlib/matplotlibrc

安装中文字体: 将 WenQuanYi Micro Hei.ttf 放到 /usr/share/fonts/chinese
安装中文字体: 将 WenQuanYi Micro Hei.ttf 放到 /usr/share/fonts/chinese

.. code-block:: bash
mkdir /usr/share/fonts/chinese
cd /usr/share/fonts/chinese
wget https://static.ricequant.com/assets/data/WenQuanYi%20Micro%20Hei.ttf
wget https://static.ricequant.com/data/WenQuanYi%20Micro%20Hei.ttf
fc-cache -fv
fc-list
rm -rf ~/.cache/matplotlib
Expand Down Expand Up @@ -117,7 +117,7 @@ conda 虚拟环境

.. code-block:: bash
conda create --name env_name python=3.5
conda create --name env_name python=3.5
* 使用 conda 虚拟环境

Expand Down Expand Up @@ -156,4 +156,3 @@ RQAlpha 的相关安装 请参考 :ref:`intro-install`
如果发现无法通过 pip 安装,请访问 https://mrjbq7.github.io/ta-lib/install.html 解决。

对于 Windows 用户,如果编译困难,可以根据您本地的Python版本下载指定的whl包,然后 `pip install TA_Lib-0.4.9-cp27-none-win_amd64.whl` 来完成安装。

0 comments on commit 2e59731

Please sign in to comment.