User Guide#

This guide covers the core concepts and practical workflows for volmdlr_tools. Start with the foundational concepts, then explore domain-specific guides based on your use case.

Core Concepts

Essential foundation for understanding graph-based CAD analysis. Start here to learn about Graph, AAG, and GraphAssembly.

To core concepts

Assembly Analysis

Analyze CAD assemblies: graphs, joints, kinematics, and clearances.

To assembly analysis

Shape Analysis

Recognize features, classify shapes, and process sheet metal parts.

To shape analysis

Shape Editing

Simplify CAD models by removing fillets, chamfers, and cavities. Track shape evolution through defeaturing operations.

To shape editing

Learning Path#

For new users, we recommend following this learning path:

  1. Getting Started - Installation and basic usage

  2. Core Concepts - Understand Graph, AAG, and GraphAssembly

  3. Choose Your Domain:

    • For assembly work: Assembly Analysis (kinematics, joints, clearances)

    • For part analysis: Shape Analysis (features, classification, sheet metal)

    • For model simplification: Shape Editing (defeaturing, history tracking)

  4. API Reference - Detailed class and method documentation

On this page