Abaqus API Documentation
Overview
Use documentation lookup to separate a versioned API fact from runtime behavior
that still requires an Abaqus/CAE check. The result should be precise enough to
review without claiming that a static signature proves a model is correct.
When to use
Use before authoring or reviewing an Abaqus Python call when the symbol, module,
argument, return type, or supported release is uncertain. Do not use this skill
as a substitute for an authorized model run or an engineering review.
Inputs
- Object, method, symbol, or error message to verify
- Target Abaqus/CAE or abqpy release and Python context
- Expected behavior and the model operation that depends on it
- Available official manual, installed reference, or type information
Outputs
Return the module path, callable signature, relevant argument constraints,
release notes, and a short separation of static facts from runtime uncertainty.
Record the source and any unresolved version or licensing limitation.
Workflow
- Identify the exact object and operation rather than searching a broad keyword.
- Check the reference for the target release and execution context.
- Compare embedded Abaqus Python behavior with any external abqpy type hints.
- Mark arguments that require a runtime check, model state, or named region.
- Give a minimal, read-only example and state what it does not establish.
Safety gates
- Do not invent a signature from a similarly named API object.
- Do not execute an unreviewed snippet against a source model or ODB.
- Do not treat a valid import or signature as solver or physical validation.
- Do not download or redistribute restricted manuals or project data.
Example prompts
Verify the release-specific signature for the field-output region accessor.
Compare the external type hint with the embedded Python context, and list
which behavior still needs a read-only runtime check.
Common failures
- Mixing the embedded Python release with a separately installed abqpy package.
- Copying an argument from a neighboring object with a different contract.
- Assuming a static API check changed the model or proved the result.
- Omitting the release, object path, or source of the documented signature.
Acceptance checklist
1---2name: abaqus-docs3description: Use when an Abaqus Python API symbol, method signature, argument, module location, or release compatibility needs verification.4---56# Abaqus API Documentation78## Overview910Use documentation lookup to separate a versioned API fact from runtime behavior11that still requires an Abaqus/CAE check. The result should be precise enough to12review without claiming that a static signature proves a model is correct.1314## When to use1516Use before authoring or reviewing an Abaqus Python call when the symbol, module,17argument, return type, or supported release is uncertain. Do not use this skill18as a substitute for an authorized model run or an engineering review.1920## Inputs2122- Object, method, symbol, or error message to verify23- Target Abaqus/CAE or abqpy release and Python context24- Expected behavior and the model operation that depends on it25- Available official manual, installed reference, or type information2627## Outputs2829Return the module path, callable signature, relevant argument constraints,30release notes, and a short separation of static facts from runtime uncertainty.31Record the source and any unresolved version or licensing limitation.3233## Workflow34351. Identify the exact object and operation rather than searching a broad keyword.362. Check the reference for the target release and execution context.373. Compare embedded Abaqus Python behavior with any external abqpy type hints.384. Mark arguments that require a runtime check, model state, or named region.395. Give a minimal, read-only example and state what it does not establish.4041## Safety gates4243- Do not invent a signature from a similarly named API object.44- Do not execute an unreviewed snippet against a source model or ODB.45- Do not treat a valid import or signature as solver or physical validation.46- Do not download or redistribute restricted manuals or project data.4748## Example prompts4950> Verify the release-specific signature for the field-output region accessor.51> Compare the external type hint with the embedded Python context, and list52> which behavior still needs a read-only runtime check.5354## Common failures5556- Mixing the embedded Python release with a separately installed abqpy package.57- Copying an argument from a neighboring object with a different contract.58- Assuming a static API check changed the model or proved the result.59- Omitting the release, object path, or source of the documented signature.6061## Acceptance checklist6263- [ ] Object, method, release, and Python context are explicit.64- [ ] Signature and argument constraints have a traceable source.65- [ ] Static facts and runtime observations are separated.66- [ ] No model, ODB, or solver mutation was performed implicitly.67- [ ] Remaining compatibility uncertainty is stated.