# 概览

**QFF**是基于Python语言开发的一个量化金融框架库，提供数据获取-数据存储-策略编写-策略分析-策略回测-模拟交易等一站式解决方案，用于为个人用户提供本地的回测和模拟交易环境，使用户更加专注于交易策略的编写。


:::{admonition} 提示
:class: tip
请访问 [Github](https://github.com/haijiangxu/qff) 网站获取QFF源代码，
如果有任何问题请访问 [Github Issues](https://github.com/haijiangxu/qff/issues) 查询或提交，
或加入QQ群 775477625 参与讨论。
:::



## 主要功能

**1. 提供免费的金融数据接口** 。提供国内股票、指数、基金等金融产品的基本面数据、实时和历史行情数据、技术指标等。所有数据均从互联网上抓取，并经过专业清洗保存在用户自己搭建的数据库服务器中。

**2. 提供灵活优雅的策略编写接口**。提供类似[聚宽](https://www.joinquant.com/)的策略程序框架，及灵活优雅的策略编写接口。策略文件中可以使用所有的Python标准库和用户自己常用的第三方库，用户可以很方便的实现自己的交易思路，编写自己的策略。

**3. 提供本地运行的回测和模拟交易环境**。支持本地编写和运行用户的策略文件，进行回测或模拟交易。通过选择回测日期区间，测试用户策略在历史数据下的收益情况，如果回测结果良好，可以进一步利用实时数据进行模拟交易，以验证策略的可用性，从而帮助用户做出理性的投资决策。

**4. 提供丰富的策略分析报告**。在对策略进行回测和模拟交易时，计算策略运行的各种风险指标和绩效指标，以帮助用户识别策略的优劣，并输出内容丰富的策略分析报告。另外，针对股票择时策略（附加的策略模板），可以单独输出策略分析报告。

**5. 提供实用的策略编写辅助功能**。为方便用户编写策略，QFF收集了常用的公共函数，包括技术指标计算，同花顺公式基础函数等等。另外，针对仓位管理、风险管理、止盈止损策略等，提供了一个交易系统框架，可提供给用户编写策略时使用，用户也可方便的扩展，构建自己的交易系统。


## 主要特点

```{eval-rst} 
                                   
================  ==========================================================
   **易于使用**         让您专注于策略的开发，一行简单的命令就可以执行您的策略 
   **接口丰富**         提供优雅的策略编写接口，方便用户快速入门实现自己的策略。
   **运行高效**         提供本地的运行环境，相较其他量化框架，提升策略运行效率。
   **数据免费**         提供丰富的数据接口，以获取免费的股票和市场数据。
   **策略安全**         用户策略在本地编辑、运行、评估，充分保障策略安全。
   **文档完善**         提供最佳的文档支持，每个接口均提供详细的说明和示例。
   **代码简单**         使用Python语言开发，避免使用复杂的数据结构，代码容易理解。
================  ==========================================================

```
### 与其他量化框架比较

| **框架**   | QFF | JoinQuant | rqalpha | QUANTAXIS | Backtrader |
| :------- | :-- | :-------- | :------ | :-------- | :--------- |
| **运行环境** | 本地  | 网络        | 本地      | 本地        | 本地         |
| **数据获取** | 免费  | 收费        | 收费      | 免费        | 无          |
| **学习难度** | 简单  | 未开源       | 复杂      | 中等        | 复杂         |
| **文档支持** | 完善  | 完善        | 完善      | 一般        | 完善         |

## 声明

*   QFF当前仅支持国内A股数据及交易，暂不支持其他金融产品如：期货、外汇、基金、债券、加密货币等。
*   QFF提供的所有数据仅用做学术研究，不得用于任何商业用途。
*   QFF提供的所有数据和运行结果仅作为参考意见，不构成任何投资建议。
*   任何基于QFF研究的投资者需关注数据风险。
*   QFF将持续提供开源的金融数据及研究框架。
*   基于某些无法控制的原因，QFF的某些数据接口未来可能会被移除。
*   请用户遵守QFF相关开源协议。


## 鸣谢

首先要特别感谢[QUANTAXIS](https://github.com/yutiansut/QUANTAXIS)在项目开发上对本人提供的借鉴和学习的机会。

特别感谢[JoinQuant](https://www.joinquant.com)提供的对于本项目框架和接口方面的学习和借鉴的机会。

特别感谢[AKShare](https://github.com/akfamily/akshare)和[rqalpha](https://github.com/ricequant/rqalpha)提供的对于本项目文档方面的学习和借鉴的机会。