Build Status
Coverage

Alpha - Mind 是基于 Python 开发的股票多因子研究框架。

alpha - mind 提供了多因子研究中常用的工具链，包括：

• 数据清洗
• alpha 模型
• 风险模型
• 组合优化
• 执行器

所有的模块都设计了完整的测试用例以尽可能保证正确性。同时，所有的数值模型开发中都对性能给予了足够高的关注，参考了优秀的第三方工具以保证性能：

• numpy
• numba
• cvxopt
• cvxpy
• pandas
• scipy

alpha - mind 的安装极其简单，只需要在下载源码之后，运行：

python setup.py install

• 注意事项: 在Linux系统上,请确保gcc版本大于5

为了尽可能的保证多因子研究工具的适用性，几乎所有的函数功能都不依赖一个具体的外部数据源。但是为了整个体系的完整性，我们在工具包中也提供了一个数据源的参考实现。这个数据源的参考实现来自于通联数据提供的股票因子数据和风险模型数据等，具体细节可以参考：优矿。

该数据源使用RMDBS，供参考的数据库可以是，例如：Postgresql或者MySQL。在工具包中我们已经提供了命令行工具，帮助用户一键配置好数据库。步骤如下：

下面的步骤以Ubuntun上Postgresql为例子，Windows服务器以及SQL server等其他RMDBS的配置类似。

• 安装数据库软件

 请前往PostgreSQL官网，根据指导，下载安装PostgreSQL数据库。

• 新建数据库

  在安装完成的数据库中新建Database，例如名字：alpha。注意这个数据需要使用utf8作为编码。

• 一键配置数据库

  在命令行中运行：

  alphadmind initdb --url postgresql+psycopg2://user:pwd@host/alpha

  其中：

  • user：数据库用户名
  • pwd：用户密码
  • host：数据库服务器地址

  如果成功，会有类似的输出：

  2017-06-29 14:48:36,678 - ALPHA_MIND - INFO - DB: postgresql+psycopg2://user:pwd@host/alpha
  2017-06-29 14:48:37,515 - ALPHA_MIND - INFO - DB: initialization finished.
  

• Windows

  对于Windows使用者，命令行工具alphamind并不能直接使用，这个时候可以使用变通的办法，进入源码alphamind/bin目录下：

  python alphadmind initdb --url postgresql+psycopg2://user:pwd@host/alpha

  可以达到一样的效果。

• 数据库更新

  在目录scripts 下有airflow脚本文件update_uqer_data.py可以用来做每天的数据更新。使用之前除了要配置好airflow服务器之外，需要更新脚本中以下两行：

  _ = uqer.Client(token='')
  engine = sqlalchemy.create_engine('')
  

  其中token需要填入有效的通联数据认证信息；engine需要填入上面指定的数据库地址。