mujoco-robot 0.0.1__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.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Saif Sidhik
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,89 @@
1
+ Metadata-Version: 2.4
2
+ Name: mujoco_robot
3
+ Version: 0.0.1
4
+ Summary: A general Python interface class for robot simulations using MuJoCo.
5
+ Author-email: Saif Sidhik <mail@saifsidhik.page>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/justagist/mujoco_robot
8
+ Project-URL: Bug Tracker, https://github.com/justagist/mujoco_robot/issues
9
+ Project-URL: Documentation, https://github.com/justagist/mujoco_robot/blob/main/README.md
10
+ Project-URL: Source Code, https://github.com/justagist/mujoco_robot
11
+ Keywords: mujoco,robotics,simulation,inverse kinematics,robot control,python
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
+ Classifier: Topic :: Scientific/Engineering
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3 :: Only
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Requires-Python: >=3.10
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ Requires-Dist: robot-descriptions<3,>=2.0
27
+ Requires-Dist: numpy<3,>=1.24
28
+ Requires-Dist: scipy<2,>=1.14
29
+ Requires-Dist: mujoco>=3.2
30
+ Provides-Extra: test
31
+ Requires-Dist: pytest; extra == "test"
32
+ Provides-Extra: dev
33
+ Requires-Dist: pytest; extra == "dev"
34
+ Requires-Dist: ruff; extra == "dev"
35
+ Requires-Dist: build; extra == "dev"
36
+ Dynamic: license-file
37
+
38
+ # MuJoCo Robot
39
+
40
+ > 🚧 **Work in progress.**
41
+
42
+ A general Python interface for robot simulations using [MuJoCo](https://mujoco.org). Its public
43
+ API mirrors [`pybullet_robot`](https://github.com/justagist/pybullet_robot) so that controllers
44
+ written against that backend can be run here with minimal changes.
45
+
46
+ `MujocoRobot` gives you a single object to load, introspect, control, and read state from a robot,
47
+ implemented directly on `MjModel` + `MjData`.
48
+
49
+ ## Installation
50
+
51
+ > Requires Python >= 3.10 and `mujoco >= 3.2`.
52
+
53
+ ### From source
54
+
55
+ ```bash
56
+ git clone https://github.com/justagist/mujoco_robot
57
+ cd mujoco_robot
58
+ pip install -e .
59
+ ```
60
+
61
+ ## Development
62
+
63
+ ```bash
64
+ pip install -e ".[dev]" # test + lint + build tooling
65
+ ruff check .
66
+ pytest -q
67
+ ```
68
+
69
+ ## Design notes
70
+
71
+ - **Quaternions:** the external API uses `[x, y, z, w]` (scipy convention); values are converted to
72
+ MuJoCo's `[w, x, y, z]` only at the boundary.
73
+ - **Angles:** joint positions, velocities, and limits are in radians. A compiled model always
74
+ stores radians regardless of the MJCF `compiler angle` setting, so no conversion is done.
75
+ - **Backend:** pure `MjModel` + `MjData` (no client-server). Pass an existing `(model, data)` to
76
+ wrap a robot that is already part of a scene.
77
+ - **End-effector frame:** a body by default; a site can be used optionally.
78
+ - **Control:** writes `data.ctrl` when the model has actuators, otherwise falls back to
79
+ `data.qfrc_applied` with a Python PD loop.
80
+ - **Fixed vs floating base:** a structural free joint (added via `MjSpec`), not a load-time flag.
81
+
82
+ ## Status
83
+
84
+ Work in progress, built up in phases. Panda (from `robot_descriptions`) is the reference test
85
+ robot.
86
+
87
+ ## License
88
+
89
+ MIT (c) Saif Sidhik
@@ -0,0 +1,52 @@
1
+ # MuJoCo Robot
2
+
3
+ > 🚧 **Work in progress.**
4
+
5
+ A general Python interface for robot simulations using [MuJoCo](https://mujoco.org). Its public
6
+ API mirrors [`pybullet_robot`](https://github.com/justagist/pybullet_robot) so that controllers
7
+ written against that backend can be run here with minimal changes.
8
+
9
+ `MujocoRobot` gives you a single object to load, introspect, control, and read state from a robot,
10
+ implemented directly on `MjModel` + `MjData`.
11
+
12
+ ## Installation
13
+
14
+ > Requires Python >= 3.10 and `mujoco >= 3.2`.
15
+
16
+ ### From source
17
+
18
+ ```bash
19
+ git clone https://github.com/justagist/mujoco_robot
20
+ cd mujoco_robot
21
+ pip install -e .
22
+ ```
23
+
24
+ ## Development
25
+
26
+ ```bash
27
+ pip install -e ".[dev]" # test + lint + build tooling
28
+ ruff check .
29
+ pytest -q
30
+ ```
31
+
32
+ ## Design notes
33
+
34
+ - **Quaternions:** the external API uses `[x, y, z, w]` (scipy convention); values are converted to
35
+ MuJoCo's `[w, x, y, z]` only at the boundary.
36
+ - **Angles:** joint positions, velocities, and limits are in radians. A compiled model always
37
+ stores radians regardless of the MJCF `compiler angle` setting, so no conversion is done.
38
+ - **Backend:** pure `MjModel` + `MjData` (no client-server). Pass an existing `(model, data)` to
39
+ wrap a robot that is already part of a scene.
40
+ - **End-effector frame:** a body by default; a site can be used optionally.
41
+ - **Control:** writes `data.ctrl` when the model has actuators, otherwise falls back to
42
+ `data.qfrc_applied` with a Python PD loop.
43
+ - **Fixed vs floating base:** a structural free joint (added via `MjSpec`), not a load-time flag.
44
+
45
+ ## Status
46
+
47
+ Work in progress, built up in phases. Panda (from `robot_descriptions`) is the reference test
48
+ robot.
49
+
50
+ ## License
51
+
52
+ MIT (c) Saif Sidhik
@@ -0,0 +1,11 @@
1
+ from importlib.metadata import PackageNotFoundError, version
2
+
3
+ from .mujoco_robot import MujocoRobot
4
+
5
+ try:
6
+ __version__ = version("mujoco_robot")
7
+ except PackageNotFoundError:
8
+ # package not installed (e.g. running from a source checkout)
9
+ __version__ = "0.0.0"
10
+
11
+ __all__ = ["MujocoRobot", "__version__"]