AXOrderBook 项目使用教程

AXOrderBook 项目使用教程

【免费下载链接】AXOrderBook A股订单簿工具，使用逐笔行情进行订单簿重建、千档快照发布、各档委托队列展示等，包括python模型和FPGA HLS实现。 项目地址: https://gitcode.com/gh_mirrors/ax/AXOrderBook

1. 项目目录结构及介绍

AXOrderBook/
├── data/
├── doc/
├── hw/
├── py/
├── .gitignore
├── LICENSE
├── README.md

• data/: 存放项目所需的数据文件，例如从深交所截取的L2行情数据。
• doc/: 存放项目的文档文件，可能包括设计文档、用户手册等。
• hw/: 存放与硬件相关的代码和配置文件，特别是FPGA HLS实现的部分。
• py/: 存放Python模型和相关代码，用于订单簿重建算法的实现和验证。
• .gitignore: Git的忽略文件配置，指定哪些文件或目录不需要被Git管理。
• LICENSE: 项目的开源许可证文件，本项目使用MIT许可证。
• README.md: 项目的介绍文件，通常包含项目的基本信息、使用方法和贡献指南。

2. 项目的启动文件介绍

在 py/ 目录下，通常会有一个主要的启动文件，例如 main.py 或 run.py。这个文件负责初始化项目环境、加载配置、启动订单簿重建算法等核心功能。

# py/main.py

import config
from orderbook import OrderBook

def main():
    # 加载配置
    config.load()
    
    # 初始化订单簿
    order_book = OrderBook()
    
    # 启动订单簿重建算法
    order_book.start()

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

配置文件通常位于 py/ 目录下，例如 config.py 或 settings.py。这个文件包含了项目的各种配置参数，如数据源路径、硬件配置、算法参数等。

# py/config.py

import os

def load():
    global DATA_PATH, FPGA_CONFIG, ALGORITHM_PARAMS
    
    # 数据路径配置
    DATA_PATH = os.getenv('DATA_PATH', './data')
    
    # FPGA配置
    FPGA_CONFIG = {
        'device': 'Xilinx Alveo U50',
        'version': '2022.1'
    }
    
    # 算法参数
    ALGORITHM_PARAMS = {
        'precision': 4,
        'buffer_size': 1000
    }

通过以上配置文件，用户可以自定义数据路径、硬件设备和算法参数，以适应不同的使用场景和需求。

【免费下载链接】AXOrderBook A股订单簿工具，使用逐笔行情进行订单簿重建、千档快照发布、各档委托队列展示等，包括python模型和FPGA HLS实现。 项目地址: https://gitcode.com/gh_mirrors/ax/AXOrderBook