SpatialMath Python 项目教程

1. 项目目录结构及介绍

spatialmath-python/
├── docs/
│   ├── gh-pages/
│   └── ...
├── notebooks/
│   └── ...
├── spatialmath/
│   └── ...
├── symbolic/
│   └── ...
├── tests/
│   └── ...
├── .gitattributes
├── .gitignore
├── pre-commit-config.yaml
├── LICENSE
├── Makefile
├── README.md
└── pyproject.toml

目录结构介绍

• docs/: 包含项目的文档文件，其中 gh-pages/ 目录用于存放 GitHub Pages 的静态文件。
• notebooks/: 包含 Jupyter Notebook 文件，用于交互式演示和教程。
• spatialmath/: 包含项目的主要代码文件，实现空间数学功能。
• symbolic/: 包含符号计算相关的代码文件。
• tests/: 包含项目的测试代码文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和自动化任务的 Makefile。
• README.md: 项目介绍和使用说明的 Markdown 文件。
• pyproject.toml: 项目配置文件，包含项目依赖和构建配置。

2. 项目启动文件介绍

项目没有明确的“启动文件”，因为 spatialmath-python 是一个库项目，而不是一个可执行的应用程序。用户通常会在自己的 Python 脚本或 Jupyter Notebook 中导入并使用该库。

例如，用户可以在自己的脚本中导入 spatialmath 模块：

from spatialmath import SE3, SO3

# 创建一个3D旋转矩阵
R = SO3.Rx(0.3)

# 创建一个3D位姿矩阵
T = SE3(1, 2, 3) * SE3.Rx(30, 'deg')

print(T)

3. 项目配置文件介绍

pyproject.toml

pyproject.toml 是项目的配置文件，用于定义项目的构建系统和依赖项。以下是一个示例内容：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "spatialmath-python"
version = "1.1.11"
description = "A Python implementation of the Spatial Math Toolbox for MATLAB."
authors = [
    { name="Peter Corke", email="[e-mail]" },
    { name="Jesse Haviland", email="[e-mail]" }
]
license = { file="LICENSE" }
readme = "README.md"
requires-python = ">=3.6"
dependencies = [
    "numpy",
    "scipy",
    "matplotlib",
    "ffmpeg"
]

[project.urls]
Homepage = "https://github.com/bdaiinstitute/spatialmath-python"
Documentation = "https://github.com/bdaiinstitute/spatialmath-python/docs"

配置文件介绍

• [build-system]: 定义了构建系统所需的工具和后端。
• [project]: 定义了项目的基本信息，如名称、版本、描述、作者、许可证、Python 版本要求和依赖项。
• [project.urls]: 定义了项目的相关链接，如主页和文档页面。

通过这些配置文件，用户可以了解项目的依赖关系和构建方式，从而更好地使用和开发该项目。