Welcome to the offical OPynSim documentation pages 👋

OPynSim is a python-native API for musculoskeletal modeling that doesn’t compromise on nearly 20 years of research and feature development in musculoskeletal modelling.

To get started, see the Installation page. After that, we recommend going through the Quickstart guide in order to get familiar with the Python API.

Table of Contents

Getting Started

• Installation
  • pip
  • uv
  • Anaconda/Miniconda/Miniforge
  • Supported Platforms
• Quickstart
  • Import opynsim
  • Read an osim File
  • Compile a Specification into a Model
  • Create and Realize an Initial State of the Model
  • Visualize the Model in a State
  • Render Visualization to an Image File

Concepts

• Configuration
  • Logging
  • Resource Search Path
• Graphics
• Modelling
  • Typical Modelling Workflow
• Thin-Plate Spline (TPS) Warping
  • Overview
  • API Usage
  • Implementation Notes
  • Relevant Literature
• User Interfaces

Examples

• Overlay Model Over Plot
• Plot Model Output vs. Property
• Render Model to PNG
• Render Motion to Video File
• Show Model in State

opynsim

Development

• Architecture Overview
• CLion Setup
  • Download and Install Python
  • Download and Install CLion
  • Use CLion to get OPynSim from GitHub
  • Select Toolchain
  • Select Third-Party Development Build Profile
• OPynSim As a C++ Library
  • Doxygen Documentation
  • Walkthrough
• Unofficial Doxygen Reference
• OpenSim Interoperability
  • File Format Interoperability
• The Release Process
  • Release Checklist (Markdown)

Other Links

• OPynSim GitHub
• OpenSim Creator

• C++ API documentation