LLM Guides

This section contains documentation specifically designed for Large Language Models (LLMs) to understand and work with ParamML and the OpenBrIM platform.

These guides provide structured context that helps AI assistants generate accurate ParamML code, understand the platform's capabilities, and assist developers with engineering workflows.

Contents

Core Documentation

• ParamML README - Overview of ParamML language and syntax

• Core Objects - Reference for core ParamML object types

• Component Instances - Working with component instances

• Export - Exporting data and models

• Extends - Object inheritance and extension patterns

• ParamML Functions Reference - Complete function reference

Feature Guides

• Parametric Engine Guide - Understanding the parametric engine

• 3D Visualization Guide - Creating 3D visualizations

• Bridge Alignment Guide - Working with bridge alignments

• Bridge Workflow Generation Guide - Generating bridge workflows

• CADD Drawing Guide - Creating CAD drawings

• Document Generation Guide - Generating documents

• FEA Guide - Finite Element Analysis setup

• FEA Results Guide - Working with FEA results