Skip to main content

Musculoskeletal environments simulated in MuJoCo

Project description

Support Ukraine PyPI Documentation Status PyPI - License PRs Welcome Downloads Open In Colab Slack Twitter Follow

MyoSuite is a collection of musculoskeletal environments and tasks simulated with the MuJoCo physics engine and wrapped in the OpenAI gym API to enable the application of Machine Learning to bio-mechanic control problems.

Documentation | Tutorials | Task specifications

Below is an overview of the tasks in the MyoSuite.

TasksALL

Installations

You will need Python 3.9 or later versions.

It is recommended to use Miniconda and to create a separate environment with:

conda create --name myosuite python=3.9
conda activate myosuite

It is possible to install MyoSuite with:

pip install -U myosuite

for advanced installation, see here.

Test your installation using the following command (this will return also a list of all the current environments):

python -m myosuite.tests.test_myo

You can also visualize the environments with random controls using the command below:

python -m myosuite.utils.examine_env --env_name myoElbowPose1D6MRandom-v0

NOTE: On MacOS, we moved to mujoco native launch_passive which requires that the Python script be run under mjpython:

mjpython -m myosuite.utils.examine_env --env_name myoElbowPose1D6MRandom-v0

It is possible to take advantage of the latest MyoSkeleton. Once added (follow the instructions prompted by python -m myosuite_init), run:

python -m myosuite.utils.examine_sim -s myosuite/simhive/myo_model/myoskeleton/myoskeleton.xml

Examples

It is possible to create and interface with MyoSuite environments just like any other OpenAI gym environments. For example, to use the myoElbowPose1D6MRandom-v0 environment, it is possible simply to run: Open In Colab

from myosuite.utils import gym
env = gym.make('myoElbowPose1D6MRandom-v0')
env.reset()
for _ in range(1000):
  env.mj_render()
  env.step(env.action_space.sample()) # take a random action
env.close()

You can find our tutorials on the general features and the ICRA2023 Colab Tutorial Open In Colab ICRA2024 Colab Tutorial Open In Colab on how to load MyoSuite models/tasks, train them, and visualize their outcome. Also, you can find baselines to test some pre-trained policies.

License

MyoSuite is licensed under the Apache License.

Citation

If you find this repository useful in your research, please consider giving a star ⭐ and cite our arXiv paper by using the following BibTeX entrys.

@Misc{MyoSuite2022,
  author =       {Vittorio, Caggiano AND Huawei, Wang AND Guillaume, Durandau AND Massimo, Sartori AND Vikash, Kumar},
  title =        {MyoSuite -- A contact-rich simulation suite for musculoskeletal motor control},
  publisher = {arXiv},
  year = {2022},
  howpublished = {\url{https://github.com/myohub/myosuite}},
  year =         {2022}
  doi = {10.48550/ARXIV.2205.13600},
  url = {https://arxiv.org/abs/2205.13600},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

myosuite-2.11.6.tar.gz (89.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

myosuite-2.11.6-py3-none-any.whl (90.1 MB view details)

Uploaded Python 3

File details

Details for the file myosuite-2.11.6.tar.gz.

File metadata

  • Download URL: myosuite-2.11.6.tar.gz
  • Upload date:
  • Size: 89.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for myosuite-2.11.6.tar.gz
Algorithm Hash digest
SHA256 926b7b5853cb1cf6a53f405a4f73e046f9179fdaa8a0a15ab7ff4799f7b91df7
MD5 1bd562f1a05eb756db376066a9e73da7
BLAKE2b-256 20140717ee6d09dc7c02604602995711f09f33c89c50e1a79b198126018e2220

See more details on using hashes here.

File details

Details for the file myosuite-2.11.6-py3-none-any.whl.

File metadata

  • Download URL: myosuite-2.11.6-py3-none-any.whl
  • Upload date:
  • Size: 90.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for myosuite-2.11.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e15af1d60aa2e9d6bd6a849ae1c7f9750da96158d4ae78b6d2dcdeb22b9ab7c1
MD5 82b42e88675176dc3f3872fc3469dd57
BLAKE2b-256 061dc3d40af84df43d9b77f7688bdbfa8c3fd83c988b096daa235eec7d68f6fc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page