Skip to content

gdsofa

gdsofa is a lightweight Python library for building and running SOFA (Simulation Open Framework Architecture) scenes programmatically. It provides a scene graph API (nodes, components, parameters, controllers) and a runner for headless or GUI simulations.

Requirements

  • Python 3.12 (same as SOFAPython3 version)
  • A SOFA build: set the SOFA_ROOT environment variable to your SOFA build directory.

Installation

pip install gd-sofa-utils

Quick start

Build a minimal scene, attach parameters, and run it (GUI or headless):

import gdsofa as gs

root = gs.RootNode()
root + gs.DefaultAnimationLoop()

params = gs.BaseSOFAParams(out_dir="/path/to/out")
sofa = gs.RunSofa(root, params)
sofa.run(gui=True)

Next steps:

  • User guide — requirements, scene graph, parameters, controllers, running.
  • API Reference — full API documentation.