# manano

**Repository Path**: june-duck/manano

## Basic Information

- **Project Name**: manano
- **Description**: MDTX online algorithm python binding
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 14
- **Forks**: 1
- **Created**: 2021-08-04
- **Last Updated**: 2021-09-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# manano

#### 介绍

manano是mdtx-online的python绑定。提供了常用的指标在线/增量/批量计算功能。

#### 安装教程


1.  使用setup.py编译：
    - ``` git clone --recursive https://gitee.com/june-duck/manano ```
    - ``` pip install ./manano ```

2.  Windows用户可直接安装预编译的wheel文件

#### 使用说明

```Python
import manano as mn
import numpy as np
# 批量计算，使用run_np插入多个数据点
macd = mn.macd.ema(25)
m, sig, hist = macd.run_np(np.random.random(100))
# 单点增量计算，使用run插入单个数据点
for x in np.random.random(20)
    m, sig, hist = macd.run(x)
```

manano中新建的对象都是富状态的，若需要重新计算，请新建对象

```Python
import manano as mn
import numpy as np

ma = mn.ma.sma(3)
print(ma.run_np(np.array([1, 2, 3]))) # -> array([1. , 1.33333333, 2.])
print(ma.run(5)) # -> 3.33333 内部状态随新数据点插入更新
print(ma.run(5)) # -> 4.33333

ma = mn.ma.sma(3) #重新计算
print(ma.run(5)) # -> 5.0
```

manano将绑定的算法划分为若干个子模块，分别是：
- macd： macd相关
- ma：移动平均相关
- maosc：移动平均osc相关
- rsi：移动平均rsi相关
- indi：其它指标
- order：顺序相关
- band：布林带和拓展相关
- cov：线性相关
- var：方差相关
- zscore：标准分相关
- kurtosis：峰度相关
- skewness：偏度相关
- s4：四阶中心矩
- scale：样本偏差相关

每个指标类都提供一个run()函数，接受一个数据点，并返回一个计算结果。同时提供一个run_np()函数，接受一个numpy.array，一次返回多个数据点。
具体指标的使用和参数说明请参考文档。

#### 参与贡献

1.  Fork 本仓库
2.  新建分支
3.  提交代码
4.  新建 Pull Request