快速上手
====================

功夫能做什么？
---------------------------------
在功夫，你可以获取一站式量化服务，包括 **盘前研究** 、 **盘中交易** 、 **盘后复盘** 

1. **盘前研究** ：支持 **基于Level 2/逐笔数据** 的 :ref:`回测 <回测>` 、:ref:`因子研究 <因子研究>` ；端内调试策略的可行性。
#. **盘中交易** ：支持 :ref:`算法下单 <算法下单>` 、 :ref:`手动下单 <手动下单>` 、 :ref:`键盘下单 <键盘下单>` 
#. **盘后复盘** ：导出委托、成交、持仓记录；端内通过 :ref:`诊断工具 <诊断工具>` 查看策略下单表现；利用 :ref:`回放功能 <回放功能>` 以盘中行情模拟撮合调整后的下单表现（下单逻辑调整/手续费调整）。

-----

使用Level 2、逐笔数据进行回测
-----------------------------------------------------

功夫提供基于level2、逐笔数据的回测功能，现在注册即送额度，欢迎使用！

需要先 `下载功夫客户端 <https://releases.kungfu-trader.com/>`_ 

(1) 点击左侧边栏“策略”

.. image:: _images/进入策略回测-27.png

(2) 点击“添加策略”，选择策略代码文件并完成策略添加。如果要回测的策略已添加，请跳到第三步

.. image:: _images/使用回测3-27.png

(3) 选中策略。

.. image:: _images/使用回测4-27.png

(4) 点击“运行回测”。选择回测数据源、回测起止时间。

.. image:: _images/使用回测5-27.png

.. image:: _images/使用回测6-27.png

回测将把策略所在路径中 **所有支持格式的文件打包上传** ，若策略需要引用其他文件，请放置在同一路径下，建议按文件夹管理策略。

.. image:: _images/使用回测7-27.png

(7) 回测任务提交成功，回测任务状态为“运行中”，可通过下方回测日志监测回测进度。 等待回测任务状态变为“已完成”即可进入下一步。

.. image:: _images/使用回测8-27.png

(8) 回测任务状态变为“已完成”，点击打开回测报告。

.. image:: _images/使用回测9-27.png

(9) 查看回测报告   

.. image:: _images/回测报告-报告概览.png

-----


快速开始因子研究
---------------------------------------

- **在功夫，借助功夫提供的示例策略及跨平台能力，你可以快速体验因子研究流程。**

功夫因子计算基于 市面上精度最高的Level 2 快照/逐笔行情数据。

因子研究一般包括“ :ref:`构造因子、运行因子 <构造因子>` 、 :ref:`将数据导入到jupyter notebook进行下一步研究 <接口获取因子>` ”，除了这些，功夫还支持 :ref:`在小程序上查看因子结果 <小程序获取因子结果>`  


.. _构造因子:

构造因子，开始计算
++++++++++++++++++++++++++++++++++++

首次尝试时，我们为您提供了示例策略，点击“一键自研”即可拷贝一份示例策略到本地

.. image:: _images/一键自研2-30.png
   :width: 600px
   :height: 384px

拷贝完毕后，点击“运行因子”，选择日期即可查看因子结果


.. image:: _images/运行因子2-30.png
   :width: 600px
   :height: 384px


-----


.. _接口获取因子:


python获取结果
+++++++++++++++++++++++++++++++++++++

因子计算完毕后，可以通过API接口直接获取。官方示例因子/自构造因子均支持接口获取，获取结果后，您就能在jupyter notebook等其他环境继续您的研究

::
    
    # 前置准备

    # 建议使用python3.9及以上版本

    1.下载安装kungfu.whl文件，命令: pip install {kungfu安装目录}\\resources\\kfc\\kungfu-wheel\\kungfu-x.x.x-cp39-cp39-win_amd64.whl

    2.运行 jupyter notebook，命令: python -m jupyter notebook


:: 
    
    # 调用方法
    
    ----------------------------------------

    # 1.获取官方示例（精选）因子列表

       fs.list_public_features()
    
    # 2.获取官方示例（精选）因子结果可调用范围

       fs.get_public_feature_date_range(key)
       key=因子key值

    # 3.获取官方示例（精选）因子指定日期结果
       
       fs.get_public_feature_data_by_date(key, date)
       key=因子key值，date=指定的日期

    # 4.获取官方示例（精选）因子全部结果

       fs.get_public_feature_data(key)
       key=因子key值

    ----------------------------------------

    # 5.获取自构造因子列表

       fs.list_features()

    # 6.获取自构造因子结果可调用范围

       fs.get_feature_date_range(key)
       key=因子key值

    # 7.获取自构造因子指定日期结果
       
       fs.get_feature_data_by_date(key, date)
       key=因子key值，date=指定的日期

    # 8.获取自构造因子全部结果

       fs.get_feature_data(key)
       key=因子key值


:ref:`获取详细教程点这里 <通过接口获取因子>` 


-----


.. _小程序获取因子结果:



小程序获取因子结果
+++++++++++++++++++++++++++++++

功夫支持通过小程序查看因子结果，无需手边有PC，即可查看因子数据。

 **扫码体验** 


.. image:: _images/小程序二维码.jpg
   :width: 120px
   :height: 120px

-----

代码小白快速上手编写代码
-------------------------------------------

小程序
---------------------

- **小程序可以做些什么？**

目前，小程序已支持“查看因子结果、AI查询个股信息（基于Level 2快照、逐笔数据）、查看个人消费”

 **扫码体验** 


.. image:: _images/小程序二维码.jpg
   :width: 120px
   :height: 120px

-----

名词解释
---------------------

    - TD : 交易账户。 “添加TD”即指“添加交易账户信息”
    - MD : 行情源账户。 “添加MD”即指“添加行情源信息(每个柜台仅允许一个行情源存在)”
    - strategy : 策略。 “添加strategy”即指“添加策略文件”
    - KF_home文件夹 : 功夫软件中添加的账户/行情/策略/定时任务/交易日志/数据等信息所在
    - KF_home文件路径 ：客户端左侧边栏-全局设置窗中允许修改储存路径； 功夫软件(windows版本)左上角 - 文件 - 打开功夫资源目录(KF_HOME)

-----


注意事项
-------------------


- 使用定时任务时，建议策略的启动时间设置为期望运行时刻前1-2分钟
    - 原因 : 策略的启动一般情况下需要1-2秒的准备时间；但当系统内交易数据随当天运行时间的增长而增多时，策略启动准备时间也会相应增长。一般情况下，10秒左右即可进入交易。因而，为了最大程度保护策略的正常运行,建议提前一分钟启动。


-----

界面布局
-------------

 - KungFu是一款支持跨柜台多账户交易的量化交易系统， **标准版** 系统目前支持的柜台有：XTP（股票），CTP（期货）。高配版支持交易接口定制，可适配全部主流柜台。

 - 为了方便用户进行多账户下单，Kungfu系统提供了账户模块，在账户模块中，用户可以对账户进行添加、编辑以及删除，也可以分别查看不同账户的实时运行状态、运行日志、持仓情况、委托情况、成交情况以及盈亏情况。

 - 在kungfu交易系统中，每个账户由一个行情进程（md）以及一个交易进程（td）组成，行情进程用来接收行情信息，交易进程用来下单、撤单。

.. image:: _images/界面布局-27.png


.. note:: Kungfu的功能模块体现为不同面板，界面灵活，可自由配置。

         交易前需要添加交易账户（TD）、行情源（MD）并启动进程。

         在此基础上，可搭配不同面板完成策略下单、算法下单、手动下单、预埋单等操作


添加面板/隐藏面板
+++++++++++++++++++++

 - 如果在界面上找不到想使用的面板，请手动添加。
  
 - 点击面板名称旁“+”按钮即可添加面板(如下图红框位置)；不常用的面板也可以通过点击面板旁的“×”隐藏面板

.. image:: _images/添加面板-27.png



修改布局
+++++++++++++++++++++

Kungfu支持自定义面板位置、区域高度及宽度。

- **调整面板所在的位置**：长按面板名并拖拽到对应位置松开鼠标，即可完成面板位置调整

.. image:: _images/面板移动-27.png


- **调整区域的高度及宽度**：鼠标移动到区域间空隙处，鼠标指针变为调整状态时，即可调整区域的高度、宽度

.. image:: _images/调整面板高度宽度-27.png



快速试用交易流程
---------------------------

已为您预置了对应账号、策略，无需配置即可体验交易流程。

按照行情源-》交易账户-》策略进程的顺序，依次启动进程，即可体验一键准备账户、策略下单。

.. image:: _images/预置demo引导-27.png