Skip to content
Merged
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
103 changes: 51 additions & 52 deletions src/box/README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,59 @@
user-in-the-box-simulator
基于Gymnasium和MuJoCo的仿真器,集成生物力学模型、感知模块与强化学习任务,支持分层强化学习与可视化渲染
**box — 仿真与强化学习实验箱**

一、环境准备
1.虚拟环境创建与激活
# 切换到项目根目录
cd C:\Users\86186\user-in-the-box
简介
- `src/box` 目录包含基于 Gymnasium 和 MuJoCo 的仿真环境与相关辅助脚本,用于开发和测试生物力学/机器人仿真、感知模块与强化学习任务。

# 创建Python 3.9虚拟环境(兼容性最优)
python -m venv venv --python=3.9

# 激活虚拟环境(Windows PowerShell)
\venv\Scripts\Activate.ps1
2.依赖安装 使用国内镜像源加速安装:
# 核心依赖
pip install gymnasium==1.2.1 mujoco==2.3.5 stable-baselines3==2.2.1 pygame==2.5.2 opencv-python==4.9.0.80 -i https://pypi.tuna.tsinghua.edu.cn/simple

# 辅助依赖
pip install numpy==1.26.4 scipy==1.11.4 matplotlib==3.8.4 ruamel.yaml==0.18.6 certifi -i https://pypi.tuna.tsinghua.edu.cn/simple
目录结构(示例)
- `simulator.py`:仿真环境核心(通常继承 `gym.Env`)。
- `test_simulator.py`:示例运行脚本,用于启动仿真并可视化。
- `main.py`:辅助脚本(例如证书或配置检查)。
- `README.md`:本文件,说明目录用途与快速上手指南。

二、核心文件说明
快速上手
1. 创建并激活虚拟环境(以 Windows 为例):

1.simulator.py(仿真器核心)
功能:继承 gym.Env,实现仿真环境的初始化、步骤推进(step)、环境重置(reset)和可视化渲染(render),集成生物力学模型、感知模块和任务逻辑。 运行方式:需通过调用脚本(如 test_simulator.py)运行,示例见 “三、运行步骤”。
2.main.py(辅助脚本) 功能:基于 certifi 查询 CA 证书信息(路径或内容),用于验证网络请求的安全性。
运行方式:
# 查看证书路径
python main.py
```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
```

# 查看证书内容
python main.py -c
三、运行步骤
运行后应弹出可视化窗口(若使用 Pygame/SDL),并在终端输出仿真日志。

仿真器运行(simulator.py)
步骤 1:运行脚本 test_simulator.py
贡献与问题反馈
- 若需添加说明或示例,请提交 Pull Request。
- 遇到环境或依赖问题,请在 Issue 中描述操作系统、Python 版本与错误日志。

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

python test_simulator.py
此时会弹出 Pygame 窗口,展示仿真过程(如机械臂运动、感知模块渲染)。 2. 辅助脚本运行(main.py) 在终端执行以下命令,查看证书信息:

# 查看证书路径
python main.py

# 查看证书内容
python main.py -c

四、依赖清单
|库名称 |版本 |用途|
|------|-------|----|
|gymnasium| 1.2.1 |强化学习环境接口|
|mujoco|2.3.5|物理仿真引擎|
|stable-baselines3|2.2.1|强化学习算法库|
|pygame |2.5.2|可视化渲染|
|opencv-python|4.9.0.80|图像感知处理|
|numpy| 1.26.4| 数值计算|
|scipy| 1.11.4|科学计算|
|matplotlib|3.8.4|数据可视化|
|ruamel.yaml|0.18.6 |配置文件解析|
|certifi |2025.10.10 |CA 证书管理|
---
(此 README 为目录概览,具体实现与文件名以代码库为准)
Loading