Skip to content

Commit a021b75

Browse files
committed
add mujoco simulation section
1 parent 0037c4a commit a021b75

103 files changed

Lines changed: 928250 additions & 30 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.DS_Store

0 Bytes
Binary file not shown.
2.22 KB
Binary file not shown.
72 Bytes
Binary file not shown.
7.64 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

_build/html/_sources/lec2-dof/configuration.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ kinematic chain is closed when a sequence of links forms a loop. This course mai
7171
7272
MuJoCo (Multi-Joint dynamics with Contact) is a physics engine designed for the simulation and control of robots and other articulated mechanisms. It is widely used in robotics research for its speed, accuracy, and support for advanced features such as soft contacts and complex constraints.
7373
74-
**Key Features:**
74+
### Key Features
7575
7676
- Fast and accurate simulation of rigid body dynamics
7777
- Support for soft and hard contacts
7878
- Flexible model specification using XML
7979
- Widely used in reinforcement learning and robotics research
8080
81-
**Getting Started:**
81+
### Getting Started
8282
8383
To use MuJoCo, you need to:
8484
@@ -88,9 +88,6 @@ To use MuJoCo, you need to:
8888
8989
9090
91-
92-
```
93-
9491
# Configuration
9592
9693
```{important}

_build/html/_sources/lec4-fk/fk.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,40 @@ chosen in the approach direction to the object, $\boldsymbol{s}_{e}$ is
5252
chosen in the sliding plane of the jaws,
5353
and $\boldsymbol{n}_{e}$ is chosen to complete the right-handed rule.
5454

55+
```{admonition} MuJoCo Simulation of Franka Robot Arm
56+
:class: tip
57+
58+
To run the Franka Emika Panda forward kinematics simulation locally:
59+
60+
1. **Download the FK code files:**
61+
- [Download franka_emika_panda.zip](./fk_code/franka_emika_panda.zip)
62+
- Unzip the file to any folder of your choice on your local system.
63+
64+
2. **Install MuJoCo and its Python bindings:**
65+
- Make sure you have Python installed.
66+
- Install MuJoCo and the Python package:
67+
```sh
68+
pip install mujoco
69+
```
70+
71+
72+
3. **Run the simulation:**
73+
- Open the `demo.py` script in your code editor.
74+
- Set the `MODEL_PATH` variable in `demo.py` to the correct path of the `scene.xml` file in your local system. For example:
75+
```python
76+
MODEL_PATH = "/path/to/your/franka_emika_panda/scene.xml" # Use the provided scene.xml file
77+
model = mujoco.MjModel.from_xml_path(MODEL_PATH)
78+
```
79+
- Save the changes to `demo.py`.
80+
- In your terminal, navigate to the folder containing `demo.py` and run:
81+
```sh
82+
python demo.py
83+
```
84+
85+
You should see a window displaying the Franka Emika Panda robot simulation. Press ESC in the viewer window to exit.
86+
```
87+
88+
5589
# Notation Convention
5690

5791

@@ -84,6 +118,9 @@ end-effector frame with respect to Frame $n$, respectively.
84118
Question: how to choose frame for each link to faciliate the computation of
85119
$\boldsymbol{T}_{i}^{i-1}\left(q_{i}\right)$?
86120

121+
122+
123+
87124
# Denavit-Hartenberg (DH) Convention
88125

89126
DH Convention is to systematically and recursively
@@ -533,5 +570,7 @@ width: 50%
533570
name: cover
534571
---
535572
Panda's kinematic chain (from Peter Corke's
536-
Tutorial
573+
Tutorial)
537574
```
575+
576+
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Franka Emika Panda Description (MJCF)
2+
3+
Requires MuJoCo 2.3.3 or later.
4+
5+
## Overview
6+
7+
This package contains a simplified robot description (MJCF) of the [Franka Emika
8+
Panda](https://www.franka.de/) developed by [Franka
9+
Emika](https://www.franka.de/company). It is derived from the [publicly
10+
available URDF
11+
description](https://github.com/frankaemika/franka_ros/tree/develop/franka_description).
12+
13+
<p float="left">
14+
<img src="panda.png" width="400">
15+
</p>
16+
17+
## URDF → MJCF derivation steps
18+
19+
1. Converted the DAE [mesh
20+
files](https://github.com/frankaemika/franka_ros/tree/develop/franka_description/meshes/visual)
21+
to OBJ format using [Blender](https://www.blender.org/).
22+
2. Processed `.obj` files with [`obj2mjcf`](https://github.com/kevinzakka/obj2mjcf).
23+
3. Eliminated the perfectly flat `link0_6` from the resulting submeshes created for `link0`.
24+
4. Created a convex decomposition of the STL collision [mesh
25+
file](https://github.com/frankaemika/franka_ros/tree/develop/franka_description/meshes/collision)
26+
for `link5` using [V-HACD](https://github.com/kmammou/v-hacd).
27+
5. Added `<mujoco> <compiler discardvisual="false"/> </mujoco>` to the
28+
[URDF](https://github.com/frankaemika/franka_ros/tree/develop/franka_description/robots)'s
29+
`<robot>` clause in order to preserve visual geometries.
30+
6. Loaded the URDF into MuJoCo and saved a corresponding MJCF.
31+
7. Matched inertial parameters with [inertial.yaml](
32+
https://github.com/frankaemika/franka_ros/blob/develop/franka_description/robots/common/inertial.yaml).
33+
8. Added a tracking light to the base.
34+
9. Manually edited the MJCF to extract common properties into the `<default>` section.
35+
10. Added `<exclude>` clauses to prevent collisions between `link7` and `link8`.
36+
11. Manually designed collision geoms for the fingertips.
37+
12. Added position-controlled actuators for the arm.
38+
13. Added an equality constraint so that the left finger mimics the position of the right finger.
39+
14. Added a tendon to split the force equally between both fingers and a
40+
position actuator acting on this tendon.
41+
15. Added `scene.xml` which includes the robot, with a textured groundplane, skybox, and haze.
42+
43+
### MJX
44+
45+
A version of the Franka Emika Panda environment was created for MJX. Steps:
46+
47+
1. Added `mjx_panda.xml`, forked from `panda.xml`.
48+
2. Added `mjx_scene.xml` and `mjx_single_cube.xml`, forked from `scene.xml`.
49+
3. Gripper collision geometries were modified to contain less geoms. A capsule collision geom was added to the hand.
50+
4. Solver parameters were tuned for performance.
51+
5. Actuator `kp` and `kv` were reduced for more stable simulation.
52+
6. Added a `site` to the gripper.
53+
7. Removed tendon and added position actuator for the gripper. Changed gripper `ctrlrange`.
54+
55+
## License
56+
57+
This model is released under an [Apache-2.0 License](LICENSE).

0 commit comments

Comments
 (0)