FAVE 项目安装与使用教程

1. 项目目录结构及介绍

FAVE 项目的目录结构如下：

FAVE/
├── docs/
│   └── ...
├── fave/
│   └── ...
├── tests/
│   └── fave/
│       └── ...
├── flake8/
│   └── ...
├── gitattributes
├── gitignore
├── pylintrc
├── CITATION.cff
├── CONTRIBUTORS.md
├── LICENSE
├── NEWS.md
├── README.md
├── README.rst
├── poetry.lock
├── pyproject.toml
└── ...

目录介绍：

• docs/: 包含项目的文档文件。
• fave/: 包含 FAVE 项目的主要代码。
• tests/: 包含项目的测试代码。
• flake8/: 包含 Flake8 配置文件。
• gitattributes: Git 属性配置文件。
• gitignore: Git 忽略文件配置。
• pylintrc: Pylint 配置文件。
• CITATION.cff: 项目引用信息。
• CONTRIBUTORS.md: 项目贡献者列表。
• LICENSE: 项目许可证文件。
• NEWS.md: 项目更新日志。
• README.md: 项目主 README 文件。
• README.rst: 项目主 README 文件的 RST 格式。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。

2. 项目启动文件介绍

FAVE 项目的主要启动文件是 fave/ 目录下的 Python 脚本。具体启动方式如下：

python3 -m pip install fave

安装完成后，可以通过以下命令启动 FAVE 的提取功能：

fave-extract AudioFileName.wav TextGridFileName.TextGrid OutputFileName

其中：

• AudioFileName.wav: 音频文件路径。
• TextGridFileName.TextGrid: 对齐后的 TextGrid 文件路径。
• OutputFileName: 输出测量结果的文件名。

3. 项目配置文件介绍

FAVE 项目的主要配置文件包括：

• pyproject.toml: 使用 Poetry 进行依赖管理和项目配置。
• pylintrc: Pylint 代码检查工具的配置文件。
• gitattributes: Git 属性配置文件，用于指定文件的属性。
• gitignore: Git 忽略文件配置，指定哪些文件不需要被 Git 跟踪。

这些配置文件帮助确保项目的依赖管理、代码质量和版本控制的一致性。

---

通过以上步骤，您可以成功安装并使用 FAVE 项目进行音频数据的对齐和测量。