Version 2.1: documentation, public API headers, and sample programs.

PiperOrigin-RevId: 403900419

Author: saran-t

.readthedocs.yml

@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+  builder: html
+  configuration: doc/conf.py
+  fail_on_warning: false
+
+python:
+  version: 3.7
+  install:
+    - requirements: doc/requirements.txt
+

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How to Contribute
+
+We are in the process of preparing the MuJoCo codebase for open-sourcing.
+When that happens, we will be grateful to receive your contributions.
+Until then, you are welcome to participate in discussions, post
+issues on our tracker, or send us pull requests to improve the sample program
+code or documentation.
+
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution,
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
+
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
+
+## Code reviews
+
+All submissions require review. Please use GitHub pull requests for this
+purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on pull requests.

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,106 @@
+# MuJoCo Physics
+
+**MuJoCo** stands for **Mu**lti-**Jo**int dynamics with **Co**ntact. It is a
+general purpose physics engine that aims to facilitate research and development
+in robotics, biomechanics, graphics and animation, machine learning, and other
+areas which demand fast and accurate simulation of articulated structures
+interacting with their environment.
+
+DeepMind has acquired MuJoCo, and we are currently making preparations to open
+source the codebase. In the meantime, MuJoCo is available for download as a free
+and unrestricted precompiled binary under the Apache 2.0 license from
+[mujoco.org](https://mujoco.org/).
+
+MuJoCo's source code will be released through this GitHub repository once it is
+ready. In the meantime, the repository hosts MuJoCo's documentation, C header
+files for its public API, and sample program code. If you wish to report bugs or
+make feature requests, please file them as [GitHub Issues]. You are also
+welcome to make pull requests for the [documentation source files].
+
+## Overview
+
+MuJoCo is a C/C++ library with a C API, intended for researchers and developers.
+The runtime simulation module is tuned to maximize performance and operates on
+low-level data structures which are preallocated by the built-in XML parser and
+compiler. The user defines models in the native MJCF scene description language
+-- an XML file format designed to be as human readable and editable as possible.
+URDF model files can also be loaded. The library includes interactive
+visualization with a native GUI, rendered in OpenGL. MuJoCo further exposes a
+large number of utility functions for computing physics-related quantities, not
+necessarily in a simulation loop. Features include
+
+-   Simulation in generalized coordinates, avoiding joint violations.
+
+-   Inverse dynamics that are well-defined even in the presence of contacts.
+
+-   Unified continuous-time formulation of constraints via convex optimization.
+
+-   Constraints include soft contacts, limits, dry friction, equality
+    constraints.
+
+-   Simulation of particle systems, cloth, rope and soft objects.
+
+-   Actuators including motors, cylinders, muscles, tendons, slider-cranks.
+
+-   Choice of Newton, Conjugate Gradient, or Projected Gauss-Seidel solvers.
+
+-   Choice of pyramidal or elliptic friction cones, dense or sparse Jacobians.
+
+-   Choice of Euler or Runge-Kutta numerical integrators.
+
+-   Multi-threaded sampling and finite-difference approximations.
+
+-   Intuitive XML model format (called MJCF) and built-in model compiler.
+
+-   Cross-platform GUI with interactive 3D visualization in OpenGL.
+
+-   Run-time module written in ANSI C and hand-tuned for performance.
+
+
+## Requirements
+
+MuJoCo binaries are currently built for Linux, macOS (Intel), and Windows.
+
+
+## Documentation
+
+MuJoco's current documentation is available at [mujoco.org/book], which is
+serving Sphinx-based webpages derived from the ReStructuredText
+[documentation source files].
+
+
+## Citation
+
+If you use MuJoCo for published research, please cite:
+
+```
+@inproceedings{todorov2012mujoco,
+  title={Mujoco: A physics engine for model-based control},
+  author={Todorov, Emanuel and Erez, Tom and Tassa, Yuval},
+  booktitle={2012 IEEE/RSJ International Conference on Intelligent Robots and Systems},
+  pages={5026--5033},
+  year={2012},
+  organization={IEEE}
+}
+```
+
+
+## License and Disclaimer
+
+Copyright 2021 DeepMind Technologies Limited
+
+ReStructuredText documents, images, and videos in the `doc` directory are made
+available under the terms of the Creative Commons Attribution 4.0 (CC BY 4.0)
+license. You may obtain a copy of the License at
+https://creativecommons.org/licenses/by/4.0/legalcode.
+
+Source code is licensed under the Apache License, Version 2.0. You may obtain a
+copy of the License at https://www.apache.org/licenses/LICENSE-2.0.
+
+This is not an officially supported Google product.
+
+
+[GitHub Issues]: https://github.com/deepmind/mujoco/issues
+[documentation source files]: https://github.com/deepmind/mujoco/tree/main/doc
+[mujoco.org/book]: https://mujoco.org/book
+