pyHRV 项目使用教程

1. 项目的目录结构及介绍

pyHRV 是一个用于计算心率变异性（HRV）参数的开源 Python 工具箱。以下是项目的目录结构及其介绍：

pyhrv/
├── docs/
│   ├── _build/
│   ├── _static/
│   ├── _templates/
│   ├── conf.py
│   ├── index.rst
│   ├── make.bat
│   ├── Makefile
│   └── ...
├── pyhrv/
│   ├── __init__.py
│   ├── tools/
│   │   ├── __init__.py
│   │   ├── biosppy.py
│   │   ├── matplotlib.py
│   │   ├── numpy.py
│   │   ├── scipy.py
│   │   ├── nolds.py
│   │   └── spectrum.py
│   ├── time_domain.py
│   ├── frequency_domain.py
│   ├── nonlinear.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_time_domain.py
│   ├── test_frequency_domain.py
│   ├── test_nonlinear.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• docs/：包含项目的文档文件，使用 Sphinx 生成文档。
• pyhrv/：包含项目的主要代码文件，包括各个模块的实现。
• tests/：包含项目的测试文件，用于测试各个模块的功能。
• .gitignore：Git 忽略文件列表。
• LICENSE：项目的许可证文件。
• README.md：项目的介绍文件。
• requirements.txt：项目的依赖文件。
• setup.py：项目的安装文件。

2. 项目的启动文件介绍

pyHRV 项目的启动文件是 pyhrv/__init__.py。这个文件是项目的入口点，负责初始化项目并导入各个模块。

# pyhrv/__init__.py

from .tools import *
from .time_domain import *
from .frequency_domain import *
from .nonlinear import *

__version__ = '0.4.1'

启动文件介绍

• from .tools import *：导入工具模块中的所有功能。
• from .time_domain import *：导入时间域分析模块中的所有功能。
• from .frequency_domain import *：导入频域分析模块中的所有功能。
• from .nonlinear import *：导入非线性分析模块中的所有功能。
• __version__ = '0.4.1'：定义项目的版本号。

3. 项目的配置文件介绍

pyHRV 项目的配置文件主要有两个：setup.py 和 requirements.txt。

setup.py

setup.py 文件用于项目的安装和分发。它包含了项目的基本信息和依赖项。

# setup.py

from setuptools import setup, find_packages

setup(
    name='pyhrv',
    version='0.4.1',
    description='Python toolbox for Heart Rate Variability',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Pedro Gomes',
    author_email='[e-mail]',
    url='https://github.com/PGomes92/pyhrv',
    packages=find_packages(),
    install_requires=[
        'biosppy',
        'numpy',
        'scipy',
        'matplotlib',
        'nolds',
        'spectrum'
    ],
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'Intended Audience :: Education',
        'Intended Audience :: Science/Research',
        'License :: OSI Approved :: BSD License',
        'Operating System :: OS Independent',
        'Programming Language :: Python',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',