Skip to content

Commit 4d6b014

Browse files
authored
Update README.md
1 parent eeb45b0 commit 4d6b014

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Simulink Blockset for MuJoCo Simulator
22

3-
This repository provides a Simulink® C-MEX S-Function block interface to [MuJoCo™ physics engine](https://mujoco.org/).
3+
This repository provides a Simulink® C-MEX S-Function block interface to the [MuJoCo™ physics engine](https://mujoco.org/).
44

5-
<!--- [![View <File Exchange Title> on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/####-file-exchange-title) --->
5+
[![View <File Exchange Title> on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/128028-mujoco-simulink-blockset)
66

77
Useful for,
88
1. Robot simulation (mobile, biomimetic, grippers, robotic arm)
@@ -20,44 +20,53 @@ Useful for,
2020
- Control System Toolbox&trade; (optional)
2121
- Simulink&reg; Coder&trade; (optional)
2222

23-
MATLAB R2022b or newer recommended. Install MATLAB with the above products and then proceed to setting up MuJoCo blocks.
23+
MATLAB R2022b or newer is recommended. Install MATLAB with the above products and then proceed to set up MuJoCo blocks.
2424

2525
*Note - You may need to rebuild the S-Function if you are using an older release of MATLAB*.
2626

2727
### Simulink Blockset for MuJoCo
2828

2929
#### Windows&reg;:
3030

31-
- Download the latest release for Windows (Release_win64***.zip)
32-
- Open MATLAB R2022b. In case you are using a older MATLAB release, please follow the build instructions below to rebuild for a particular MATLAB release
33-
- Run install.m in MATLAB command window. MuJoCo and GLFW libraries will be downloaded and added to MATLAB Path.
31+
- Download the [latest release for Windows](https://github.com/mathworks-robotics/mujoco-simulink-blockset/releases/latest) (Release_win64***.zip)
32+
- Open MATLAB R2022b. In case you are using an older MATLAB release, please follow the build instructions below to rebuild for a particular MATLAB release
33+
- Run the install.m in the MATLAB command window. MuJoCo and GLFW libraries will be downloaded and added to MATLAB Path.
3434

3535
#### Ubuntu&reg;:
3636

37+
Ubuntu prebuilt release artifacts will be added later. Goto 'Build Instructions' below to build from the source code.
38+
<!---
3739
- Download the latest release of this repository (will be added soon. Goto build instructions for the time being)
3840
- Download and install GLFW library from Ubuntu terminal
3941
4042
`sudo apt update && sudo apt install libglfw3 libglfw3-dev`
4143
- Open MATLAB R2022b. In case you are using a older MATLAB release, please follow the build instructions below to rebuild for a particular MATLAB release
4244
- Run install.m in MATLAB command window. MuJoCo library will be downloaded and added to MATLAB Path.
4345
46+
--->
47+
48+
#### Note:
49+
*The 'Download' button from File Exchange only downloads the source code. If you use the download button, ensure that you run the 'Build Instructions' before continuing.*
50+
4451
## Usage
4552
Open examples/gettingStarted.slx model and click run
4653

47-
If the installation is successful, you should see a pendulum model running in a separate window and camera stream displayed by Video Viewer block (Computer Vision Toolbox). Dedicated graphics card is recommended for best performance.
54+
If the installation is successful, you should see a pendulum model running in a separate window and camera streams displayed by Video Viewer blocks (Computer Vision Toolbox).
55+
56+
*A dedicated graphics card is recommended for the best performance. Disable Video Viewer blocks if the model runs slow*
4857

4958
### Blocks
5059
<img width="400" alt="mjLib" src="https://user-images.githubusercontent.com/8917581/230754094-908a0a52-2c5d-4e8e-bd82-d2dcc553a846.png">
5160

52-
MuJoCo Plant block steps MuJoCo engine, renders visualization window & camera, sets actuator data and outputs sensor readings
61+
MuJoCo Plant block steps MuJoCo engine, renders visualization window & camera, sets actuator data, and outputs sensor readings
5362

54-
It takes an XML (MJCF) as the main block parameter. It auto detects the inputs, sensors, cameras from XML and sets the ports, sample time and other internal configuration.
63+
It takes an XML (MJCF) as the main block parameter. It auto-detects the inputs, sensors, and cameras from XML to configure the block ports and sample time.
5564

56-
Inputs can either be a Simulink Bus or vector.
65+
Inputs can either be a Simulink Bus or a vector.
5766

5867
Sensors are output as a Simulink Bus.
5968

60-
RGB and Depth buffers from camera are output as vectors. These can be decoded to Simulink image/matrix using the RGB and Depth Parser blocks.
69+
RGB and Depth buffers from cameras are output as vectors. These can be decoded to Simulink image/matrix using the RGB and Depth Parser blocks.
6170

6271

6372
https://user-images.githubusercontent.com/8917581/230754110-e98b0ed6-05af-416c-9f39-7e5abf562b25.mp4
@@ -90,7 +99,7 @@ Steps for building/rebuilding the C-MEX S-Function code. These instructions are
9099
`$ sudo apt update && sudo apt install build-essential git libglfw3 libglfw3-dev `
91100
- Clone this repository
92101

93-
`$ git clone [email protected]:mathworks-robotics/mujoco-simulink-blockset.git
102+
`$ git clone [email protected]:mathworks-robotics/mujoco-simulink-blockset.git`
94103
- Launch MATLAB and open the repository folder. Run the install.m script.
95104
- `>> install`
96105
- Open tools/ and run the following commands in MATLAB command Windows
@@ -103,13 +112,13 @@ Steps for building/rebuilding the C-MEX S-Function code. These instructions are
103112

104113
The license is available in the license.txt file within this repository.
105114

106-
## Acknowledgements
115+
## Acknowledgments
107116
Cite this work as,
108117

109118
Manoj Velmurugan. Simulink Blockset for MuJoCo Simulator (https://github.com/mathworks-robotics/mujoco-simulink-blockset), GitHub. Retrieved date.
110119

111120

112-
Refer to [MuJoCo repository](https://github.com/deepmind/mujoco) for guidelines on citing MuJoCo physics engine.
121+
Refer to the [MuJoCo repository](https://github.com/deepmind/mujoco) for guidelines on citing the MuJoCo physics engine.
113122

114123
The sample codes and API documentation provided for [MuJoCo](https://mujoco.readthedocs.io/en/latest/overview.html) and [GLFW](https://www.glfw.org/documentation) were used as reference material during development.
115124

@@ -121,6 +130,6 @@ UR5e MJCF XML from [MuJoCo Menagerie](https://github.com/deepmind/mujoco_menager
121130

122131
<!--- You can post your queries on the [MATLAB&reg; Central&trade; File Exchange](https://www.mathworks.com/matlabcentral/fileexchange/####-file-exchange-title) page. --->
123132

124-
You can post your queries on issues/discussions.
133+
You can post your queries in the discussions section.
125134

126135
Copyright 2023 The MathWorks, Inc.

0 commit comments

Comments
 (0)