diff --git a/README.md b/README.md index 7c7bb97..385601d 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ [中文文档](README_CN.md) -Simulation verification and physical deployment of robot reinforcement learning algorithms, suitable for quadruped robots, wheeled robots, and humanoid robots. "sar" stands for "simulation and real" +This repository provides a framework for simulation verification and physical deployment of robot reinforcement learning algorithms, suitable for quadruped robots, wheeled robots, and humanoid robots. "sar" stands for "simulation and real" -This framework supports legged_gym based on IaacGym and IsaacLab based on IsaacSim. Use `framework` to distinguish. +feature: +- Support legged_gym based on IaacGym and IsaacLab based on IsaacSim. Use `framework` to distinguish. +- The code supports both cpp and python, you can find python version in `src/rl_sar/scripts` [Click to discuss on Discord](https://discord.gg/vmVjkhVugU) @@ -18,12 +20,10 @@ git clone https://github.com/fan-ziqi/rl_sar.git ## Dependency -This project relies on ROS Noetic (Ubuntu 20.04) - -After installing ROS, install the dependency library +This project uses `ros-noetic` (Ubuntu 20.04) and requires the installation of the following ROS dependency packages: ```bash -sudo apt install ros-noetic-teleop-twist-keyboard ros-noetic-controller-interface ros-noetic-gazebo-ros-control ros-noetic-joint-state-controller ros-noetic-effort-controllers ros-noetic-joint-trajectory-controller +sudo apt install ros-noetic-teleop-twist-keyboard ros-noetic-controller-interface ros-noetic-gazebo-ros-control ros-noetic-joint-state-controller ros-noetic-effort-controllers ros-noetic-joint-trajectory-controller ``` Download and deploy `libtorch` at any location @@ -35,6 +35,16 @@ unzip libtorch-cxx11-abi-shared-with-deps-2.0.1+cpu.zip -d ./ echo 'export Torch_DIR=/path/to/your/torchlib' >> ~/.bashrc ``` +Install `yaml-cpp` and `lcm`. If you are using Ubuntu, you can directly use the package manager for installation: + +```bash +sudo apt install liblcm-dev libyaml-cpp-dev +``` + +
+ +You can also use source code installation, click to expand + Install yaml-cpp ```bash @@ -48,12 +58,13 @@ sudo ldconfig Install lcm ```bash -git clone https://github.com/lcm-proj/lcm.git +git clone https://github.com/lcm-proj/lcm.git cd lcm && mkdir build && cd build cmake .. && make sudo make install sudo ldconfig ``` +
## Compilation diff --git a/README_CN.md b/README_CN.md index 5d92c70..67812ae 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,9 +2,11 @@ [English document](README.md) -机器人强化学习算法的仿真验证与实物部署,适配四足机器人、轮足机器人、人形机器人。"sar"代表"simulation and real" +本仓库提供了机器人强化学习算法的仿真验证与实物部署框架,适配四足机器人、轮足机器人、人形机器人。"sar"代表"simulation and real" -本框架支持基于IaacGym的legged_gym,也支持基于IsaacSim的IsaacLab,用`framework`加以区分。 +特性: +- 支持基于IaacGym的legged_gym,也支持基于IsaacSim的IsaacLab,用`framework`加以区分。 +- 代码有python和cpp两个版本,python版本可以在`src/rl_sar/scripts`中找到 [点击在Discord上讨论](https://discord.gg/MC9KguQHtt) @@ -18,12 +20,10 @@ git clone https://github.com/fan-ziqi/rl_sar.git ## 依赖 -本项目依赖ROS-Noetic(Ubuntu20.04) - -安装好ros之后安装依赖库 +本项目使用`ros-noetic`(Ubuntu20.04),且需要安装以下的ros依赖包 ```bash -sudo apt install ros-noetic-teleop-twist-keyboard ros-noetic-controller-interface ros-noetic-gazebo-ros-control ros-noetic-joint-state-controller ros-noetic-effort-controllers ros-noetic-joint-trajectory-controller +sudo apt install ros-noetic-teleop-twist-keyboard ros-noetic-controller-interface ros-noetic-gazebo-ros-control ros-noetic-joint-state-controller ros-noetic-effort-controllers ros-noetic-joint-trajectory-controller ``` 在任意位置下载并部署`libtorch` @@ -35,6 +35,16 @@ unzip libtorch-cxx11-abi-shared-with-deps-2.0.1+cpu.zip -d ./ echo 'export Torch_DIR=/path/to/your/torchlib' >> ~/.bashrc ``` +安装`yaml-cpp`和`lcm`,若您使用Ubuntu,可以直接使用包管理器进行安装 + +```bash +sudo apt install liblcm-dev libyaml-cpp-dev +``` + +
+ +也可以使用源码安装,点击展开 + 安装yaml-cpp ```bash @@ -48,12 +58,13 @@ sudo ldconfig 安装lcm ```bash -git clone https://github.com/lcm-proj/lcm.git +git clone https://github.com/lcm-proj/lcm.git cd lcm && mkdir build && cd build cmake .. && make sudo make install sudo ldconfig ``` +
## 编译