From a0cdac5c1e3b7b98c3f21289b8cdc025dae5c026 Mon Sep 17 00:00:00 2001 From: fasiondog Date: Wed, 7 Aug 2024 16:15:20 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B0=83=E6=95=B4readme=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.rst | 113 ---------------------------------------------- hikyuu/README.rst | 79 -------------------------------- readme.md | 67 +++++++++++++++++++++++++++ sub_setup.py | 5 +- 4 files changed, 70 insertions(+), 194 deletions(-) delete mode 100644 README.rst delete mode 100644 hikyuu/README.rst create mode 100644 readme.md diff --git a/README.rst b/README.rst deleted file mode 100644 index 648684d9..00000000 --- a/README.rst +++ /dev/null @@ -1,113 +0,0 @@ -.. image:: https://fasiondog.cn/wp-content/uploads/2024/05/00000_title-1.png - :target: https://gitee.com/fasiondog/hikyuu - :align: left - :alt: Hikyuu - ------------ - -.. image:: https://static.pepy.tech/badge/hikyuu - :target: https://pepy.tech/project/hikyuu - -.. image:: https://static.pepy.tech/badge/hikyuu/month - :target: https://pepy.tech/project/hikyuu - -.. image:: https://static.pepy.tech/badge/hikyuu/week - :target: https://pepy.tech/project/hikyuu - -.. image:: https://github.com/fasiondog/hikyuu/workflows/win-build/badge.svg - :target: https://github.com/fasiondog/hikyuu/actions - -.. image:: https://github.com/fasiondog/hikyuu/workflows/ubuntu-build/badge.svg - :target: https://github.com/fasiondog/hikyuu/actions - -.. image:: https://github.com/fasiondog/hikyuu/workflows/ubuntu-aarch64-build/badge.svg - :target: https://github.com/fasiondog/hikyuu/actions - -.. image:: https://img.shields.io/github/license/mashape/apistatus.svg - :target: https://github.com/fasiondog/hikyuu/blob/master/LICENSE.txt - :alt: GitHub - -Hikyuu Quant Framework是一款基于C++/Python的开源量化交易研究框架，用于策略分析及回测（目前主要用于国内A股市场）。其核心思想基于当前成熟的系统化交易方法，将整个系统化交易抽象为由市场环境判断策略、系统有效条件、信号指示器、止损/止盈策略、资金管理策略、盈利目标策略、移滑价差算法七大组件，你可以分别构建这些组件的策略资产库，在实际研究中对它们自由组合来观察系统的有效性、稳定性以及单一种类策略的效果。 - -详细文档： ``_ - - -感谢网友提供的 Hikyuu Ubuntu虚拟机环境, 百度网盘下载(提取码: ht8j): ``_ - - -示例： - -:: - - #创建模拟交易账户进行回测，初始资金30万 - my_tm = crtTM(init_cash = 300000) - - #创建信号指示器（以5日EMA为快线，5日EMA自身的10日EMA作为慢线，快线向上穿越慢线时买入，反之卖出） - my_sg = SG_Flex(EMA(CLOSE(), n=5), slow_n=10) - - #固定每次买入1000股 - my_mm = MM_FixedCount(1000) - - #创建交易系统并运行 - sys = SYS_Simple(tm = my_tm, sg = my_sg, mm = my_mm) - sys.run(sm['sz000001'], Query(-150)) - -.. figure:: https://fasiondog.cn/wp-content/uploads/2024/05/10000-overview.png - :width: 600px - -完整示例参见：``_ - - -为什么选择 Hikyuu？ --------------------- - -- **组合灵活，分类构建策略资产库** Hikyuu对系统化交易方法进行了良好的抽象，包含了九大策略组件：市场环境判断策略、系统有效条件、信号指示器、止损/止盈策略、资金管理策略、盈利目标策略、移滑价差算法、交易对象选择策略、资金分配策略。可以在此基础上构建自己的策略库，并进行灵活的组合和测试。在进行策略探索时，可以更加专注于某一方面的策略性能与影响。其主要功能模块如下： - - .. figure:: https://fasiondog.cn/wp-content/uploads/2024/05/10002-function-arc.png - :width: 600px - -- **性能保障，打造自己的专属应用** 目前项目包含了3个主要组成部分：基于C++的核心库、对C++进行包装的Python库(hikyuu)、基于Python的交互式工具。 - - - AMD 7950x 实测：A股全市场（1913万日K线）仅加载全部日线计算 20日 MA 并求最后 MA 累积和，首次执行含数据加载 耗时 6秒，数据加载完毕后计算耗时 166 毫秒，详见: `性能实测 `_ - - - C++核心库，提供了整体的策略框架，在保证性能的同时，已经考虑了对多线程和多核处理的支持，在未来追求更高运算速度提供便利。C++核心库，可以单独剥离使用，自行构建自己的客户端工具。 - - - Python库（hikyuu），提供了对C++库的包装，同时集成了talib库（如TA_SMA，对应talib.SMA），可以与numpy、pandas数据结构进行互相转换，为使用其他成熟的python数据分析工具提供了便利。 - - - hikyuu.interactive 交互式探索工具，提供了K线、指标、系统信号等的基本绘图功能，用于对量化策略的探索和回测。 - -- **代码简洁，探索更便捷、自由** 同时支持面向对象和命令行编程范式。其中，命令行在进行策略探索时，代码简洁、探索更便捷、自由。 - -- **安全、自由、隐私，搭建自己的专属云量化平台** 结合 Python + Jupyter 的强大能力与云服务器，可以搭建自己专属的云量化平台。将Jupyter部署在云服务器上，随时随地的访问自己的云平台，即刻实现自己新的想法，如下图所示通过手机访问自己的云平台。结合Python强大成熟的数据分析、人工智能工具（如 numpy、scipy、pandas、TensorFlow)搭建更强大的人工智能平台。 - -- **数据存储方式可扩展** 目前支持本地HDF5格式、MySQL存储。默认使用HDF5，数据文件体积小、速度更快、备份更便利。截止至2017年4月21日，沪市日线数据文件149M、深市日线数据文件184M、5分钟线数据各不到2G。 - -.. image:: https://api.star-history.com/svg?repos=fasiondog/hikyuu&type=Date - :target: https://star-history.com/#fasiondog/hikyuu&Date - :alt: Star History Chart - - -想要更多了解Hikyuu？请使用以下方式联系： --------------------------------------------------- - -**加入知识星球** 更多示例与策略部件的及时分享（您的加入将视为对项目的捐赠） - - .. figure:: https://fasiondog.cn/wp-content/uploads/2024/05/zhishixingqiu.png - - -**项目交流和问题答复将转移至知识星球-【Hikyuu量化】。** - -- 关注公众号： - - .. figure:: https://fasiondog.cn/wp-content/uploads/2024/05/weixin_gongzhonghao.jpg - - -- 加入微信群（请注明“加入hikyuu”）： - - .. figure:: https://fasiondog.cn/wp-content/uploads/2024/05/weixin_group.jpg - - -- QQ交流群（逐渐废弃）：114910869, 或扫码加入： - - .. figure:: https://fasiondog.cn/wp-content/uploads/2024/05/10003-qq.png - diff --git a/hikyuu/README.rst b/hikyuu/README.rst deleted file mode 100644 index 883fcfb0..00000000 --- a/hikyuu/README.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. image:: https://hikyuu.org/images/00000_title.png - :target: https://hikyuu.org - :align: center - :alt: Hikyuu - -.. image:: https://travis-ci.org/fasiondog/hikyuu.svg?branch=master - :target: https://travis-ci.org/fasiondog/hikyuu - -.. image:: https://img.shields.io/github/license/mashape/apistatus.svg - :target: https://github.com/fasiondog/hikyuu/blob/master/LICENSE.txt - :alt: GitHub - -.. image:: https://img.shields.io/badge/license-Anti%20996-blue.svg - :target: https://github.com/996icu/996.ICU/blob/master/LICENSE - :alt: GitHub - - ------------ - -Hikyuu Quant Framework是一款基于C++/Python的开源量化交易研究框架，用于策略分析及回测（仅受限于数据，如有数据也可用于期货等）。其核心思想基于当前成熟的系统化交易方法，将整个系统化交易抽象为由市场环境判断策略、系统有效条件、信号指示器、止损/止盈策略、资金管理策略、盈利目标策略、移滑价差算法七大组件，你可以分别构建这些组件的策略资产库，在实际研究中对它们自由组合来观察系统的有效性、稳定性以及单一种类策略的效果。 - - -祝贺 HIKYUU 入选 GITEE 最有价值开源项目 GVP ------------------------------------------------ - -.. image:: https://hikyuu.org/images/gitee_GVP.jpg - :target: https://gitee.com/gvp - :alt: Gitee - - -**给作者加点油，每天扫扫红包，或者请作者喝杯咖啡** - -.. image:: https://hikyuu.org/images/juanzeng.jpg - - -示例： - -:: - - #创建模拟交易账户进行回测，初始资金30万 - my_tm = crtTM(init_cash = 300000) - - #创建信号指示器（以5日EMA为快线，5日EMA自身的10日EMA作为慢线，快线向上穿越慢线时买入，反之卖出） - my_sg = SG_Flex(EMA(CLOSE(), n=5), slow_n=10) - - #固定每次买入1000股 - my_mm = MM_FixedCount(1000) - - #创建交易系统并运行 - sys = SYS_Simple(tm = my_tm, sg = my_sg, mm = my_mm) - sys.run(sm['sz000001'], Query(-150)) - -.. figure:: https://hikyuu.org/images/10000-overview.png - :width: 600px - -完整示例参见：``_ - - -为什么选择 Hikyuu？ --------------------- - -- **组合灵活，分类构建策略资产库** Hikyuu对系统化交易方法进行了良好的抽象，包含了九大策略组件：市场环境判断策略、系统有效条件、信号指示器、止损/止盈策略、资金管理策略、盈利目标策略、移滑价差算法、交易对象选择策略、资金分配策略。可以在此基础上构建自己的策略库，并进行灵活的组合和测试。在进行策略探索时，可以更加专注于某一方面的策略性能与影响。其主要功能模块如下： - - .. figure:: https://hikyuu.org/images/10002-function-arc.png - :width: 600px - -- **性能保障，打造自己的专属应用** 目前项目包含了3个主要组成部分：基于C++的核心库、对C++进行包装的Python库(hikyuu)、基于Python的交互式工具。 - - - C++核心库，提供了整体的策略框架，在保证性能的同时，已经考虑了对多线程和多核处理的支持，在未来追求更高运算速度提供便利。C++核心库，可以单独剥离使用，自行构建自己的客户端工具。 - - - Python库（hikyuu），提供了对C++库的包装，同时集成了talib库（如TA_SMA，对应talib.SMA），可以与numpy、pandas数据结构进行互相转换，为使用其他成熟的python数据分析工具提供了便利。 - - - hikyuu.interactive 交互式探索工具，提供了K线、指标、系统信号等的基本绘图功能，用于对量化策略的探索和回测。 - -- **代码简洁，探索更便捷、自由** 同时支持面向对象和命令行编程范式。其中，命令行在进行策略探索时，代码简洁、探索更便捷、自由。 - -- **安全、自由、隐私，搭建自己的专属云量化平台** 结合 Python + Jupyter 的强大能力与云服务器，可以搭建自己专属的云量化平台。将Jupyter部署在云服务器上，随时随地的访问自己的云平台，即刻实现自己新的想法，如下图所示通过手机访问自己的云平台。结合Python强大成熟的数据分析、人工智能工具（如 numpy、scipy、pandas、TensorFlow)搭建更强大的人工智能平台。 - -- **数据存储方式可扩展** 目前支持本地HDF5格式、MySQL存储。默认使用HDF5，数据文件体积小、速度更快、备份更便利。截止至2017年4月21日，沪市日线数据文件149M、深市日线数据文件184M、5分钟线数据各不到2G。 \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 00000000..34fa7b86 --- /dev/null +++ b/readme.md @@ -0,0 +1,67 @@ +![title](https://fasiondog.cn/wp-content/uploads/2024/05/00000_title-1.png) + +--- + +![img](https://static.pepy.tech/badge/hikyuu) ![img](https://static.pepy.tech/badge/hikyuu/month) ![img](https://static.pepy.tech/badge/hikyuu/week) ![img](https://github.com/fasiondog/hikyuu/workflows/win-build/badge.svg) ![img](https://github.com/fasiondog/hikyuu/workflows/ubuntu-build/badge.svg) ![img](https://img.shields.io/github/license/mashape/apistatus.svg) + +Hikyuu Quant Framework是一款基于C++/Python的开源量化交易研究框架，用于策略分析及回测（目前主要用于国内A股市场）。其核心思想基于当前成熟的系统化交易方法，将整个系统化交易抽象为由市场环境判断策略、系统有效条件、信号指示器、止损/止盈策略、资金管理策略、盈利目标策略、移滑价差算法七大组件，你可以分别构建这些组件的策略资产库，在实际研究中对它们自由组合来观察系统的有效性、稳定性以及单一种类策略的效果。 + +详细文档：[https://hikyuu.org/](https://hikyuu.org/) + +感谢网友提供的 Hikyuu Ubuntu虚拟机环境, 百度网盘下载(提取码: ht8j): [https://pan.baidu.com/s/1CAiUWDdgV0c0VhPpe4AgVw?pwd=ht8j](https://pan.baidu.com/s/1CAiUWDdgV0c0VhPpe4AgVw?pwd=ht8j) + +示例： + +```python + #创建模拟交易账户进行回测，初始资金30万 + my_tm = crtTM(init_cash = 300000) + + #创建信号指示器（以5日EMA为快线，5日EMA自身的10日EMA作为慢线，快线向上穿越慢线时买入，反之卖出） + my_sg = SG_Flex(EMA(CLOSE(), n=5), slow_n=10) + + #固定每次买入1000股 + my_mm = MM_FixedCount(1000) + + #创建交易系统并运行 + sys = SYS_Simple(tm = my_tm, sg = my_sg, mm = my_mm) + sys.run(sm['sz000001'], Query(-150)) +``` + +![img](https://fasiondog.cn/wp-content/uploads/2024/05/10000-overview.png) + +完整示例参见：[https://nbviewer.jupyter.org/github/fasiondog/hikyuu/blob/master/hikyuu/examples/notebook/000-Index.ipynb?flush_cache=True](https://nbviewer.jupyter.org/github/fasiondog/hikyuu/blob/master/hikyuu/examples/notebook/000-Index.ipynb?flush_cache=True) + +# 为什么选择 Hikyuu？ + +* **组合灵活，分类构建策略资产库** Hikyuu对系统化交易方法进行了良好的抽象，包含了九大策略组件：市场环境判断策略、系统有效条件、信号指示器、止损/止盈策略、资金管理策略、盈利目标策略、移滑价差算法、交易对象选择策略、资金分配策略。可以在此基础上构建自己的策略库，并进行灵活的组合和测试。在进行策略探索时，可以更加专注于某一方面的策略性能与影响。其主要功能模块如下：![img](https://fasiondog.cn/wp-content/uploads/2024/05/10002-function-arc.png) +* **性能保障，打造自己的专属应用** 目前项目包含了3个主要组成部分：基于C++的核心库、对C++进行包装的Python库(hikyuu)、基于Python的交互式工具。 + * AMD 7950x 实测：A股全市场（1913万日K线）仅加载全部日线计算 20日 MA 并求最后 MA 累积和，首次执行含数据加载 耗时 6秒，数据加载完毕后计算耗时 166 毫秒，详见: [性能实测](https://mp.weixin.qq.com/s?__biz=MzkwMzY1NzYxMA==&mid=2247483768&idx=1&sn=33e40aa9633857fa7b4c7ded51c95ae7&chksm=c093a09df7e4298b3f543121ba01334c0f8bf76e75c643afd6fc53aea1792ebb92de9a32c2be&mpshare=1&scene=23&srcid=05297ByHT6DEv6XAmyje1oOr&sharer_shareinfo=b38f5f91b4efd8fb60303a4ef4774748&sharer_shareinfo_first=b38f5f91b4efd8fb60303a4ef4774748#rd) + * C++核心库，提供了整体的策略框架，在保证性能的同时，已经考虑了对多线程和多核处理的支持，在未来追求更高运算速度提供便利。C++核心库，可以单独剥离使用，自行构建自己的客户端工具。 + * Python库（hikyuu），提供了对C++库的包装，同时集成了talib库（如TA_SMA，对应talib.SMA），可以与numpy、pandas数据结构进行互相转换，为使用其他成熟的python数据分析工具提供了便利。 + * hikyuu.interactive 交互式探索工具，提供了K线、指标、系统信号等的基本绘图功能，用于对量化策略的探索和回测。 +* **代码简洁，探索更便捷、自由** 同时支持面向对象和命令行编程范式。其中，命令行在进行策略探索时，代码简洁、探索更便捷、自由。 +* **安全、自由、隐私，搭建自己的专属云量化平台** 结合 Python + Jupyter 的强大能力与云服务器，可以搭建自己专属的云量化平台。将Jupyter部署在云服务器上，随时随地的访问自己的云平台，即刻实现自己新的想法，如下图所示通过手机访问自己的云平台。结合Python强大成熟的数据分析、人工智能工具（如 numpy、scipy、pandas、TensorFlow)搭建更强大的人工智能平台。 +* **数据存储方式可扩展** 目前支持本地HDF5格式、MySQL存储。默认使用HDF5，数据文件体积小、速度更快、备份更便利。截止至2017年4月21日，沪市日线数据文件149M、深市日线数据文件184M、5分钟线数据各不到2G。 + +![img](https://api.star-history.com/svg?repos=fasiondog/hikyuu&type=Date "Star History Chart") + +# 想要更多了解Hikyuu？请使用以下方式联系： + +## **加入知识星球** + +更多示例与策略部件的及时分享（您的加入将视为对项目的捐赠）。**项目交流和问题答复将转移至知识星球-【Hikyuu量化】。** + +![img](https://fasiondog.cn/wp-content/uploads/2024/05/zhishixingqiu.png) + + +## 关注公众号： + +![img](https://fasiondog.cn/wp-content/uploads/2024/05/weixin_gongzhonghao.jpg) + +## 加入微信群（请注明“加入hikyuu”）： + +![img](https://fasiondog.cn/wp-content/uploads/2024/05/weixin_group.jpg) + +## QQ交流群（逐渐废弃）：114910869, 或扫码加入 + +![img](https://fasiondog.cn/wp-content/uploads/2024/05/10003-qq.png) diff --git a/sub_setup.py b/sub_setup.py index 0ebd059b..9b6866f8 100644 --- a/sub_setup.py +++ b/sub_setup.py @@ -48,7 +48,7 @@ hku_platforms = "Independant" hku_url = "http://hikyuu.org/" hku_description = "Hikyuu Quant Framework for System Trading Analysis and backtester" -with open("./hikyuu/README.rst", encoding='utf-8') as f: +with open("./readme.md", encoding='utf-8') as f: hku_long_description = f.read() hku_data_files = [] @@ -99,7 +99,8 @@ setup( name=hku_name, version=hku_version, description=hku_description, - long_description_content_type="text/x-rst", + # long_description_content_type="text/x-rst", + long_description_content_type='text/markdown', long_description=hku_long_description, author=hku_author, author_email=hku_author_email,