📑中文 | English
## 简介
`uav_3d_env` 是一个可定制的强化学习（RL）环境，用于仿真三维无人机（UAV）的导航与路径规划任务。该环境基于 Gymnasium 框架构建，提供灵活且可扩展的平台，用于开发和测试用于 UAV 路径规划、避障与复杂三维环境导航的强化学习算法。
环境模拟了一架无人机在存在静态与动态障碍物的三维空间中导航，目标是在避免碰撞与违反约束的情况下到达指定目标位置。
## 特性
- **可定制场景**：可生成包含不同障碍配置（如建筑物与动态障碍）的多样化场景。
- **灵活的观察和动作空间**：支持默认与自定义的观测、动作空间，包括基于网格、连续以及相对观测等形式。
- **可扩展的奖励函数**：可使用内置奖励函数或自定义奖励函数，以满足特定训练目标。
- **多种规划算法**：内置 A* 等路径规划算法用于生成参考路径。
- **数据收集与分析工具**：提供离线数据收集与智能体性能分析工具，包括轨迹分析与失败诊断。
- **可视化**：支持渲染仿真环境，并生成无人机轨迹与环境的可视化结果。
## 安装
```bash
pip install git+https://gitee.com/Morphlng/uav_3d_env.git
# 或，以可编辑模式安装
git clone https://gitee.com/Morphlng/uav_3d_env.git
cd uav_3d_env
pip install -e .
```
## 基本用法
```python
import gymnasium as gym
import uav_3d
env = gym.make("uav_3d-v1")
obs, info = env.reset()
done = False
while not done:
# 将此处替换为你的智能体动作选择逻辑
action = env.action_space.sample()
obs, reward, terminated, truncated, info = env.step(action)
done = terminated or truncated
# 生成该回合的 gif
env.render()
# 释放资源
env.close()
```
更多详细用法与调参示例，见[examples](./examples/)。
## 参与贡献
欢迎贡献！参与方式：
1. Fork 本仓库。
2. 为你的功能或修复创建新分支。
3. 使用清晰的信息提交提交记录（commit）。
4. 提交 Pull Request，并在描述中说明更改内容。
## 许可证
本项目采用 MIT 许可证 - 详见 [LICENSE](./LICENSE) 文件。