Unverified Commit f7783f49 authored by Dr.李's avatar Dr.李 Committed by GitHub

Merge pull request #5 from iLampard/master

Add more details in ReadMe
parents a6f2d473 b7236f71
# Alpha - Mind # Alpha - Mind
<table> <table>
<tr>
<td>Python version</td>
<td><img src="https://img.shields.io/badge/python-3.6-blue.svg"/> </td>
</tr>
<tr>
<tr> <tr>
<td>Build Status</td> <td>Build Status</td>
<td> <td>
   <a href="https://travis-ci.org/alpha-miner/alpha-mind">
<img src="https://travis-ci.org/alpha-miner/alpha-mind.svg?branch=master" alt="travis build status" /> <img src="https://travis-ci.org/alpha-miner/alpha-mind.svg?branch=master" alt="travis build status" />
</a>
</td> </td>
</tr> </tr>
<tr> <tr>
...@@ -46,24 +49,37 @@ alpha - mind 提供了多因子研究中常用的工具链,包括: ...@@ -46,24 +49,37 @@ alpha - mind 提供了多因子研究中常用的工具链,包括:
* pandas * pandas
* scipy * scipy
## 获取代码 同时还依赖于一个工具包
* [Finance-Python](https://github.com/alpha-miner/Finance-Python)
```
git clone https://github.com/alpha-miner/alpha-mind.git
cd alpha-mind
git submodule init
git submodule update
```
## 编译依赖 ## 编译依赖
* Windows * Windows
在Windows上完整安装,需要有C++编译器(例如msvc): 在Windows上完整安装,需要有C++编译器(例如msvc)
```bash 具体可按照如下流程配置(以VS2005为例):
build_windows_dependencies.bat
``` 1. 安装VS2015 社区版,在微软官网可以免费下载。
2. 安装CMake, 可以从[官网](https://cmake.org/download/)下载二进制安装文件,如"Windows win64-x64 ZIP",解压缩后环境变量的设置可以参见[此文](https://blog.csdn.net/liyuebit/article/details/77092723)
- 可以按照文中的例子,尝试使用如下CMake命令编译一个HelloWorld项目。
```bash
cmake -G "Visual Studio 14 2015 Win646"
```
- 将MSBuild的路径(默认是"C:\Program Files (x86)\MSBuild\14.0\Bin"")加入环境变量中。
3. 在项目子目录"\alphamind\pfopt"下使用如下命令进行更新,确保所需文件都已经拷贝到本地。
```
git submodule init
git submodule update
```
4. 在项目根目录下双击批处理文件"build_windows_dependencies.bat"或者通过命令行执行
```bash
build_windows_dependencies.bat
```
随后一系列依赖项目会自动编译。可能有若干警告,但没有错误。
* Linux * Linux
...@@ -75,7 +91,21 @@ git submodule update ...@@ -75,7 +91,21 @@ git submodule update
## 安装 ## 安装
alpha - mind 的安装极其简单,在编译完成依赖之后,运行: 安装需要直接clone或者下载源代码安装,具体流程为:
1. 克隆项目到本地
```
git clone https://github.com/alpha-miner/alpha-mind.git
cd alpha-mind
git submodule init
git submodule update
```
2. 参照上节内容,编译好依赖的子项目。
3. 确保环境变量'VS90COMNTOOLS'的值为安装的VS的Comntools下的地址,如'\vs2015\Common7\Tools\'
4. 回到项目的根目录下运行:
```python ```python
python setup.py install python setup.py install
......
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment