| Name | mink JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | mink: MuJoCo inverse kinematics. |
| upload_time | 2024-09-27 05:38:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
inverse
kinematics
mujoco
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mink
[](https://github.com/kevinzakka/mink/actions)
[](https://coveralls.io/github/kevinzakka/mink?branch=main)
[](https://pypi.org/project/mink/)
mink is a library for differential inverse kinematics in Python, based on the [MuJoCo](https://github.com/google-deepmind/mujoco) physics engine.
Features include:
* Task specification in configuration or operational space;
* Limits on joint positions and velocities;
* Collision avoidance between any geom pair;
* Lie group interface for rigid body transformations.
For usage and API reference, see the [documentation](https://kevinzakka.github.io/mink/).
## Installation
You can install `mink` using `pip`:
```bash
pip install mink
```
To include the example dependencies:
```bash
pip install "mink[examples]"
```
## Examples
mink works with a variety of robots, including:
* Arms: [UR5e](https://github.com/kevinzakka/mink/blob/main/examples/arm_ur5e_actuators.py), [iiwa14](https://github.com/kevinzakka/mink/blob/main/examples/arm_iiwa.py), [bimanual iiwa14](https://github.com/kevinzakka/mink/blob/main/examples/dual_iiwa.py)
* Humanoids: [Unitree G1](https://github.com/kevinzakka/mink/blob/main/examples/humanoid_g1.py), [Unitree H1](https://github.com/kevinzakka/mink/blob/main/examples/humanoid_h1.py)
* Quadrupeds: [Unitree Go1](https://github.com/kevinzakka/mink/blob/main/examples/quadruped_go1.py), [Boston Dynamics Spot](https://github.com/kevinzakka/mink/blob/main/examples/quadruped_spot.py)
* Hands: [Shadow Hand](https://github.com/kevinzakka/mink/blob/main/examples/hand_shadow.py), [Allegro Hand](https://github.com/kevinzakka/mink/blob/main/examples/arm_hand_iiwa_allegro.py)
* Mobile manipulators: [Stanford TidyBot](https://github.com/kevinzakka/mink/blob/main/examples/mobile_tidybot.py), [Hello Robot Stretch](https://github.com/kevinzakka/mink/blob/main/examples/mobile_stretch.py)
Check out the [examples](https://github.com/kevinzakka/mink/blob/main/examples/) directory for more code.
## How can I help?
Install the library, use it and report any bugs in the [issue tracker](https://github.com/kevinzakka/mink/issues) if you find any. If you're feeling adventurous, you can also check out the contributing [guidelines](CONTRIBUTING.md) and submit a pull request.
## Acknowledgements
mink is a direct port of [Pink](https://github.com/stephane-caron/pink) which uses [Pinocchio](https://github.com/stack-of-tasks/pinocchio) under the hood. Stéphane Caron, the author of Pink, is a role model for open-source software in robotics. This library would not have been possible without his work and assistance throughout this project.
mink also heavily adapts code from the following libraries:
* The lie algebra library that powers the transforms in mink is adapted from [jaxlie](https://github.com/brentyi/jaxlie).
* The collision avoidance constraint is adapted from [dm_robotics](https://github.com/google-deepmind/dm_robotics/tree/main/cpp/controllers)'s LSQP controller.
Raw data
{
"_id": null,
"home_page": null,
"name": "mink",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "inverse, kinematics, mujoco",
"author": null,
"author_email": "Kevin Zakka <zakka@berkeley.edu>",
"download_url": "https://files.pythonhosted.org/packages/59/11/4e1bf31755041a61265864b1e2d55eeac6ca5ab3e3162842c910a56ed7ed/mink-0.0.4.tar.gz",
"platform": null,
"description": "# mink\n\n[](https://github.com/kevinzakka/mink/actions)\n[](https://coveralls.io/github/kevinzakka/mink?branch=main)\n[](https://pypi.org/project/mink/)\n\n\nmink is a library for differential inverse kinematics in Python, based on the [MuJoCo](https://github.com/google-deepmind/mujoco) physics engine.\n\nFeatures include:\n\n* Task specification in configuration or operational space;\n* Limits on joint positions and velocities;\n* Collision avoidance between any geom pair;\n* Lie group interface for rigid body transformations.\n\nFor usage and API reference, see the [documentation](https://kevinzakka.github.io/mink/).\n\n## Installation\n\nYou can install `mink` using `pip`:\n\n```bash\npip install mink\n```\n\nTo include the example dependencies:\n\n```bash\npip install \"mink[examples]\"\n```\n\n## Examples\n\nmink works with a variety of robots, including:\n\n* Arms: [UR5e](https://github.com/kevinzakka/mink/blob/main/examples/arm_ur5e_actuators.py), [iiwa14](https://github.com/kevinzakka/mink/blob/main/examples/arm_iiwa.py), [bimanual iiwa14](https://github.com/kevinzakka/mink/blob/main/examples/dual_iiwa.py)\n* Humanoids: [Unitree G1](https://github.com/kevinzakka/mink/blob/main/examples/humanoid_g1.py), [Unitree H1](https://github.com/kevinzakka/mink/blob/main/examples/humanoid_h1.py)\n* Quadrupeds: [Unitree Go1](https://github.com/kevinzakka/mink/blob/main/examples/quadruped_go1.py), [Boston Dynamics Spot](https://github.com/kevinzakka/mink/blob/main/examples/quadruped_spot.py)\n* Hands: [Shadow Hand](https://github.com/kevinzakka/mink/blob/main/examples/hand_shadow.py), [Allegro Hand](https://github.com/kevinzakka/mink/blob/main/examples/arm_hand_iiwa_allegro.py)\n* Mobile manipulators: [Stanford TidyBot](https://github.com/kevinzakka/mink/blob/main/examples/mobile_tidybot.py), [Hello Robot Stretch](https://github.com/kevinzakka/mink/blob/main/examples/mobile_stretch.py)\n\nCheck out the [examples](https://github.com/kevinzakka/mink/blob/main/examples/) directory for more code.\n\n## How can I help?\n\nInstall the library, use it and report any bugs in the [issue tracker](https://github.com/kevinzakka/mink/issues) if you find any. If you're feeling adventurous, you can also check out the contributing [guidelines](CONTRIBUTING.md) and submit a pull request.\n\n## Acknowledgements\n\nmink is a direct port of [Pink](https://github.com/stephane-caron/pink) which uses [Pinocchio](https://github.com/stack-of-tasks/pinocchio) under the hood. St\u00e9phane Caron, the author of Pink, is a role model for open-source software in robotics. This library would not have been possible without his work and assistance throughout this project.\n\nmink also heavily adapts code from the following libraries:\n\n* The lie algebra library that powers the transforms in mink is adapted from [jaxlie](https://github.com/brentyi/jaxlie).\n* The collision avoidance constraint is adapted from [dm_robotics](https://github.com/google-deepmind/dm_robotics/tree/main/cpp/controllers)'s LSQP controller.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "mink: MuJoCo inverse kinematics.",
"version": "0.0.4",
"project_urls": {
"Changelog": "https://github.com/kevinzakka/mink/blob/main/CHANGELOG.md",
"Source": "https://github.com/kevinzakka/mink",
"Tracker": "https://github.com/kevinzakka/mink/issues"
},
"split_keywords": [
"inverse",
" kinematics",
" mujoco"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38079f37fe9d887a01b77f57189d0f4cc4c1fd10050ff858d3fa023c6e5b7f77",
"md5": "422837b2257c0892e062ab8606fae829",
"sha256": "1efcb8eaa0ff978840ebc7c114c34932f9d68bacb9b3a0eabf24087aa568c502"
},
"downloads": -1,
"filename": "mink-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "422837b2257c0892e062ab8606fae829",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 896577,
"upload_time": "2024-09-27T05:38:49",
"upload_time_iso_8601": "2024-09-27T05:38:49.572923Z",
"url": "https://files.pythonhosted.org/packages/38/07/9f37fe9d887a01b77f57189d0f4cc4c1fd10050ff858d3fa023c6e5b7f77/mink-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "59114e1bf31755041a61265864b1e2d55eeac6ca5ab3e3162842c910a56ed7ed",
"md5": "d4a02d8411229ae43dd63fbd646ad870",
"sha256": "fd53d8b1c3e2e6a940899eaad1ec22578a11282308b25f0cc641e28cdd71f0bc"
},
"downloads": -1,
"filename": "mink-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "d4a02d8411229ae43dd63fbd646ad870",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 678615,
"upload_time": "2024-09-27T05:38:52",
"upload_time_iso_8601": "2024-09-27T05:38:52.167915Z",
"url": "https://files.pythonhosted.org/packages/59/11/4e1bf31755041a61265864b1e2d55eeac6ca5ab3e3162842c910a56ed7ed/mink-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 05:38:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kevinzakka",
"github_project": "mink",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mink"
}
