Skip to content

Commit dd67a8f

Browse files
committed
+ updated readme file
1 parent 491ea51 commit dd67a8f

File tree

2 files changed

+38
-16
lines changed

2 files changed

+38
-16
lines changed

README.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ Mujoco Physics Simulation Package for Waterloo steel robot
77
- [TODO: Unity Integration] for rendering and realistic camera views
88

99
## Preview:
10-
### Waterloo Steel Mobile Grasping Playground:
11-
<img src="./documentation/playground_mobile_grasping.png" alt="waterloo_steel" width="600"/>
12-
> [ (1) Joint Status | (2) Position Control Panel | (3) Contact Point ]
10+
### Waterloo Steel Mobile Cart Manipulation Playground (engine & viewer):
11+
<img src="./documentation/main.png" alt="waterloo_steel" height="400"/>
1312

1413
## ToDo:
1514
- [x] Full Assembly
@@ -49,9 +48,12 @@ Mujoco Physics Simulation Package for Waterloo steel robot
4948
├── playground
5049
│   ├── playground_{playground-name}.xml
5150
│   └── ...
52-
├── src_examples
53-
│   ├── {scripts}.py
51+
├── src
52+
│   ├── {scripts}.py # [launch files]
5453
│   └── ...
54+
├── submodules
55+
│   ├── jx-mujoco-python-viewer # [Mujoco Render/Interaction GUI]
56+
│   └── jx-mujoco-python-engine # [Main engine code]
5557
└── textures
5658
│   └── ...
5759
x
@@ -68,19 +70,39 @@ x
6870
- Shall you have any concern with the parameters, kindly open an issue.
6971

7072
### Waterloo Steel Mobile Manipulator Simulation:
71-
#### Collision Meshes:
72-
<img src="./documentation/contact_physics_summit_wam_bhand.png" alt="waterloo_steel" width="600"/>
73+
#### Launch Demo:
7374

7475
#### Joints and MOI:
75-
<img src="./documentation/joints.png" alt="waterloo_steel" width="300"/>
76-
<img src="./documentation/MoI.png" alt="waterloo_steel" width="300"/>
76+
Joints | MOI
77+
:-------------------------:|:-------------------------:
78+
<img src="./documentation/joints.png" alt="waterloo_steel" height="300"/> | <img src="./documentation/MoI.png" alt="waterloo_steel" height="300"/>
7779

7880

7981
### Installation Guide
80-
- you may consider to utilize env manager to hot-swap setup environment:
81-
- pyenv + pyenv-virtualenv : for simple local machine python version env control
82-
- conda / miniforge
83-
- docker (not too familiar)
84-
- vagrant
85-
#### M1 Mac Specific:
86-
- MuJoCo 2.1.x works / NOT 2.2.x :C : https://github.com/openai/mujoco-py/issues/662
82+
- Install MuJoCo 2.2.x via `$ sudo pip install mujoco`
83+
84+
#### Tested Platforms:
85+
- M1 Macbook Pro 14"
86+
- Ubuntu 20.04
87+
#### Submodules:
88+
1. Submodule Update
89+
```zsh
90+
$ cd submodules
91+
$ git submodule update
92+
```
93+
2. Install editable [python viewer](https://github.com/jaku-jaku/jx-mujoco-python-viewer):
94+
```zsh
95+
$ cd jx-mujoco-python-viewer
96+
$ pip install -e .
97+
```
98+
3. Install editable [python engine](https://github.com/jaku-jaku/jx-mujoco-python-engine):
99+
```zsh
100+
$ cd jx-mujoco-python-engine
101+
$ pip install -e .
102+
```
103+
104+
#### Launch:
105+
##### Cart Manipulation:
106+
```
107+
$ cd src && python main.py
108+
```

documentation/main.png

218 KB
Loading

0 commit comments

Comments
 (0)