gym-pybullet-drones 项目使用教程

1. 项目目录结构及介绍

gym-pybullet-drones/
├── gym_pybullet_drones/
│   ├── assets/
│   ├── examples/
│   ├── utils/
│   ├── __init__.py
│   ├── BaseAviary.py
│   ├── DroneModel.py
│   ├── ...
├── tests/
├── .gitignore
├── CITATION.cff
├── LICENSE
├── README.md
├── build_project.sh
├── pypi_description.md
├── pyproject.toml

目录结构介绍

• gym_pybullet_drones/: 核心代码目录，包含无人机模拟环境的主要实现。

  • assets/: 存放项目所需的资源文件，如无人机模型、配置文件等。
  • examples/: 包含项目的示例代码，如PID控制、强化学习等。
  • utils/: 存放项目中使用的工具函数和辅助类。
  • init.py: 模块初始化文件。
  • BaseAviary.py: 无人机模拟环境的基础类。
  • DroneModel.py: 无人机的模型定义。
  • ...: 其他相关文件和模块。

• tests/: 存放项目的测试代码。

• .gitignore: Git忽略文件配置。

• CITATION.cff: 项目引用信息。

• LICENSE: 项目许可证文件。

• README.md: 项目说明文档。

• build_project.sh: 项目构建脚本。

• pypi_description.md: PyPI项目描述文件。

• pyproject.toml: 项目配置文件。

2. 项目启动文件介绍

启动文件

• examples/pid.py: 使用PID控制无人机的示例代码。
• examples/pid_velocity.py: 使用PID控制无人机速度的示例代码。
• examples/downwash.py: 模拟无人机下洗效应的示例代码。
• examples/learn.py: 使用强化学习（如PPO）训练无人机的示例代码。

启动方法

1. 进入项目目录：

   cd gym-pybullet-drones/
   

2. 激活虚拟环境（如果已创建）：

   conda activate drones
   

3. 运行示例代码：

   python3 gym_pybullet_drones/examples/pid.py
   

3. 项目的配置文件介绍

配置文件

• pyproject.toml: 项目的主要配置文件，定义了项目的依赖、构建工具等信息。
• README.md: 项目说明文档，包含项目的安装、使用方法等。
• LICENSE: 项目许可证文件，定义了项目的开源许可证类型。

配置文件内容

pyproject.toml

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

[project]
name = "gym-pybullet-drones"
version = "1.0.0"
description = "PyBullet Gymnasium environments for single and multi-agent reinforcement learning of quadcopter control"
authors = [
    { name="Jacopo Panerati", email="[e-mail]" },
    { name="Hehui Zheng", email="[e-mail]" },
    { name="SiQi Zhou", email="[e-mail]" },
    { name="James Xu", email="[e-mail]" },
    { name="Amanda Prorok", email="[e-mail]" },
    { name="Angela P. Schoellig", email="[e-mail]" }
]
dependencies = [
    "numpy",
    "matplotlib",
    "Pillow",
    "cycler",
    "gym",
    "pybullet",
    "stable-baselines3",
    "ray[rllib]"
]

README.md

README.md文件包含了项目的详细说明，包括项目的安装方法、使用示例、依赖项、许可证信息等。用户可以通过阅读该文件快速了解项目的基本信息和使用方法。

LICENSE

LICENSE文件定义了项目的开源许可证类型，通常为MIT许可证。该文件确保了项目的开源性质，并明确了用户在使用、修改和分发项目时的权利和义务。

---

通过以上内容，您可以快速了解并开始使用gym-pybullet-drones项目。