OpenSim Creator Documentation

OpenSim Creator is a UI for building OpenSim models. These pages are the official documentation for OpenSim Creator, where you can find installation instructions, tutorials that cover specific workflows/features, the development guide, and other related links.

Fig. 1 Screenshot of OpenSim Creator’s osim editor workflow.

Table of Contents

Setup

• 1. Installation
  • 1.1. Installing on Windows (10 or newer)
  • 1.2. Installing on MacOS (Sonoma 14.5 or newer)
  • 1.3. Installing on Ubuntu (22.04 or newer)
  • 1.4. Building from Source

Tutorials

• 1. Make a Pendulum
  • 1.1. Prerequisites
  • 1.2. Topics Covered by this Tutorial
  • 1.3. Create a New Model
  • 1.4. Add a Body with a WeldJoint
  • 1.5. Reposition the Body
  • 1.6. Add the Pendulum Head
  • 1.7. Pre-Swing the Pendulum Head
  • 1.8. Simulate the Model
  • 1.9. (optional) Make the Pendulum Look Nicer
  • 1.10. (Optional) Extra Exercises
  • 1.11. Next Steps
• 2. Make a Bouncing Block
  • 2.1. Prerequisites
  • 2.2. Topics Covered by this Tutorial
  • 2.3. Create the Foot
  • 2.4. Add Contact Surfaces & Forces
  • 2.5. Attach the Knee & Head to the Foot
  • 2.6. Add a Spring between foot and head
  • 2.7. Constrain foot and head to stay along Y
  • 2.8. (Optional) Extra Exercises
  • 2.9. Next Steps
• 3. The Mesh Importer
  • 3.1. Prerequisites
  • 3.2. Topics Covered by this Tutorial
  • 3.3. Open the Mesh Importer
  • 3.4. Add Bodies & PinJoints
  • 3.5. Add Decorative Geometry
  • 3.6. Export and Simulate
  • 3.7. (Optional) Extra Exercises
  • 3.8. Next Steps
• 4. The Mesh Importer (Advanced)
  • 4.1. Prerequisites
  • 4.2. Topics Covered by this Tutorial
  • 4.3. Import Meshes
  • 4.4. Add Bodies to the Meshes
  • 4.5. Assign Unassigned Meshes to Appropriate Bodies
  • 4.6. Add Joints Between the Bodies
  • 4.7. Mark Points of Interest on the Meshes
  • 4.8. Convert to an OpenSim Model
  • 4.9. Add Muscle Paths
  • 4.10. Summary
  • 4.11. (Optional) Extra Exercises
• 5. The Mesh Warper
  • 5.1. Prerequisites
  • 5.2. Topics Covered by this Tutorial
  • 5.3. The Thin-Plate Spline (TPS) Technique
  • 5.4. Opening the Mesh Warping UI
  • 5.5. Mesh Warping UI Overview
  • 5.6. Walkthrough: Warping a Pelvis
  • 5.7. Next Steps
  • 5.8. Relevant References
• 6. Preview Experimental Data
  • 6.1. Prerequisites
  • 6.2. Topics Covered by this Tutorial
  • 6.3. Opening the Preview Experimental Data UI
  • 6.4. Preview Experimental Data UI Overview
  • 6.5. Walkthrough: Markers to Motion
  • 6.6. Summary
  • 6.7. (Optional) Extra Exercises
• 7. Station Defined Frames
  • 7.1. Overview
  • 7.2. Example Walkthrough
• 8. Make a Lower Leg
  • 8.1. Prerequisites
  • 8.2. Topics Covered by this Tutorial
  • 8.3. Download Resources
  • 8.4. Create a New Model
  • 8.5. Add a pelvis Body
  • 8.6. Attach Pelvis Meshes to the pelvis Body
  • 8.7. Import Pelvis Landmarks
  • 8.8. Add a StationDefinedFrame on pelvis for the Pelvis Frame
  • 8.9. Reassign pelvis_to_ground to the StationDefinedFrame
  • 8.10. Add a StationDefinedFrame on pelvis for the Hip Joint
  • 8.11. Add a Femur Body
  • 8.12. Import Femur Landmarks
  • 8.13. Add a StationDefinedFrame on femur_r for the Hip Joint
  • 8.14. Reassign hip_r’s Child Frame to the StationDefinedFrame
  • 8.15. Add a StationDefinedFrame on femur_r for the Knee Joint
  • 8.16. Add a Tibia Body
  • 8.17. Import Tibia Landmarks
  • 8.18. Add Muscles
  • 8.19. Add a Knee Wrap Cylinder Wrap Surface
  • 8.20. Associate the Muscle with the Wrap Surface
  • 8.21. Minimal Modelling Steps Complete!
  • 8.22. Optional: Clean up the Model
  • 8.23. Final Model
  • 8.24. Summary
  • 8.25. Next Steps
• 9. The Model Warper
  • 9.1. Prerequisites
  • 9.2. Topics Covered by this Tutorial
  • 9.3. Technical Overview
  • 9.4. Walkthrough

Development

• 1. Building From Source
  • 1.1. Building on Windows (10 or newer)
  • 1.2. Building on MacOS (Sonoma or newer)
  • 1.3. Building on Ubuntu (22.04 or newer)
• 2. Development Environment
  • 2.1. Visual Studio 2022
  • 2.2. QtCreator
• 3. Contributing
  • 3.1. Key Points
• 4. The Release Process
  • 4.1. Release Checklist (Markdown)
  • 4.2. Release Build Matrix

Other Links

• OpenSim Creator GitHub
• OpenSim Creator Forum
• OpenSim Creator Bug Tracker
• OpenSim GitHub
• OpenSim Documentation

Indices and tables

• Index

• Search Page