OPynSim Documentation#

TODO: work in progress! This is just here to ensure the top-level build infrastructure is in place

Table of Contents#

Getting Started

• Installation
• Quickstart

API

• Configuration
• Modelling
• Application
• Graphics
• User Interface
• Thin-Plate Spline (TPS) Warping

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
• Visual Studio Setup
  • Download and Install Visual Studio
  • Open OPynSim in Visual Studio
  • Setup Python Virtual Environment
  • Setup Terminal Environment
  • Build OPynSim’s C++ Dependencies
  • Build OPynSim
  • Developing Python for OPynSim in Visual Studio
  • Developing C++ for OPynSim in Visual Studio
• Contributing to OpenSim
• Creating a Patch from OPynSim
• Updating Documentation
• OPynSim As a C++ Library
  • Doxygen Documentation
  • Walkthrough
  • Basic Model Rendering Example

Other Links

• OPynSim GitHub

• C++ API documentation