Abaqus Documentation Skill

SkillDocs & knowledge

Download and manage abqpy API documentation. Use when user asks about API documentation, API reference, or downloading Abaqus docs.

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the Abaqus Documentation Skill skill

What this skill tells your AI

The instructions your AI receives, as published by cai-aa/cae-agent-hub in Skill/abaqus/setup/abaqus-docs/SKILL.md and read by ahel’s review.

Navigate and access Abaqus Python API documentation for parameter lookups and method reference.

When to Use This Skill

Route here when user asks:

  • "Where is the API documentation?"
  • "What parameters does X take?"
  • "What methods are available for Material/Part/Mesh?"
  • "Show me the API reference for..."
  • "Download/refresh the docs"

Route elsewhere:

  • Learning concepts or workflows -> specific analysis skills
  • Running analyses -> /abaqus-static-analysis, /abaqus-dynamic-analysis, etc.
  • Quick code examples -> module-specific skills like /abaqus-material

Documentation Location

All API documentation is pre-downloaded at:

.claude/docs/abaqus-api/modules/

Module Index

TaskDocumentation File
Model databasemodules/mdb.md
Model internalsmodules/mdb_model.md
Part creationmodules/part.md
2D sketchingmodules/sketcher.md
Assembly/instancesmodules/assembly.md
Material propertiesmodules/material.md
Section propertiesmodules/property.md
Meshingmodules/mesh.md
Analysis stepsmodules/step.md
Loadsmodules/load.md
Boundary conditionsmodules/bc.md
Contact/tiesmodules/interaction.md
Time-varying definitionsmodules/amplitude.md
Initial/predefined fieldsmodules/field.md
Output requestsmodules/output.md
Topology optimizationmodules/optimization.md
Job managementmodules/job.md
Results accessmodules/odb.md

How to Use

Answering API Questions

  1. Identify which module the user needs from the index above
  2. Read the relevant documentation file
  3. Extract specific method signatures, parameters, or examples

Common Lookups

User Asks AboutRead This Module
Creating geometrypart.md, sketcher.md
Positioning partsassembly.md
Defining materialsmaterial.md
Creating sectionsproperty.md
Generating meshmesh.md
Setting up analysisstep.md
Applying forcesload.md
Fixing supportsbc.md
Defining contactinteraction.md
Running analysisjob.md
Extracting resultsodb.md

Refreshing Documentation

If documentation is missing or outdated:

  1. Run the download script at .claude/skills/abaqus-docs/scripts/download_abqpy_docs.py
  2. Use --force flag to overwrite existing files

Documentation Sources

Code Patterns

For actual API syntax and code examples, see:

  • references/api-quick-ref.md
  • references/common-patterns.md

Signals

GitHub stars
880
Forks
115
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
abaqus-docs
Source
github.com/cai-aa/cae-agent-hub