abaqus-docs

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

16 stars

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

$curl -o ~/.claude/skills/abaqus-docs/SKILL.md --create-dirs "https://raw.githubusercontent.com/diegosouzapw/awesome-omni-skill/main/skills/documentation/abaqus-docs/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/abaqus-docs/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How abaqus-docs Compares

Feature / Agentabaqus-docsStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/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

crawl-docs-skill

16
from diegosouzapw/awesome-omni-skill

Run a Crawl4AI-based doc crawler and save internal pages as Markdown using page titles as filenames. Use when the user provides a docs URL and wants all internal subpages saved as .md files. Environment setup should only use uv.

coder-docs

16
from diegosouzapw/awesome-omni-skill

Index + offline snapshot of coder/coder documentation (progressive disclosure).

cgr-docs-governance

16
from diegosouzapw/awesome-omni-skill

Use this skill when updating project documentation after backend/frontend operational changes, incidents, workflow behavior changes, or new runbooks.

athlete-docs

16
from diegosouzapw/awesome-omni-skill

Documentation guidance for competition athletes and volunteers in WODsmith. Use when writing, reviewing, or improving athlete-facing documentation including registration, scheduling, workout viewing, leaderboards, check-in, and volunteer coordination.

assistant-ui-docs

16
from diegosouzapw/awesome-omni-skill

Extra documentation for `assistant-ui`. Use this to find offline resources about `assistant-ui`.

api-docs

16
from diegosouzapw/awesome-omni-skill

Expert API documentation including OpenAPI specs, endpoint documentation, and SDK guides

anydocs

16
from diegosouzapw/awesome-omni-skill

Generic Documentation Indexing & Search. Index any documentation site (SPA/static) and search it instantly.

ancplua-docs

16
from diegosouzapw/awesome-omni-skill

Search and answer questions about the ANcpLua ecosystem documentation. Use when users ask about ANcpLua.NET.Sdk features, ANcpLua.Analyzers rules, ANcpLua.Roslyn.Utilities APIs, or any configuration/usage questions about these packages.

agentic-docs

16
from diegosouzapw/awesome-omni-skill

Write clear, plain-spoken code comments and documentation that lives alongside the code. Use when writing or reviewing code that needs inline documentation like file headers, function docs, architectural decisions, or explanatory comments. Works well for both human readers and AI coding assistants who see one file at a time.

agent-ops-mkdocs

16
from diegosouzapw/awesome-omni-skill

MkDocs documentation site management: initializing, updating, building, and deploying

agent-ops-docs

16
from diegosouzapw/awesome-omni-skill

Documentation management for README, CHANGELOG, API docs, and user-facing documentation. Use when creating or updating project documentation.

agent-ops-create-technical-docs

16
from diegosouzapw/awesome-omni-skill

Create focused, specific technical documentation for codebase sections. Analyzes code, identifies topics, presents options before writing. Supports code blocks with line numbers.