You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-15Lines changed: 24 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Simulink Blockset for MuJoCo Simulator
2
2
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/).
4
4
5
-
<!--- [](https://www.mathworks.com/matlabcentral/fileexchange/####-file-exchange-title) --->
5
+
[](https://www.mathworks.com/matlabcentral/fileexchange/128028-mujoco-simulink-blockset)
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.
24
24
25
25
*Note - You may need to rebuild the S-Function if you are using an older release of MATLAB*.
26
26
27
27
### Simulink Blockset for MuJoCo
28
28
29
29
#### Windows®:
30
30
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.
34
34
35
35
#### Ubuntu®:
36
36
37
+
Ubuntu prebuilt release artifacts will be added later. Goto 'Build Instructions' below to build from the source code.
38
+
<!---
37
39
- Download the latest release of this repository (will be added soon. Goto build instructions for the time being)
38
40
- Download and install GLFW library from Ubuntu terminal
- 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
42
44
- Run install.m in MATLAB command window. MuJoCo library will be downloaded and added to MATLAB Path.
43
45
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
+
44
51
## Usage
45
52
Open examples/gettingStarted.slx model and click run
46
53
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*
It takes an XML (MJCF) as the main block parameter. It autodetects 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 portsand sample time.
55
64
56
-
Inputs can either be a Simulink Bus or vector.
65
+
Inputs can either be a Simulink Bus or a vector.
57
66
58
67
Sensors are output as a Simulink Bus.
59
68
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.
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.
113
122
114
123
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.
115
124
@@ -121,6 +130,6 @@ UR5e MJCF XML from [MuJoCo Menagerie](https://github.com/deepmind/mujoco_menager
121
130
122
131
<!--- You can post your queries on the [MATLAB® Central™ File Exchange](https://www.mathworks.com/matlabcentral/fileexchange/####-file-exchange-title) page. --->
123
132
124
-
You can post your queries on issues/discussions.
133
+
You can post your queries in the discussions section.
0 commit comments