pysabr 项目教程

1. 项目目录结构及介绍

pysabr/
├── LICENSE
├── README.md
├── notebooks/
│   └── Lognormal SABR vs Normal SABR.ipynb
├── pysabr/
│   ├── __init__.py
│   └── ...
├── tests/
│   └── ...
├── web/
│   └── app.py
├── .gitignore
├── pytest.ini
├── requirements.txt
└── setup.py

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。
• notebooks/: 包含 Jupyter Notebook 文件，用于演示和测试 SABR 模型的不同实现。
• pysabr/: 项目的主要代码库，包含 SABR 模型的实现。
• tests/: 包含项目的测试代码。
• web/: 包含用于启动 Web 微服务的文件。
• .gitignore: Git 忽略文件列表。
• pytest.ini: pytest 配置文件。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 用于安装项目的脚本。

2. 项目启动文件介绍

web/app.py

web/app.py 是项目的启动文件，用于启动 Web 微服务。该文件基于 Falcon 框架，提供了两个主要功能：

1. 波动率插值: 通过 REST API 提供 SABR 模型的波动率插值功能。
2. alpha 校准: 通过 REST API 提供 SABR 模型的 alpha 参数校准功能。

启动命令

• Linux:

  gunicorn -b '0.0.0.0:5000' web.app:app &>> pysabr_web.log &
  

• Windows:

  python -m waitress --port=5000 web.app:app
  

3. 项目的配置文件介绍

pytest.ini

pytest.ini 是 pytest 的配置文件，用于配置测试框架的行为。该文件通常包含以下内容：

[pytest]
addopts = -v
testpaths = tests

requirements.txt

requirements.txt 列出了项目依赖的 Python 包，用于确保项目在不同环境中的一致性。常见的依赖包包括 numpy、scipy、falcon 等。

setup.py

setup.py 是用于安装项目的脚本。通过运行 python setup.py install，可以安装项目及其依赖包。

from setuptools import setup, find_packages

setup(
    name='pysabr',
    version='0.4.1',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'scipy',
        'falcon',
        'waitress',
        'gunicorn',
    ],
)

通过以上配置文件和启动文件，可以方便地安装、配置和启动 pysabr 项目。