Skip to content

Commit

Permalink
Update install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Charmve committed Nov 9, 2024
1 parent 54b3be1 commit aa049ed
Show file tree
Hide file tree
Showing 12 changed files with 503 additions and 163 deletions.
3 changes: 3 additions & 0 deletions COMMUNITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 每一个交易员都应该搭建自己的量化交易系统

<a href="https://trendshift.io/repositories/2841" target="_blank"><img src="https://trendshift.io/api/badge/repositories/2841" alt="codecrafters-io%2Fbuild-your-own-x | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 UFund
Copyright (c) 2022 UFund-Me

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
29 changes: 9 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,36 +81,24 @@
Qbot是一个免费的量化投研平台,提供从数据获取、交易策略开发、策略回测、模拟交易到最终实盘交易的全闭环流程。在实盘接入前,有股票、基金评测和策略回测,在模拟环境下做交易验证,近乎实盘的时延、滑点仿真。故,本平台提供GUI前端/客户端(部分功能也支持网页),后端做数据处理、交易调度,实现事件驱动的交易流程。对于策略研究部分,尤其强调机器学习、强化学习的AI策略,结合多因子模型提高收益比。

但本项目可能需要一点点python基础知识,有一点点交易经验,会更容易体会作者的初衷,解决当下产品空缺和广大散户朋友的交易痛点,现在直接免费开源出来!
但本项目可能需要一点点python基础知识,有一点点交易经验,会更容易体会作者的初衷,解决当下产品空缺和广大散户朋友的交易痛点,现在直接免费开源出来!

<b>Qbot 目前仅在 python3.8 pyhont3.9 下测试过,其他版本未测试。</b>

<<< 详细文档 [docs/Install_guide.md](docs/Install_guide.md)

```bash
cd ~ # $HOME as workspace
git clone https://github.com/UFund-Me/Qbot --depth 1

cd Qbot
pip install -r requirements.txt

pip install -r dev/requirements.txt

export PYTHONPATH=${PYTHONPATH}:$(pwd):$(pwd)/backend/multi-fact/mfm_learner
python main.py #if run on Mac, please use 'pythonw main.py'

```

详细文档 https://github.com/UFund-Me/Qbot/blob/main/quick_start.md

> [!NOTE]
> - wxPython、Ta-Lib 需要手动安装,pip wheel 在 dev/ 路径下。https://github.com/UFund-Me/Qbot/issues/76
> - <details><summary>Mac系统在安装之前需要手动安装tables库的依赖hdf5,以及pythonw https://github.com/UFund-Me/Qbot/issues/11 </summary>
> <code>
> brew install hdf5
> brew install c-blosc
> export HDF5_DIR=/opt/homebrew/opt/hdf5
> export BLOSC_DIR=/opt/homebrew/opt/c-blosc
> </code>
> </details>
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/UFund-Me/Qbot)

<!-- ![Gitpod-Ready](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod) -->

## Highlights

<table class="table table-striped table-bordered table-vcenter">
Expand Down Expand Up @@ -560,7 +548,8 @@ Qbot买卖强弱指标(收费)

[证券平台账号开通](qbot/engine/trade/engine_apis/venv/README.md)

低费率开户:股票万0.854免五, ETF万0.4, 可转债万0.4 没有资金门槛。关注公众可开户
低费率开户:股票万0.854免五, ETF万0.4, 可转债万0.4 没有资金门槛。关注公众号可开户

另外提供开通券商量化交易接口,支持python编写实盘交易

支持股票券商
Expand Down
87 changes: 0 additions & 87 deletions docs/01-新手指引/Install_guide.md

This file was deleted.

121 changes: 68 additions & 53 deletions docs/04-常见问题/FQA.md → docs/FQA.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,68 @@
# Qbot 常见使用问题汇总用于反馈

本页面增加使用问题汇总,如果没有出现在这个页面的可以提issues或下方留言,会及时反馈处理。

> 备注:多数属于环境问题,可以通过提供的``docker````conda``解决,点击[这里](01-新手指引/Install_guide.md)参考环境安装指南.
## ❓ 常见问题

- **在线教程页面无法打开**

测试中存在部分人打不开在线教程的情况。

部分小伙伴反馈尝试切换浏览器后可以正常打开了,如果仍然不行,最有效的解决办法是科学上网。

- **无法加载图片的解决办法**

根本解决办法还是科学上网,也可以尝试修改host文件看下是否能解决。

解决方案: 修改host文件 <code><a href="https://www.jianshu.com/p/25e5e07b2464"><img height="20" src="https://user-images.githubusercontent.com/29084184/126457822-d431fb90-6b9e-4a4e-bedc-3c598e9e2ee2.png" alt="Apple" title="Apple"></code> Mac</a> <code><a href="https://blog.csdn.net/u011583927/article/details/104384169"><img height="20" src="https://user-images.githubusercontent.com/29084184/126457902-0c1a71c2-f920-45a1-a143-ce8b5c435fe7.png" alt="Win10" title="Win10"></code> Windows</a>

- **公式无法正常显示解决办法**

GitHub中的Markdown原生是不支持LATEX公式显示的,如果你喜欢在本项目中直接浏览教程,可以安装Chrome的`MathJax Plugin for Github`插件让大部分公式正常显示。而docs文件夹已经利用docsify被部署到了GitHub Pages上,包含公式的章节强力建议使用 [《Qbot使用手册》 在线阅读](https://ufund-me.github.io/Qbot) 进行学习。

当然如果你还想跑一下运行相关代码的话还是得把本项目clone下来,然后运行code文件夹下相关代码。

- **Jupyter Notebook 无法在 GitHub 上呈现?** [使用 nbviewer](https://leaherb.com/notebook_wont_render_use_nbviewer/)。 <a href="https://mybinder.org/v2/gh/UFund-Me/QBot/main/pytrader/strategies/notebook"><img src="https://mybinder.org/badge_logo.svg" alt="Binder"></a>

<br>

<div>
<a href="https://github.com/sponsors/Charmve">
<kbd align="center" valign="center">
<code> <img src="https://user-images.githubusercontent.com/29084184/218292687-bdde091a-40d5-4f2f-863b-d7f7d92440bd.png" alt="Sponsors" title="Sponsor me" width="32" valign="center" style="max-width: 100%; vertical-align: bottom;"> Sponsor me </code> <img src="https://user-images.githubusercontent.com/29084184/218292609-674b24b7-fa1f-4bf3-9cc1-9c51a23e435d.png" align="center" valign="center" alt="Sponsors" title="Sponsor me" width="64" style="max-width: 100%; vertical-align: bottom;">
</kbd>
</a>
</div>

<br>

----
- Q1:

A1:

----

- Q2:

A2:

----

# Qbot 常见使用问题汇总用于反馈

本页面增加使用问题汇总,如果没有出现在这个页面的可以提issues或下方留言,会及时反馈处理。

> 备注:多数属于环境问题,可以通过提供的``docker````conda``解决,点击[这里](Install_guide.md)参考环境安装指南.
## ❓ 常见问题

- **在线教程页面无法打开**

测试中存在部分人打不开在线教程的情况。

部分小伙伴反馈尝试切换浏览器后可以正常打开了,如果仍然不行,最有效的解决办法是科学上网。

- **无法加载图片的解决办法**

根本解决办法还是科学上网,也可以尝试修改host文件看下是否能解决。

解决方案: 修改host文件 <code><a href="https://www.jianshu.com/p/25e5e07b2464"><img height="20" src="https://user-images.githubusercontent.com/29084184/126457822-d431fb90-6b9e-4a4e-bedc-3c598e9e2ee2.png" alt="Apple" title="Apple"></code> Mac</a> <code><a href="https://blog.csdn.net/u011583927/article/details/104384169"><img height="20" src="https://user-images.githubusercontent.com/29084184/126457902-0c1a71c2-f920-45a1-a143-ce8b5c435fe7.png" alt="Win10" title="Win10"></code> Windows</a>

- **公式无法正常显示解决办法**

GitHub中的Markdown原生是不支持LATEX公式显示的,如果你喜欢在本项目中直接浏览教程,可以安装Chrome的`MathJax Plugin for Github`插件让大部分公式正常显示。而docs文件夹已经利用docsify被部署到了GitHub Pages上,包含公式的章节强力建议使用 [《Qbot使用手册》 在线阅读](https://ufund-me.github.io/Qbot) 进行学习。

当然如果你还想跑一下运行相关代码的话还是得把本项目clone下来,然后运行code文件夹下相关代码。

- **Jupyter Notebook 无法在 GitHub 上呈现?** [使用 nbviewer](https://leaherb.com/notebook_wont_render_use_nbviewer/)。 <a href="https://mybinder.org/v2/gh/UFund-Me/QBot/main/pytrader/strategies/notebook"><img src="https://mybinder.org/badge_logo.svg" alt="Binder"></a>

<br>

<div>
<a href="https://github.com/sponsors/Charmve">
<kbd align="center" valign="center">
<code> <img src="https://user-images.githubusercontent.com/29084184/218292687-bdde091a-40d5-4f2f-863b-d7f7d92440bd.png" alt="Sponsors" title="Sponsor me" width="32" valign="center" style="max-width: 100%; vertical-align: bottom;"> Sponsor me </code> <img src="https://user-images.githubusercontent.com/29084184/218292609-674b24b7-fa1f-4bf3-9cc1-9c51a23e435d.png" align="center" valign="center" alt="Sponsors" title="Sponsor me" width="64" style="max-width: 100%; vertical-align: bottom;">
</kbd>
</a>
</div>

<br>

----
- Q1: No module named : ‘Crypto’

A1:
pip uninstall crypto
pip uninstall pycryptodome
pip install pycryptodome

----

- Q2: matplotlib.font_manager - WARNING - findfont: Generic family 'sans-serif' not found because none of the following families were found: SimHei

A2: https://blog.csdn.net/weixin_47723732/article/details/134662968
https://blog.csdn.net/weixin_54780036/article/details/138709739

----

- Q3: AttributeError: unexpected attribute 'plot_width' to figure, similar attributes are outer_width, width or min_width

A2: pip install bokeh==2.3.3

----

- Q4: Multi-dimensional indexing (e.g. `obj[:, None]`) is no longer supported. Convert to a numpy array before indexing instead.

A2: pip install --upgrade pandas

----
Loading

0 comments on commit aa049ed

Please sign in to comment.