FreeMoCap 项目使用教程

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

FreeMoCap 项目的目录结构如下：

freemocap/
├── freemocap-ui/
├── ipython_jupyter_notebooks/
├── flake8/
├── gitignore
├── pre-commit-config.yaml
├── CITATION.cff
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── noxfile.py
├── poetry_pyproject.toml
├── pyproject.toml
└── setup.py

目录介绍

• freemocap-ui/: 包含项目的用户界面相关文件。
• ipython_jupyter_notebooks/: 包含 Jupyter Notebook 文件，用于数据分析和演示。
• flake8/: 包含 Flake8 配置文件，用于代码风格检查。
• gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• CITATION.cff: 项目引用文件。
• CODEOWNERS: 代码所有者配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包清单文件。
• README.md: 项目说明文件。
• noxfile.py: Nox 自动化测试配置文件。
• poetry_pyproject.toml: Poetry 依赖管理配置文件。
• pyproject.toml: 项目配置文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

FreeMoCap 项目的启动文件是 freemocap/__main__.py。该文件是项目的入口点，负责启动 GUI 界面。

启动步骤

1. 激活 Python 环境：

   conda activate freemocap-env
   

2. 启动 GUI：

   python -m freemocap
   

3. 项目的配置文件介绍

FreeMoCap 项目的主要配置文件是 pyproject.toml。该文件使用 Poetry 进行依赖管理和项目配置。

pyproject.toml 文件内容示例

[tool.poetry]
name = "freemocap"
version = "0.1.0"
description = "Free Motion Capture for Everyone"
authors = ["Jon Matthis <[e-mail]>"]
license = "AGPL-3.0"

[tool.poetry.dependencies]
python = "^3.9"
numpy = "^1.21.0"
opencv-python = "^4.5.3.56"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"
flake8 = "^3.9.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

配置文件介绍

• [tool.poetry]: 项目基本信息，包括名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 项目依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 开发环境依赖包及其版本要求。
• [build-system]: 构建系统要求。

通过以上配置文件，可以方便地管理项目的依赖和构建过程。