abaqus-docs
Download and manage abqpy API documentation. Use when user asks about API documentation, API reference, or downloading Abaqus docs.
Best use case
abaqus-docs is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Download and manage abqpy API documentation. Use when user asks about API documentation, API reference, or downloading Abaqus docs.
Teams using abaqus-docs should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/abaqus-docs/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How abaqus-docs Compares
| Feature / Agent | abaqus-docs | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Download and manage abqpy API documentation. Use when user asks about API documentation, API reference, or downloading Abaqus docs.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Abaqus Documentation Skill 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 | Task | Documentation File | |------|-------------------| | Model database | `modules/mdb.md` | | Model internals | `modules/mdb_model.md` | | Part creation | `modules/part.md` | | 2D sketching | `modules/sketcher.md` | | Assembly/instances | `modules/assembly.md` | | Material properties | `modules/material.md` | | Section properties | `modules/property.md` | | Meshing | `modules/mesh.md` | | Analysis steps | `modules/step.md` | | Loads | `modules/load.md` | | Boundary conditions | `modules/bc.md` | | Contact/ties | `modules/interaction.md` | | Time-varying definitions | `modules/amplitude.md` | | Initial/predefined fields | `modules/field.md` | | Output requests | `modules/output.md` | | Topology optimization | `modules/optimization.md` | | Job management | `modules/job.md` | | Results access | `modules/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 About | Read This Module | |-----------------|------------------| | Creating geometry | `part.md`, `sketcher.md` | | Positioning parts | `assembly.md` | | Defining materials | `material.md` | | Creating sections | `property.md` | | Generating mesh | `mesh.md` | | Setting up analysis | `step.md` | | Applying forces | `load.md` | | Fixing supports | `bc.md` | | Defining contact | `interaction.md` | | Running analysis | `job.md` | | Extracting results | `odb.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 - **Primary**: https://hailin.wang/abqpy/en/2025/reference/ - **GitHub**: https://github.com/haiiliin/abqpy ## Code Patterns For actual API syntax and code examples, see: - `references/api-quick-ref.md` - `references/common-patterns.md`
Related Skills
add-neon-docs
Use this skill when the user asks to add documentation, add docs, add references, or install documentation about Neon. Adds Neon best practices reference links to project AI documentation (CLAUDE.md, AGENTS.md, or Cursor rules). Does not install packages or modify code.
abaqus
Master skill for Abaqus FEA scripting. Use for any finite element analysis, topology optimization, or Abaqus Python scripting task. Routes to appropriate specialized skills.
abaqus-topology-optimization
Complete workflow for topology optimization using Tosca. Use to minimize weight while maintaining stiffness. Requires full Abaqus license (not Learning Edition).
abaqus-thermal-analysis
Complete workflow for heat transfer analysis - steady-state and transient thermal. Use when user asks about temperature distribution, conduction, convection, or heat flow.
abaqus-step
Define analysis steps and procedures. Use when user mentions static analysis, dynamic step, frequency analysis, heat transfer step, or asks about analysis type, time increments, or nlgeom.
abaqus-static-analysis
Complete workflow for static structural analysis. Use when analyzing stress, displacement, or reaction forces under constant loads. For strength and stiffness evaluation.
abaqus-shape-optimization
Optimize fillet/notch geometry. Use when user mentions stress concentration, fillet optimization, reshaping surfaces, or reducing peak stress. Moves surfaces only.
abaqus-output
Configure output requests - field outputs, history outputs. Use when user asks what results to save, output variables, reduce output file size, or history output.
abaqus-optimization
Configure Tosca optimization. Use when user mentions design response, objective function, optimization constraint, or SIMP penalty. Base module for topology/shape optimization.
abaqus-odb
Read analysis results. Use when user asks about maximum stress, extracting displacements, reaction forces, or exporting results. Post-processes ODB files.
abaqus-modal-analysis
Complete workflow for modal/frequency analysis - extract natural frequencies and mode shapes. Use for vibration analysis and resonance avoidance.
abaqus-mesh
Generate finite element meshes. Use when user mentions mesh, elements, nodes, refine mesh, mesh size, or asks about element types like C3D8R, C3D10, S4R.