Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shbang91 authored Sep 16, 2024
1 parent 382483b commit 7fcca17
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

**RPC** is a Modular Framework for Robot Planning, Control, and Deployment. It is designed to integrate multiple physics-based simulators, planning and control modules, visualization tools, plotting and logging utilities, and operator interfaces for robotic systems.<br/>

If you find our work useful in your research, please consider the following [citation](#book-citation).

## :package: Mandatory Dependencies
The controller has been tested on Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, and Mac OSX Sonoma. It builds on the shoulders of the following software:<br/>
Expand All @@ -18,7 +19,7 @@ $ conda env create -f rpc.yml
#### :walking: MPC for Locomotion
- [hpipm-cpp](https://github.com/shbang91/hpipm-cpp): C++ wrapper for HPIPM (QP solver). Note that **blasfo**, **hpipm**, and **hpipm-cpp** wrapper should be installed
#### :pinching_hand: Teleoperation for Manipulation
- [Teleoperation](): Please follow the instructions for installation and usage
- [Teleoperation](https://github.com/shbang91/rpc/tree/develop/scripts): Please follow the instructions for installation and usage
#### :toolbox: Utilities for Visualization, Plotting, Logging and Operator Interfaces
- [MatLogger2](https://github.com/shbang91/MatLogger2): logging numeric data (cpp to MAT-files)
- [zmq](https://github.com/shbang91/rpc/blob/main/dependency/scripts/install_zmq.sh): socket communication protocol
Expand All @@ -28,7 +29,7 @@ $ conda env create -f rpc.yml


## :computer: Usage
#### PyBullet
#### (1) PyBullet
- Source conda environment:<br/>
```
$ conda activate rpc
Expand All @@ -41,9 +42,9 @@ $ make -j4
```
- Run simulation:<br/>
```
python simulator/pybullet/draco_main.py
$ python simulator/pybullet/draco_main.py
```
#### MuJoCo
#### (2) MuJoCo
- Compile:<br/>
```
$ mkdir build && cd build
Expand All @@ -52,13 +53,13 @@ $ make -j4
```
- Run simulation:<br/>
```
./bin/run_draco
$ ./bin/run_draco
```
#### Keyboard Input
- Please see the [example implementation](https://github.com/shbang91/rpc/blob/develop/controller/draco_controller/draco_interrupt_handler.cpp) for DRACO 3

## :tv: Visualization
#### Foxglove UI (optional)
#### (1) Foxglove UI (optional)
###### Build
- Source conda environment:<br/>
```
Expand All @@ -85,7 +86,7 @@ $ python UI/foxglove/UI_launcher.py --visualizer=foxglove

- To set up the Foxglove URDF visualizer, please refer to the Readme [in the UI folder](https://github.com/shbang91/rpc/tree/develop/UI/foxglove)

#### Meshcat Visualizer (optional)
#### (2) Meshcat Visualizer (optional)
###### Run
```
$ conda env create -f visualize.yml
Expand All @@ -96,3 +97,16 @@ $ python UI/foxglove/UI_launcher.py --visualizer=meshcat

## :robot: Hardware Usage
- Please refer to this [repository](https://github.com/shbang91/draco3_nodelet) using rpc library

## :book: Citation
```
@misc{bang2024rpc,
title={RPC: A Modular Framework for Robot Planning, Control, and Deployment},
author={Bang, Seung Hyeon and Gonzalez, Carlos and Moore, Gabriel and Kang, Dong Ho and Seo, Mingyo and Sentis, Luis},
year={2024}
eprint={XXXX.XXXXXX},
archivePrefix={arXiv},
primaryClass={cs.RO},
url={}
}
```

0 comments on commit 7fcca17

Please sign in to comment.