Skip to content
152 changes: 152 additions & 0 deletions docs/dua_arm/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@

# box — 仿真与强化学习实验箱

## 概述

`src/box` 包含若干用于仿真、感知与强化学习实验的环境与辅助脚本。主要面向基于 Gymnasium/MuJoCo 的任务、轻量级可视化示例以及调试/测试工具。

Gymnasium:一个操作台,是网上的一个强化学习的开源项目,给你提供一套通用的指令,可以完成一些基础操作。并提供给你进一步写指令代码的框架。

MuJoCo:一个物理仿真平台,计算你的指令在现实中执行后可能产生什么结果。

在这个项目中是一起用,如果只是写一些小例子,可以只用Gymnasium,它的内部也包含了一些现成的环境。

本目录旨在提供:

- 可复现的仿真实验环境模板;
- 启动/调试脚本示例;
- 与主仓库其余模块交互的接口说明(若存在)。

## 推荐目录结构(示例)

- `simulator.py`:仿真环境实现(通常继承自 `gym.Env` 或 `gymnasium.Env`);
- `envs/`:若干子环境模块或封装;
- `agents/`:示例智能体或策略实现(可选);
- `scripts/`:运行/训练/评估脚本(如 `run.py`, `train.py`, `eval.py`);
- `tests/`:小型示例与单元/集成测试脚本(如 `test_simulator.py`);
- `configs/`:默认配置或参数文件(YAML/JSON);
- `README.md`:本文件。

(实际文件以仓库中为准,此处为常见约定。)

## 快速上手

以下示例以 Windows + PowerShell 为例:

1) 进入项目根目录并创建虚拟环境:

```powershell
cd D:\\nn
python -m venv .venv
.\\.venv\\Scripts\\Activate.ps1
```

2) 安装依赖:

```powershell
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

如果仓库未包含完整的 `requirements.txt`,可参考核心依赖:

```
gymnasium
mujoco
stable-baselines3
pygame
opencv-python
numpy
scipy
matplotlib
ruamel.yaml
```

3) 运行示例仿真(示例脚本名以仓库实际文件为准):

```powershell
python scripts/run.py
```

或:

```powershell
python tests/test_simulator.py
```

运行后通常会在本地弹出可视化窗口或在终端打印日志,具体行为视环境实现而定。

## 开发与调试提示

- MuJoCo:请确保已正确安装 MuJoCo 及其许可证(若使用 mujoco 依赖)。
- 显示/渲染:在无显示的服务器上运行时,可能需要配置虚拟帧缓冲(Linux 下使用 xvfb)。
- 依赖冲突:若出现版本不兼容,建议使用虚拟环境并锁定依赖版本。

## 如何贡献

- 修改或补充说明、示例脚本或配置后提交 Pull Request;
- 提交 Issue 时请包含:操作系统、Python 版本、依赖版本与复现步骤/错误日志。

## 参考与更多信息

- 查看目录下的具体脚本与模块顶部注释,通常包含使用示例与参数说明;
- 若需要,我可以为 `src/box` 中的主要文件生成更详细的文档或示例运行脚本。

**box — 仿真与强化学习实验箱**

简介
- `src/box` 目录包含基于 Gymnasium 和 MuJoCo 的仿真环境与相关辅助脚本,用于开发和测试生物力学/机器人仿真、感知模块与强化学习任务。

目录结构(示例)
- `simulator.py`:仿真环境核心(通常继承 `gym.Env`)。
- `test_simulator.py`:示例运行脚本,用于启动仿真并可视化。
- `main.py`:辅助脚本(例如证书或配置检查)。
- `README.md`:本文件,说明目录用途与快速上手指南。

快速上手
1. 创建并激活虚拟环境(以 Windows 为例):

```powershell
cd <项目根目录>
python -m venv venv --python=3.9
.\\venv\\Scripts\\Activate.ps1
```

2. 安装依赖(建议使用清华镜像加速):

```powershell
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

如果仓库没有完整的 `requirements.txt`,可参考下列核心库:

```text
gymnasium
mujoco
stable-baselines3
pygame
opencv-python
numpy
scipy
matplotlib
ruamel.yaml
certifi
```

运行示例
- 启动仿真:

```powershell
python test_simulator.py
```

运行后应弹出可视化窗口(若使用 Pygame/SDL),并在终端输出仿真日志。

贡献与问题反馈
- 若需添加说明或示例,请提交 Pull Request。
- 遇到环境或依赖问题,请在 Issue 中描述操作系统、Python 版本与错误日志。

更多信息
- 若目录中包含更详细的子模块文档,请参阅相应文件(如 `simulator.py` 顶部注释或同目录下的文档)。

---

2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ title: 主页
# 其他 <span id="other"></span>

- [__YOLO数据生成器__](./carla-yolo-dataset-generator/README.md)

- [__双机械臂协同仿真系统__](./dua_arm/index.md) - 基于Gymnasium/MuJoCo的仿真与强化学习实验环境
- [__驾驶事故视频识别__](./carla_temporal_collage/index.md) - 基于 Temporal Collage Prompting 的 CARLA 驾驶事故视频识别系统

- [__CARLA IMU 数据采集平台__](./carla_imu/carla_imu.md) — CARLA惯性测量单元数据采集与可视化驾驶平台开发汇报文档
Expand Down
152 changes: 152 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@

# box — 仿真与强化学习实验箱

## 概述

`src/box` 包含若干用于仿真、感知与强化学习实验的环境与辅助脚本。主要面向基于 Gymnasium/MuJoCo 的任务、轻量级可视化示例以及调试/测试工具。

Gymnasium:一个操作台,是网上的一个强化学习的开源项目,给你提供一套通用的指令,可以完成一些基础操作。并提供给你进一步写指令代码的框架。

MuJoCo:一个物理仿真平台,计算你的指令在现实中执行后可能产生什么结果。

在这个项目中是一起用,如果只是写一些小例子,可以只用Gymnasium,它的内部也包含了一些现成的环境。

本目录旨在提供:

- 可复现的仿真实验环境模板;
- 启动/调试脚本示例;
- 与主仓库其余模块交互的接口说明(若存在)。

## 推荐目录结构(示例)

- `simulator.py`:仿真环境实现(通常继承自 `gym.Env` 或 `gymnasium.Env`);
- `envs/`:若干子环境模块或封装;
- `agents/`:示例智能体或策略实现(可选);
- `scripts/`:运行/训练/评估脚本(如 `run.py`, `train.py`, `eval.py`);
- `tests/`:小型示例与单元/集成测试脚本(如 `test_simulator.py`);
- `configs/`:默认配置或参数文件(YAML/JSON);
- `README.md`:本文件。

(实际文件以仓库中为准,此处为常见约定。)

## 快速上手

以下示例以 Windows + PowerShell 为例:

1) 进入项目根目录并创建虚拟环境:

```powershell
cd D:\\nn
python -m venv .venv
.\\.venv\\Scripts\\Activate.ps1
```

2) 安装依赖:

```powershell
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

如果仓库未包含完整的 `requirements.txt`,可参考核心依赖:

```
gymnasium
mujoco
stable-baselines3
pygame
opencv-python
numpy
scipy
matplotlib
ruamel.yaml
```

3) 运行示例仿真(示例脚本名以仓库实际文件为准):

```powershell
python scripts/run.py
```

或:

```powershell
python tests/test_simulator.py
```

运行后通常会在本地弹出可视化窗口或在终端打印日志,具体行为视环境实现而定。

## 开发与调试提示

- MuJoCo:请确保已正确安装 MuJoCo 及其许可证(若使用 mujoco 依赖)。
- 显示/渲染:在无显示的服务器上运行时,可能需要配置虚拟帧缓冲(Linux 下使用 xvfb)。
- 依赖冲突:若出现版本不兼容,建议使用虚拟环境并锁定依赖版本。

## 如何贡献

- 修改或补充说明、示例脚本或配置后提交 Pull Request;
- 提交 Issue 时请包含:操作系统、Python 版本、依赖版本与复现步骤/错误日志。

## 参考与更多信息

- 查看目录下的具体脚本与模块顶部注释,通常包含使用示例与参数说明;
- 若需要,我可以为 `src/box` 中的主要文件生成更详细的文档或示例运行脚本。

**box — 仿真与强化学习实验箱**

简介
- `src/box` 目录包含基于 Gymnasium 和 MuJoCo 的仿真环境与相关辅助脚本,用于开发和测试生物力学/机器人仿真、感知模块与强化学习任务。

目录结构(示例)
- `simulator.py`:仿真环境核心(通常继承 `gym.Env`)。
- `test_simulator.py`:示例运行脚本,用于启动仿真并可视化。
- `main.py`:辅助脚本(例如证书或配置检查)。
- `README.md`:本文件,说明目录用途与快速上手指南。

快速上手
1. 创建并激活虚拟环境(以 Windows 为例):

```powershell
cd <项目根目录>
python -m venv venv --python=3.9
.\\venv\\Scripts\\Activate.ps1
```

2. 安装依赖(建议使用清华镜像加速):

```powershell
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

如果仓库没有完整的 `requirements.txt`,可参考下列核心库:

```text
gymnasium
mujoco
stable-baselines3
pygame
opencv-python
numpy
scipy
matplotlib
ruamel.yaml
certifi
```

运行示例
- 启动仿真:

```powershell
python test_simulator.py
```

运行后应弹出可视化窗口(若使用 Pygame/SDL),并在终端输出仿真日志。

贡献与问题反馈
- 若需添加说明或示例,请提交 Pull Request。
- 遇到环境或依赖问题,请在 Issue 中描述操作系统、Python 版本与错误日志。

更多信息
- 若目录中包含更详细的子模块文档,请参阅相应文件(如 `simulator.py` 顶部注释或同目录下的文档)。

---