Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions src/box/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

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

## 概述
Expand Down Expand Up @@ -82,3 +83,63 @@ python tests/test_simulator.py

- 查看目录下的具体脚本与模块顶部注释,通常包含使用示例与参数说明;
- 若需要,我可以为 `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` 顶部注释或同目录下的文档)。

---

Loading
Loading