mujoco-uni 3.8.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (211) hide show
  1. mujoco_uni-3.8.0/MANIFEST.in +5 -0
  2. mujoco_uni-3.8.0/PKG-INFO +118 -0
  3. mujoco_uni-3.8.0/README.md +73 -0
  4. mujoco_uni-3.8.0/mujoco/CMakeLists.txt +593 -0
  5. mujoco_uni-3.8.0/mujoco/__init__.py +253 -0
  6. mujoco_uni-3.8.0/mujoco/batch_env.cc +1885 -0
  7. mujoco_uni-3.8.0/mujoco/batch_env.py +532 -0
  8. mujoco_uni-3.8.0/mujoco/batch_env_benchmark.py +510 -0
  9. mujoco_uni-3.8.0/mujoco/batch_env_parity_check.py +162 -0
  10. mujoco_uni-3.8.0/mujoco/batch_env_test.py +1227 -0
  11. mujoco_uni-3.8.0/mujoco/bindings_test.py +1941 -0
  12. mujoco_uni-3.8.0/mujoco/callbacks.cc +413 -0
  13. mujoco_uni-3.8.0/mujoco/cgl/__init__.py +74 -0
  14. mujoco_uni-3.8.0/mujoco/cgl/cgl.py +142 -0
  15. mujoco_uni-3.8.0/mujoco/cmake/CheckAvxSupport.cmake +56 -0
  16. mujoco_uni-3.8.0/mujoco/cmake/FindOrFetch.cmake +206 -0
  17. mujoco_uni-3.8.0/mujoco/cmake/MujocoDependencies.cmake +367 -0
  18. mujoco_uni-3.8.0/mujoco/cmake/MujocoHarden.cmake +35 -0
  19. mujoco_uni-3.8.0/mujoco/cmake/MujocoLinkOptions.cmake +72 -0
  20. mujoco_uni-3.8.0/mujoco/cmake/MujocoMacOS.cmake +41 -0
  21. mujoco_uni-3.8.0/mujoco/cmake/MujocoOptions.cmake +121 -0
  22. mujoco_uni-3.8.0/mujoco/cmake/ShellTests.cmake +52 -0
  23. mujoco_uni-3.8.0/mujoco/cmake/TargetAddRpath.cmake +189 -0
  24. mujoco_uni-3.8.0/mujoco/constants.cc +99 -0
  25. mujoco_uni-3.8.0/mujoco/egl/__init__.py +138 -0
  26. mujoco_uni-3.8.0/mujoco/egl/egl_ext.py +71 -0
  27. mujoco_uni-3.8.0/mujoco/enum_traits.h +1009 -0
  28. mujoco_uni-3.8.0/mujoco/enums.cc +151 -0
  29. mujoco_uni-3.8.0/mujoco/errors.cc +25 -0
  30. mujoco_uni-3.8.0/mujoco/errors.h +194 -0
  31. mujoco_uni-3.8.0/mujoco/function_traits.h +5781 -0
  32. mujoco_uni-3.8.0/mujoco/functions.cc +1718 -0
  33. mujoco_uni-3.8.0/mujoco/functions.h +214 -0
  34. mujoco_uni-3.8.0/mujoco/gl_context.py +21 -0
  35. mujoco_uni-3.8.0/mujoco/glfw/__init__.py +41 -0
  36. mujoco_uni-3.8.0/mujoco/include/mujoco/mjdata.h +534 -0
  37. mujoco_uni-3.8.0/mujoco/include/mujoco/mjexport.h +47 -0
  38. mujoco_uni-3.8.0/mujoco/include/mujoco/mjmacro.h +38 -0
  39. mujoco_uni-3.8.0/mujoco/include/mujoco/mjmodel.h +1330 -0
  40. mujoco_uni-3.8.0/mujoco/include/mujoco/mjplugin.h +229 -0
  41. mujoco_uni-3.8.0/mujoco/include/mujoco/mjrender.h +177 -0
  42. mujoco_uni-3.8.0/mujoco/include/mujoco/mjsan.h +69 -0
  43. mujoco_uni-3.8.0/mujoco/include/mujoco/mjspec.h +803 -0
  44. mujoco_uni-3.8.0/mujoco/include/mujoco/mjthread.h +42 -0
  45. mujoco_uni-3.8.0/mujoco/include/mujoco/mjtnum.h +46 -0
  46. mujoco_uni-3.8.0/mujoco/include/mujoco/mjui.h +345 -0
  47. mujoco_uni-3.8.0/mujoco/include/mujoco/mjvisualize.h +415 -0
  48. mujoco_uni-3.8.0/mujoco/include/mujoco/mjxmacro.h +1053 -0
  49. mujoco_uni-3.8.0/mujoco/include/mujoco/mujoco.h +2087 -0
  50. mujoco_uni-3.8.0/mujoco/indexer_xmacro.h +442 -0
  51. mujoco_uni-3.8.0/mujoco/indexers.cc +441 -0
  52. mujoco_uni-3.8.0/mujoco/indexers.h +232 -0
  53. mujoco_uni-3.8.0/mujoco/introspect/__init__.py +14 -0
  54. mujoco_uni-3.8.0/mujoco/introspect/ast_nodes.py +307 -0
  55. mujoco_uni-3.8.0/mujoco/introspect/ast_nodes_test.py +202 -0
  56. mujoco_uni-3.8.0/mujoco/introspect/codegen/formatter.py +149 -0
  57. mujoco_uni-3.8.0/mujoco/introspect/codegen/generate_enums.py +128 -0
  58. mujoco_uni-3.8.0/mujoco/introspect/codegen/generate_functions.py +193 -0
  59. mujoco_uni-3.8.0/mujoco/introspect/codegen/generate_structs.py +283 -0
  60. mujoco_uni-3.8.0/mujoco/introspect/enums.py +1003 -0
  61. mujoco_uni-3.8.0/mujoco/introspect/enums_test.py +68 -0
  62. mujoco_uni-3.8.0/mujoco/introspect/functions.py +12749 -0
  63. mujoco_uni-3.8.0/mujoco/introspect/functions_test.py +68 -0
  64. mujoco_uni-3.8.0/mujoco/introspect/mjxmacro.py +43 -0
  65. mujoco_uni-3.8.0/mujoco/introspect/structs.py +12027 -0
  66. mujoco_uni-3.8.0/mujoco/introspect/structs_test.py +129 -0
  67. mujoco_uni-3.8.0/mujoco/introspect/type_parsing.py +154 -0
  68. mujoco_uni-3.8.0/mujoco/introspect/type_parsing_test.py +58 -0
  69. mujoco_uni-3.8.0/mujoco/libmujoco.3.8.0.dylib +0 -0
  70. mujoco_uni-3.8.0/mujoco/memory_leak_test.py +70 -0
  71. mujoco_uni-3.8.0/mujoco/minimize.py +576 -0
  72. mujoco_uni-3.8.0/mujoco/minimize_test.py +324 -0
  73. mujoco_uni-3.8.0/mujoco/mjpython/Info.plist +34 -0
  74. mujoco_uni-3.8.0/mujoco/mjpython/mjpython.icns +0 -0
  75. mujoco_uni-3.8.0/mujoco/mjpython/mjpython.mm +388 -0
  76. mujoco_uni-3.8.0/mujoco/mjpython/mjpython.py +100 -0
  77. mujoco_uni-3.8.0/mujoco/msh2obj.py +111 -0
  78. mujoco_uni-3.8.0/mujoco/msh2obj_test.py +80 -0
  79. mujoco_uni-3.8.0/mujoco/osmesa/__init__.py +81 -0
  80. mujoco_uni-3.8.0/mujoco/plugin/libactuator.dylib +0 -0
  81. mujoco_uni-3.8.0/mujoco/plugin/libelasticity.dylib +0 -0
  82. mujoco_uni-3.8.0/mujoco/plugin/libsdf_plugin.dylib +0 -0
  83. mujoco_uni-3.8.0/mujoco/plugin/libsensor.dylib +0 -0
  84. mujoco_uni-3.8.0/mujoco/private.h +28 -0
  85. mujoco_uni-3.8.0/mujoco/raw.h +91 -0
  86. mujoco_uni-3.8.0/mujoco/render.cc +296 -0
  87. mujoco_uni-3.8.0/mujoco/render_test.py +115 -0
  88. mujoco_uni-3.8.0/mujoco/renderer.py +21 -0
  89. mujoco_uni-3.8.0/mujoco/renderer_test.py +162 -0
  90. mujoco_uni-3.8.0/mujoco/rendering/classic/__init__.py +16 -0
  91. mujoco_uni-3.8.0/mujoco/rendering/classic/gl_context.py +48 -0
  92. mujoco_uni-3.8.0/mujoco/rendering/classic/renderer.py +339 -0
  93. mujoco_uni-3.8.0/mujoco/rollout.cc +361 -0
  94. mujoco_uni-3.8.0/mujoco/rollout.py +433 -0
  95. mujoco_uni-3.8.0/mujoco/rollout_test.py +989 -0
  96. mujoco_uni-3.8.0/mujoco/serialization.h +76 -0
  97. mujoco_uni-3.8.0/mujoco/simulate/CMakeLists.txt +291 -0
  98. mujoco_uni-3.8.0/mujoco/simulate/array_safety.h +105 -0
  99. mujoco_uni-3.8.0/mujoco/simulate/cmake/CheckAvxSupport.cmake +56 -0
  100. mujoco_uni-3.8.0/mujoco/simulate/cmake/FindOrFetch.cmake +206 -0
  101. mujoco_uni-3.8.0/mujoco/simulate/cmake/MujocoHarden.cmake +35 -0
  102. mujoco_uni-3.8.0/mujoco/simulate/cmake/MujocoLinkOptions.cmake +72 -0
  103. mujoco_uni-3.8.0/mujoco/simulate/cmake/MujocoMacOS.cmake +41 -0
  104. mujoco_uni-3.8.0/mujoco/simulate/cmake/SimulateDependencies.cmake +104 -0
  105. mujoco_uni-3.8.0/mujoco/simulate/cmake/SimulateOptions.cmake +121 -0
  106. mujoco_uni-3.8.0/mujoco/simulate/glfw_adapter.cc +252 -0
  107. mujoco_uni-3.8.0/mujoco/simulate/glfw_adapter.h +78 -0
  108. mujoco_uni-3.8.0/mujoco/simulate/glfw_corevideo.h +57 -0
  109. mujoco_uni-3.8.0/mujoco/simulate/glfw_corevideo.mm +71 -0
  110. mujoco_uni-3.8.0/mujoco/simulate/glfw_dispatch.cc +127 -0
  111. mujoco_uni-3.8.0/mujoco/simulate/glfw_dispatch.h +77 -0
  112. mujoco_uni-3.8.0/mujoco/simulate/macos_gui.mm +44 -0
  113. mujoco_uni-3.8.0/mujoco/simulate/main.cc +548 -0
  114. mujoco_uni-3.8.0/mujoco/simulate/platform_ui_adapter.cc +248 -0
  115. mujoco_uni-3.8.0/mujoco/simulate/platform_ui_adapter.h +101 -0
  116. mujoco_uni-3.8.0/mujoco/simulate/simulate.cc +3135 -0
  117. mujoco_uni-3.8.0/mujoco/simulate/simulate.h +362 -0
  118. mujoco_uni-3.8.0/mujoco/simulate.cc +468 -0
  119. mujoco_uni-3.8.0/mujoco/specs.cc +1578 -0
  120. mujoco_uni-3.8.0/mujoco/specs.cc.inc +8680 -0
  121. mujoco_uni-3.8.0/mujoco/specs_test.py +1968 -0
  122. mujoco_uni-3.8.0/mujoco/specs_wrapper.cc +134 -0
  123. mujoco_uni-3.8.0/mujoco/specs_wrapper.h +45 -0
  124. mujoco_uni-3.8.0/mujoco/structs.cc +1275 -0
  125. mujoco_uni-3.8.0/mujoco/structs.h +1241 -0
  126. mujoco_uni-3.8.0/mujoco/structs_wrappers.cc +1368 -0
  127. mujoco_uni-3.8.0/mujoco/sysid/__init__.py +57 -0
  128. mujoco_uni-3.8.0/mujoco/sysid/_src/__init__.py +15 -0
  129. mujoco_uni-3.8.0/mujoco/sysid/_src/io.py +81 -0
  130. mujoco_uni-3.8.0/mujoco/sysid/_src/model_modifier.py +598 -0
  131. mujoco_uni-3.8.0/mujoco/sysid/_src/optimize.py +284 -0
  132. mujoco_uni-3.8.0/mujoco/sysid/_src/parameter.py +673 -0
  133. mujoco_uni-3.8.0/mujoco/sysid/_src/plotting.py +114 -0
  134. mujoco_uni-3.8.0/mujoco/sysid/_src/residual.py +449 -0
  135. mujoco_uni-3.8.0/mujoco/sysid/_src/signal_modifier.py +325 -0
  136. mujoco_uni-3.8.0/mujoco/sysid/_src/signal_transform.py +301 -0
  137. mujoco_uni-3.8.0/mujoco/sysid/_src/timeseries.py +794 -0
  138. mujoco_uni-3.8.0/mujoco/sysid/_src/trajectory.py +652 -0
  139. mujoco_uni-3.8.0/mujoco/sysid/py.typed +0 -0
  140. mujoco_uni-3.8.0/mujoco/sysid/report/builder.py +122 -0
  141. mujoco_uni-3.8.0/mujoco/sysid/report/defaults.py +291 -0
  142. mujoco_uni-3.8.0/mujoco/sysid/report/sections/__init__.py +15 -0
  143. mujoco_uni-3.8.0/mujoco/sysid/report/sections/base.py +63 -0
  144. mujoco_uni-3.8.0/mujoco/sysid/report/sections/covariance.py +177 -0
  145. mujoco_uni-3.8.0/mujoco/sysid/report/sections/group.py +59 -0
  146. mujoco_uni-3.8.0/mujoco/sysid/report/sections/insights.py +113 -0
  147. mujoco_uni-3.8.0/mujoco/sysid/report/sections/optimization_trace.py +471 -0
  148. mujoco_uni-3.8.0/mujoco/sysid/report/sections/parameter_distribution.py +428 -0
  149. mujoco_uni-3.8.0/mujoco/sysid/report/sections/parameters.py +240 -0
  150. mujoco_uni-3.8.0/mujoco/sysid/report/sections/row.py +63 -0
  151. mujoco_uni-3.8.0/mujoco/sysid/report/sections/signals.py +231 -0
  152. mujoco_uni-3.8.0/mujoco/sysid/report/sections/video.py +216 -0
  153. mujoco_uni-3.8.0/mujoco/sysid/report/templates/covariance.html +204 -0
  154. mujoco_uni-3.8.0/mujoco/sysid/report/templates/group.html +13 -0
  155. mujoco_uni-3.8.0/mujoco/sysid/report/templates/insights.html +90 -0
  156. mujoco_uni-3.8.0/mujoco/sysid/report/templates/layout.html +699 -0
  157. mujoco_uni-3.8.0/mujoco/sysid/report/templates/optimization_trace.html +20 -0
  158. mujoco_uni-3.8.0/mujoco/sysid/report/templates/parameter_confidence.html +3 -0
  159. mujoco_uni-3.8.0/mujoco/sysid/report/templates/parameters_table.html +147 -0
  160. mujoco_uni-3.8.0/mujoco/sysid/report/templates/plot_generic.html +8 -0
  161. mujoco_uni-3.8.0/mujoco/sysid/report/templates/row.html +13 -0
  162. mujoco_uni-3.8.0/mujoco/sysid/report/templates/signals.html +3 -0
  163. mujoco_uni-3.8.0/mujoco/sysid/report/templates/video.html +11 -0
  164. mujoco_uni-3.8.0/mujoco/sysid/report/utils.py +61 -0
  165. mujoco_uni-3.8.0/mujoco/sysid/tests/__init__.py +15 -0
  166. mujoco_uni-3.8.0/mujoco/sysid/tests/conftest.py +224 -0
  167. mujoco_uni-3.8.0/mujoco/sysid/tests/test_integration.py +235 -0
  168. mujoco_uni-3.8.0/mujoco/sysid/tests/test_model_modifier.py +131 -0
  169. mujoco_uni-3.8.0/mujoco/sysid/tests/test_parameter.py +148 -0
  170. mujoco_uni-3.8.0/mujoco/sysid/tests/test_signal.py +391 -0
  171. mujoco_uni-3.8.0/mujoco/sysid/tests/test_timeseries.py +453 -0
  172. mujoco_uni-3.8.0/mujoco/sysid/tests/test_trajectory.py +204 -0
  173. mujoco_uni-3.8.0/mujoco/test_batch_env_multimodel.py +182 -0
  174. mujoco_uni-3.8.0/mujoco/testdata/MJCF_NoRoot.zip +0 -0
  175. mujoco_uni-3.8.0/mujoco/testdata/MJCF_Root.zip +0 -0
  176. mujoco_uni-3.8.0/mujoco/testdata/abdomen_1_body.msh +0 -0
  177. mujoco_uni-3.8.0/mujoco/testdata/model.urdf +4 -0
  178. mujoco_uni-3.8.0/mujoco/testdata/model.xml +178 -0
  179. mujoco_uni-3.8.0/mujoco/testdata/msh.xml +5 -0
  180. mujoco_uni-3.8.0/mujoco/testdata/simple_usd_preview_surface.usda +81 -0
  181. mujoco_uni-3.8.0/mujoco/testdata/usd_golden.usda +89 -0
  182. mujoco_uni-3.8.0/mujoco/threadpool.cc +87 -0
  183. mujoco_uni-3.8.0/mujoco/threadpool.h +80 -0
  184. mujoco_uni-3.8.0/mujoco/usd/camera.py +55 -0
  185. mujoco_uni-3.8.0/mujoco/usd/demo.py +96 -0
  186. mujoco_uni-3.8.0/mujoco/usd/exporter.py +529 -0
  187. mujoco_uni-3.8.0/mujoco/usd/exporter_test.py +74 -0
  188. mujoco_uni-3.8.0/mujoco/usd/lights.py +83 -0
  189. mujoco_uni-3.8.0/mujoco/usd/objects.py +552 -0
  190. mujoco_uni-3.8.0/mujoco/usd/shapes.py +440 -0
  191. mujoco_uni-3.8.0/mujoco/usd/utils.py +28 -0
  192. mujoco_uni-3.8.0/mujoco/util/CMakeLists.txt +97 -0
  193. mujoco_uni-3.8.0/mujoco/util/array_traits.h +140 -0
  194. mujoco_uni-3.8.0/mujoco/util/array_traits_test.cc +95 -0
  195. mujoco_uni-3.8.0/mujoco/util/crossplatform.h +71 -0
  196. mujoco_uni-3.8.0/mujoco/util/func_traits.h +114 -0
  197. mujoco_uni-3.8.0/mujoco/util/func_traits_test.cc +156 -0
  198. mujoco_uni-3.8.0/mujoco/util/func_wrap.h +193 -0
  199. mujoco_uni-3.8.0/mujoco/util/func_wrap_test.cc +102 -0
  200. mujoco_uni-3.8.0/mujoco/util/tuple_tools.h +159 -0
  201. mujoco_uni-3.8.0/mujoco/util/tuple_tools_test.cc +54 -0
  202. mujoco_uni-3.8.0/mujoco/viewer.py +620 -0
  203. mujoco_uni-3.8.0/mujoco/viewer_test.py +28 -0
  204. mujoco_uni-3.8.0/mujoco_uni.egg-info/PKG-INFO +118 -0
  205. mujoco_uni-3.8.0/mujoco_uni.egg-info/SOURCES.txt +209 -0
  206. mujoco_uni-3.8.0/mujoco_uni.egg-info/dependency_links.txt +1 -0
  207. mujoco_uni-3.8.0/mujoco_uni.egg-info/requires.txt +21 -0
  208. mujoco_uni-3.8.0/mujoco_uni.egg-info/top_level.txt +1 -0
  209. mujoco_uni-3.8.0/pyproject.toml +103 -0
  210. mujoco_uni-3.8.0/setup.cfg +4 -0
  211. mujoco_uni-3.8.0/setup.py +515 -0
@@ -0,0 +1,5 @@
1
+ include LICENSE *.md
2
+ recursive-include mujoco *.h *.cc *.cc.inc *.mm CMakeLists.txt *.cmake
3
+ recursive-include mujoco libmujoco*.dylib libmujoco*.so*
4
+ recursive-include mujoco/plugin *
5
+ recursive-include mujoco/mjpython mjpython.* Info.plist
@@ -0,0 +1,118 @@
1
+ Metadata-Version: 2.4
2
+ Name: mujoco-uni
3
+ Version: 3.8.0
4
+ Summary: MuJoCo Physics Simulator (Uni distribution)
5
+ Author: TATP-233
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/TATP-233/mujoco
8
+ Project-URL: Documentation, https://mujoco.readthedocs.io/en/3.8.0
9
+ Project-URL: Repository, https://github.com/TATP-233/mujoco
10
+ Project-URL: Changelog, https://mujoco.readthedocs.io/en/3.8.0/changelog.html
11
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Natural Language :: English
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Topic :: Scientific/Engineering
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ Requires-Dist: absl-py
25
+ Requires-Dist: etils[epath]
26
+ Requires-Dist: glfw
27
+ Requires-Dist: numpy
28
+ Requires-Dist: pyopengl
29
+ Provides-Extra: sysid
30
+ Requires-Dist: absl-py; extra == "sysid"
31
+ Requires-Dist: colorama; extra == "sysid"
32
+ Requires-Dist: imageio[ffmpeg]; extra == "sysid"
33
+ Requires-Dist: jinja2; extra == "sysid"
34
+ Requires-Dist: matplotlib; extra == "sysid"
35
+ Requires-Dist: plotly; extra == "sysid"
36
+ Requires-Dist: pyyaml; extra == "sysid"
37
+ Requires-Dist: scipy; extra == "sysid"
38
+ Requires-Dist: tabulate; extra == "sysid"
39
+ Requires-Dist: typing_extensions; extra == "sysid"
40
+ Provides-Extra: usd
41
+ Requires-Dist: usd-core; extra == "usd"
42
+ Requires-Dist: pillow; extra == "usd"
43
+ Dynamic: description
44
+ Dynamic: description-content-type
45
+
46
+ # MuJoCo Python Bindings
47
+
48
+ [![PyPI Python Version][pypi-versions-badge]][pypi]
49
+ [![PyPI version][pypi-badge]][pypi]
50
+
51
+ [pypi-versions-badge]: https://img.shields.io/pypi/pyversions/mujoco
52
+ [pypi-badge]: https://badge.fury.io/py/mujoco.svg
53
+ [pypi]: https://pypi.org/project/mujoco/
54
+
55
+ This package is the canonical Python bindings for the
56
+ [MuJoCo physics engine](https://github.com/google-deepmind/mujoco).
57
+ These bindings are developed and maintained by Google DeepMind, and is kept
58
+ up-to-date with the latest developments in MuJoCo itself.
59
+
60
+ The `mujoco` package provides direct access to raw MuJoCo C API functions,
61
+ structs, constants, and enumerations. Structs are provided as Python classes,
62
+ with Pythonic initialization and deletion semantics.
63
+
64
+ It is not the aim of this package to provide fully fledged
65
+ scene/environment/game authoring API, as there are already a number of existing
66
+ packages that do this well. However, this package does provide a number of
67
+ lower-level components outside of MuJoCo itself that are likely to be useful to
68
+ most users who access MuJoCo through Python. For example, the `egl`, `glfw`, and
69
+ `osmesa` subpackages contain utilities for setting up OpenGL rendering contexts.
70
+
71
+ ## Installation
72
+
73
+ The recommended way to install this package is via [PyPI](https://pypi.org/project/mujoco/):
74
+
75
+ ```sh
76
+ pip install mujoco
77
+ ```
78
+
79
+ A copy of the MuJoCo library is provided as part of the package and does **not**
80
+ need to be downloaded or installed separately.
81
+
82
+ ### Source
83
+
84
+ **IMPORTANT:** Building from source is only necessary if you are modifying the
85
+ Python bindings (or are trying to run on exceptionally old Linux systems).
86
+ If that's not the case, then we recommend installing the prebuilt binaries from
87
+ PyPI.
88
+
89
+ If you need to build the Python bindings from source, please consult
90
+ [the documentation](https://mujoco.readthedocs.io/en/latest/python.html#building-from-source).
91
+
92
+ ## Usage
93
+
94
+ Once installed, the package can be imported via `import mujoco`. Please consult
95
+ our [documentation](https://mujoco.readthedocs.io/en/stable/python.html) for
96
+ further detail on the package's API.
97
+
98
+ We recommend going through the tutorial notebook which covers the basics of
99
+ MuJoCo using Python:
100
+ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/tutorial.ipynb)
101
+
102
+ ## Versioning
103
+
104
+ The `major.minor.micro` portion of the version number matches the version of
105
+ MuJoCo that the bindings provide. Optionally, if we release updates to the
106
+ Python bindings themselves that target the same version of MuJoCo, a `.postN`
107
+ suffix is added, for example `2.1.2.post2` represents the second update to the
108
+ bindings for MuJoCo 2.1.2.
109
+
110
+ ## License and Disclaimer
111
+
112
+ Copyright 2022 DeepMind Technologies Limited
113
+
114
+ MuJoCo and its Python bindings are licensed under the Apache License,
115
+ Version 2.0. You may obtain a copy of the License at
116
+ https://www.apache.org/licenses/LICENSE-2.0.
117
+
118
+ This is not an officially supported Google product.
@@ -0,0 +1,73 @@
1
+ # MuJoCo Python Bindings
2
+
3
+ [![PyPI Python Version][pypi-versions-badge]][pypi]
4
+ [![PyPI version][pypi-badge]][pypi]
5
+
6
+ [pypi-versions-badge]: https://img.shields.io/pypi/pyversions/mujoco
7
+ [pypi-badge]: https://badge.fury.io/py/mujoco.svg
8
+ [pypi]: https://pypi.org/project/mujoco/
9
+
10
+ This package is the canonical Python bindings for the
11
+ [MuJoCo physics engine](https://github.com/google-deepmind/mujoco).
12
+ These bindings are developed and maintained by Google DeepMind, and is kept
13
+ up-to-date with the latest developments in MuJoCo itself.
14
+
15
+ The `mujoco` package provides direct access to raw MuJoCo C API functions,
16
+ structs, constants, and enumerations. Structs are provided as Python classes,
17
+ with Pythonic initialization and deletion semantics.
18
+
19
+ It is not the aim of this package to provide fully fledged
20
+ scene/environment/game authoring API, as there are already a number of existing
21
+ packages that do this well. However, this package does provide a number of
22
+ lower-level components outside of MuJoCo itself that are likely to be useful to
23
+ most users who access MuJoCo through Python. For example, the `egl`, `glfw`, and
24
+ `osmesa` subpackages contain utilities for setting up OpenGL rendering contexts.
25
+
26
+ ## Installation
27
+
28
+ The recommended way to install this package is via [PyPI](https://pypi.org/project/mujoco/):
29
+
30
+ ```sh
31
+ pip install mujoco
32
+ ```
33
+
34
+ A copy of the MuJoCo library is provided as part of the package and does **not**
35
+ need to be downloaded or installed separately.
36
+
37
+ ### Source
38
+
39
+ **IMPORTANT:** Building from source is only necessary if you are modifying the
40
+ Python bindings (or are trying to run on exceptionally old Linux systems).
41
+ If that's not the case, then we recommend installing the prebuilt binaries from
42
+ PyPI.
43
+
44
+ If you need to build the Python bindings from source, please consult
45
+ [the documentation](https://mujoco.readthedocs.io/en/latest/python.html#building-from-source).
46
+
47
+ ## Usage
48
+
49
+ Once installed, the package can be imported via `import mujoco`. Please consult
50
+ our [documentation](https://mujoco.readthedocs.io/en/stable/python.html) for
51
+ further detail on the package's API.
52
+
53
+ We recommend going through the tutorial notebook which covers the basics of
54
+ MuJoCo using Python:
55
+ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/google-deepmind/mujoco/blob/main/python/tutorial.ipynb)
56
+
57
+ ## Versioning
58
+
59
+ The `major.minor.micro` portion of the version number matches the version of
60
+ MuJoCo that the bindings provide. Optionally, if we release updates to the
61
+ Python bindings themselves that target the same version of MuJoCo, a `.postN`
62
+ suffix is added, for example `2.1.2.post2` represents the second update to the
63
+ bindings for MuJoCo 2.1.2.
64
+
65
+ ## License and Disclaimer
66
+
67
+ Copyright 2022 DeepMind Technologies Limited
68
+
69
+ MuJoCo and its Python bindings are licensed under the Apache License,
70
+ Version 2.0. You may obtain a copy of the License at
71
+ https://www.apache.org/licenses/LICENSE-2.0.
72
+
73
+ This is not an officially supported Google product.