What is pymapdl AGENTS.md?

Repository instructions for PyMAPDL, a Python client library that connects programs to Ansys MAPDL engineering software.

They guide coding-agent work such as modifying the library, running tests, updating documentation, and applying formatting or pre-commit checks.

They explain the project layout, required tools, files that must not be edited, coding constraints, and commands for checking changes.

pymapdl AGENTS.md — Instructions file by ansys

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add instructions/ansys/pymapdl/agents-md

Clone the repo

git clone --depth 1 https://github.com/ansys/pymapdl

Made for: Codex, OpenCode.

Per session 2,004 This file is loaded in full into every session.

When invoked 2,004 The same file — it is already loaded in full.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.02004	$0.02004
Opus 5	$0.01002	$0.01002
Sonnet 5	$0.00401	$0.00401
Haiku 4.5	$0.00200	$0.00200

Measured 3d ago against content hash 505514d4431b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

pymapdl AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 227 lines

How it starts

The opening of the file, as written. The whole thing — 227 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

Instructions for AI coding agents working in the PyMAPDL repository. This is the single source of truth; CLAUDE.md just points here.

PyMAPDL (ansys-mapdl-core) is the Python client library for Ansys MAPDL.

Repository layout

Path	Content
`src/ansys/mapdl/core/`	Library source
`src/ansys/mapdl/core/_commands/`	Auto-generated. Never edit.
`src/ansys/mapdl/core/mapdl_extended.py`	`_MapdlCommandExtended`: where MAPDL command behavior is overridden
`src/ansys/mapdl/core/launcher/`	Launching and connecting to MAPDL
`tests/`	Test suite; shared fixtures and helpers in `tests/conftest.py`
`doc/source/`	Sphinx documentation
`doc/changelog.d/`	Towncrier changelog fragments (generated by CI/CD; do not add)
`examples/`	Gallery examples
`.github/agents/`	Specialized agent definitions

Environment

Use uv for everything. Fall back to the repository .venv only if uv fails.

uv sync --all-extras          # install dependencies
uv run pytest                 # run tests
uv run pre-commit install     # install hooks (once)
uv run pre-commit run --all-files

Supported Python: 3.10 - 3.14.

Hard constraints

Never modify anything under src/ansys/mapdl/core/_commands/. To change the behavior of a MAPDL command, override it in _MapdlCommandExtended in src/ansys/mapdl/core/mapdl_extended.py.
Never break backward compatibility. Deprecate instead, with a warning and a removal version.
Never add files to doc/changelog.d/. Changelog fragments are generated automatically by CI/CD when the pull request is opened.
Never commit secrets, credentials, or license server details.
Pre-commit must pass before every commit. It is mandatory and runs black, isort, flake8, mypy, codespell, numpydoc-validation, bandit, license headers, and more.

Code style

PEP 8, enforced by black and isort (profile = "black").
Type hints on new public APIs. mypy runs on src/ through pre-commit.
No bare except: and no overly broad exception handling. Catch the specific exception, or the narrowest useful base class.
Group nested context managers:

Read the full file on GitHub · 227 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

3d ago First seen · 227 lines · 2,004 tokens per session scan A 505514d4431b

Subscribe to this mod's changes

pymapdl AGENTS.md is an instructions file published in the GitHub repository ansys/pymapdl (513 stars, last pushed 4d ago), licensed MIT. It adds 2,004 tokens to every session, about $0.0100 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

ansys apdl mesh numerical-simulation structural-mechanics

pymapdl AGENTS.md

Getting it into your agent

What it costs to keep this loaded

Grade A, and why

Nothing flagged

How it starts

AGENTS.md

Repository layout

Environment

Hard constraints

Code style

What this file has done since we first saw it

Other instructions, from other repositories

rune CLAUDE.md

mesh-api AGENTS.md

bproc-pubvis AGENTS.md

agent-comms AGENTS.md

agent-comms CLAUDE.md

ansys-aedt-mcp AGENTS.md