Welcome to SlicerSOFA’s documentation!

Contents:

• 1. Features
  • 1.1. Overview
  • 1.2. Design goals
  • 1.3. Acknowledgments
• 2. Getting Started
  • 2.1. Pre-requisites
  • 2.2. Recommended environment
  • 2.3. Cloning
  • 2.4. Building overview
  • 2.5. Basic build example (using SuperBuild)
  • 2.6. Loading the module into Slicer
  • 2.7. Quick start with Python
• 3. Integration design
  • 3.1. Goals
  • 3.2. Key ideas
  • 3.3. C++ vs Python
  • 3.4. Typical workflow
  • 3.5. Example Python usage
  • 3.6. Threading and execution model
  • 3.7. Extending mappings
• 4. Slicer modules and MRML nodes
  • 4.1. Module layout
  • 4.2. MRML nodes
  • 4.3. Python API examples
  • 4.4. C++ usage
• 5. SoftTissueSimulation
  • 5.1. Overview
  • 5.2. Resources
  • 5.3. Usage example (Python)
  • 5.4. Tips
  • 5.5. Extending scenes
• 6. SparseGridSimulation
  • 6.1. Overview
  • 6.2. What it provides
  • 6.3. Usage
  • 6.4. Notes
• 7. SOFASceneLoader
  • 7.1. Overview
  • 7.2. UI controls
  • 7.3. Scene file requirements
  • 7.4. Auto-mapping mechanism
  • 7.5. Currently auto-mapped component types
  • 7.6. Example scene file
  • 7.7. Workflow
  • 7.8. Reset behaviour
  • 7.9. Extending auto-mapping
• 8. SuperBuild and dependencies
  • 8.1. Purpose
  • 8.2. Configuration
  • 8.3. Building with SuperBuild
  • 8.4. Using an external SOFA
  • 8.5. Common issues
• 9. Tests
  • 9.1. Unit and integration tests
  • 9.2. Running tests
  • 9.3. Python tests from inside Slicer
  • 9.4. Notes
• 10. Limitations and Caveats
  • 10.1. Known caveats
  • 10.2. Missing features (future work)
• 11. Links

Indices and tables

• :ref:=genindex=

• :ref:=modindex=

• :ref:=search=