Link to Onshape to robot converter in top level README.
PiperOrigin-RevId: 734426561 Change-Id: I1e5005c97d111204b2277c4b4d1fca9b162d0628
This commit is contained in:
committed by
Copybara-Service
parent
a816ca6dd5
commit
e4ee00e695
@@ -33,8 +33,9 @@ We also provide [Python bindings] and a plug-in for the [Unity] game engine.
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
MuJoCo's documentation can be found at [mujoco.readthedocs.io]. Upcoming features due for the next
|
MuJoCo's documentation can be found at [mujoco.readthedocs.io]. Upcoming
|
||||||
release can be found in the [changelog] in the latest branch.
|
features due for the next release can be found in the [changelog] in the
|
||||||
|
"latest" branch.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
@@ -54,14 +55,17 @@ running on Google Colab:
|
|||||||
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/tutorial.ipynb)
|
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/tutorial.ipynb)
|
||||||
- The **rollout** tutorial shows how to use the multithreaded `rollout` module:
|
- The **rollout** tutorial shows how to use the multithreaded `rollout` module:
|
||||||
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/rollout.ipynb)
|
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/rollout.ipynb)
|
||||||
- The **LQR** tutorial synthesizes a linear-quadratic controller, balancing a humanoid on one leg:
|
- The **LQR** tutorial synthesizes a linear-quadratic controller, balancing a
|
||||||
|
humanoid on one leg:
|
||||||
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/LQR.ipynb)
|
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/LQR.ipynb)
|
||||||
- The **least-squares** tutorial explains how to use the Python-based nonlinear least-squares solver:
|
- The **least-squares** tutorial explains how to use the Python-based nonlinear
|
||||||
|
least-squares solver:
|
||||||
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/least_squares.ipynb)
|
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/least_squares.ipynb)
|
||||||
- The **MJX** tutorial provides usage examples of
|
- The **MJX** tutorial provides usage examples of
|
||||||
[MuJoCo XLA](https://mujoco.readthedocs.io/en/stable/mjx.html), a branch of MuJoCo written in JAX:
|
[MuJoCo XLA](https://mujoco.readthedocs.io/en/stable/mjx.html), a branch of MuJoCo written in JAX:
|
||||||
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/mjx/tutorial.ipynb)
|
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/mjx/tutorial.ipynb)
|
||||||
- The **differentiable physics** tutorial trains locomotion policies with analytical gradients automatically derived from MuJoCo's physics step:
|
- The **differentiable physics** tutorial trains locomotion policies with
|
||||||
|
analytical gradients automatically derived from MuJoCo's physics step:
|
||||||
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/mjx/training_apg.ipynb)
|
[](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/mjx/training_apg.ipynb)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@@ -75,7 +79,7 @@ and macOS (universal). This is the recommended way to use the software.
|
|||||||
### Building from source
|
### Building from source
|
||||||
|
|
||||||
Users who wish to build MuJoCo from source should consult the [build from
|
Users who wish to build MuJoCo from source should consult the [build from
|
||||||
source] section of the documentation. However, please note that the commit at
|
source] section of the documentation. However, note that the commit at
|
||||||
the tip of the `main` branch may be unstable.
|
the tip of the `main` branch may be unstable.
|
||||||
|
|
||||||
### Python (>= 3.9)
|
### Python (>= 3.9)
|
||||||
@@ -111,7 +115,8 @@ GitHub [Issues](https://github.com/google-deepmind/mujoco/issues) are reserved
|
|||||||
for bug reports, feature requests and other development-related subjects.
|
for bug reports, feature requests and other development-related subjects.
|
||||||
|
|
||||||
## Related software
|
## Related software
|
||||||
MuJoCo is the backbone for numerous environment packages. Below we list several bindings and converters.
|
MuJoCo is the backbone for numerous environment packages. Below we list several
|
||||||
|
bindings and converters.
|
||||||
|
|
||||||
### Bindings
|
### Bindings
|
||||||
|
|
||||||
@@ -139,7 +144,6 @@ These packages give users of various languages access to MuJoCo functionality:
|
|||||||
- **Java**: [mujoco-java](https://github.com/CommonWealthRobotics/mujoco-java)
|
- **Java**: [mujoco-java](https://github.com/CommonWealthRobotics/mujoco-java)
|
||||||
- **Julia**: [MuJoCo.jl](https://github.com/JamieMair/MuJoCo.jl)
|
- **Julia**: [MuJoCo.jl](https://github.com/JamieMair/MuJoCo.jl)
|
||||||
|
|
||||||
|
|
||||||
### Converters
|
### Converters
|
||||||
|
|
||||||
- **OpenSim**: [MyoConverter](https://github.com/MyoHub/myoconverter) converts
|
- **OpenSim**: [MyoConverter](https://github.com/MyoHub/myoconverter) converts
|
||||||
@@ -148,6 +152,8 @@ These packages give users of various languages access to MuJoCo functionality:
|
|||||||
two-way SDFormat <-> MJCF conversion tool.
|
two-way SDFormat <-> MJCF conversion tool.
|
||||||
- **OBJ**: [obj2mjcf](https://github.com/kevinzakka/obj2mjcf)
|
- **OBJ**: [obj2mjcf](https://github.com/kevinzakka/obj2mjcf)
|
||||||
a script for converting composite OBJ files into a loadable MJCF model.
|
a script for converting composite OBJ files into a loadable MJCF model.
|
||||||
|
- **onshape**: [Onshape to Robot](https://github.com/rhoban/onshape-to-robot)
|
||||||
|
Converts [onshape](https://www.onshape.com/en/) CAD assemblies to MJCF.
|
||||||
|
|
||||||
## Citation
|
## Citation
|
||||||
|
|
||||||
@@ -186,7 +192,6 @@ This is not an officially supported Google product.
|
|||||||
[Getting Started]: https://mujoco.readthedocs.io/en/latest/programming#getting-started
|
[Getting Started]: https://mujoco.readthedocs.io/en/latest/programming#getting-started
|
||||||
[Unity]: https://unity.com/
|
[Unity]: https://unity.com/
|
||||||
[releases page]: https://github.com/google-deepmind/mujoco/releases
|
[releases page]: https://github.com/google-deepmind/mujoco/releases
|
||||||
[GitHub Issues]: https://github.com/google-deepmind/mujoco/issues
|
|
||||||
[mujoco.readthedocs.io]: https://mujoco.readthedocs.io
|
[mujoco.readthedocs.io]: https://mujoco.readthedocs.io
|
||||||
[changelog]: https://mujoco.readthedocs.io/en/latest/changelog.html
|
[changelog]: https://mujoco.readthedocs.io/en/latest/changelog.html
|
||||||
[Python bindings]: https://mujoco.readthedocs.io/en/stable/python.html#python-bindings
|
[Python bindings]: https://mujoco.readthedocs.io/en/stable/python.html#python-bindings
|
||||||
|
|||||||
Reference in New Issue
Block a user