Pymapdl 会话管理

Name: Pymapdl 会话管理
Author: ansys

写作社区

作者仓库星标 494
作者仓库 pymapdl

解读按原文结构重写，命令、链接、术语均保留；右侧可核对作者原始 SKILL.md

方法与流程

Common workflows：原文以此为独立章节。

适用与边界

当前原文没有单列适用场景。
pymapdl stop：Stop running MAPDL instances. By default targets port 50052.

原文中的明确线索

要点：「stdout」、「stderr」、「on success,」、「Example — start on a custom port with 4 CPUs」、「Examples」、「Example」、「already running」、「Repeated -c / --command」
文件与命令：pymapdl、ansys-mapdl-core、click、pymapdl start、pymapdl stop、pymapdl list、pymapdl exec、pymapdl convert

流狐整理：以上内容来自当前 SKILL.md 的章节与原词；未补写作者没有声明的工具、兼容性或能力。

PyMAPDL CLI

The pymapdl CLI lets you manage MAPDL instances and execute APDL commands directly from the terminal. It is installed automatically with the ansys-mapdl-core Python package and requires the click dependency (included by default).

A typical session looks like this:

pymapdl start                          # launch a solver instance
pymapdl exec -c /prep7 -c "K,1,0,0,0" # send commands to it
pymapdl exec --file model.inp          # or send a whole script
pymapdl stop                           # shut it down

All commands print human-readable output to stdout and errors to stderr. Exit code is 0 on success, 1 on failure.

Commands at a glance

Command	Purpose
`pymapdl start`	Launch a new local MAPDL instance
`pymapdl stop`	Kill one or all running instances
`pymapdl list`	Show running MAPDL processes
`pymapdl exec`	Send APDL commands to a running instance
`pymapdl convert`	Translate an APDL script to Python

`pymapdl start`

Launch a new MAPDL gRPC server. Prints the IP, port, and PID on success.

pymapdl start [OPTIONS]

Key options

Option	Default	Description
`--port`	50052 (or `PYMAPDL_PORT`)	gRPC port; first available port at or after this value
`--exec_file`	auto-detected	Path to the MAPDL executable
`--run_location`	temp dir	Working directory for the MAPDL process
`--jobname`	`file`	MAPDL jobname
`--nproc`	2	Number of processors
`--ram`	all available	Fixed memory in MB
`--override`	off	Delete stale lock files before starting
`--additional_switches`	none	Extra MAPDL command-line switches (e.g. `aa_r` for academic license)
`--start_timeout`	45	Seconds to wait for the server to become ready
`--license_type`	none	License name (e.g. `meba`, `ansys`) or description (e.g. `enterprise`)
`--version`	latest	MAPDL version to launch (e.g. `241`, `24.1`)

Example — start on a custom port with 4 CPUs:

pymapdl start --port 50055 --nproc 4
# Success: Launched an MAPDL instance (PID=12345) at 127.0.0.1:50055

`pymapdl stop`

Stop running MAPDL instances. By default targets port 50052.

pymapdl stop [OPTIONS]

Options

Option	Description
`--port PORT`	Stop instances listening on this port
`--pid PID`	Stop the process (and its children) with this PID
`--all`	Stop every MAPDL instance on the machine

Examples:

pymapdl stop                  # stop instance on default port 50052
pymapdl stop --port 50055     # stop instance on port 50055
pymapdl stop --pid 12345      # stop a specific process tree
pymapdl stop --all            # stop all MAPDL processes

`pymapdl list`

List MAPDL processes currently running on the machine.

pymapdl list [OPTIONS]

Options

Option	Short	Description
`--instances`	`-i`	Show only parent instances (hide child processes)
`--long`	`-l`	Show all columns (command line + working directory)
`--cmd`	`-c`	Include the command-line column
`--location`	`-cwd`	Include the working-directory column

Example:

pymapdl list -i
# Name          Status    gRPC port    PID
# ANSYS241.exe  running       50052  41644

`pymapdl exec`

Send APDL commands to an already running MAPDL instance and print the solver output. This command never starts a new instance — use pymapdl start first.

pymapdl exec [OPTIONS] [-]

Three input modes (mutually exclusive)

Repeated -c / --command (recommended for scripting and LLM use):
```
pymapdl exec -c /prep7 -c "BLOCK,0,1,0,1,0,1" -c SAVE
```
Each -c value is one APDL command. They are joined with newlines and sent as a single input_strings() block for maximum performance.
File with --file / -f:
```
pymapdl exec --file model.inp
```

Stdin by passing - as a positional argument:

# Linux / macOS
cat model.inp | pymapdl exec -

# Windows PowerShell
Get-Content model.inp | pymapdl exec -

Options

Option	Short	Default	Description
`--command`	`-c`	—	APDL command (repeatable)
`--file`	`-f`	—	Path to an APDL script file
`--port`	—	50052 (or `PYMAPDL_PORT`)	gRPC port of the target instance
`--ip`	—	127.0.0.1 (or `PYMAPDL_IP`)	IP of the target instance
`--timeout`	—	10	Connection timeout in seconds
`--clear-on-connect`	—	off	Clear MAPDL database before sending commands

Behavior notes

Successive calls share state. Because --clear-on-connect is off by default, you can split a workflow across multiple pymapdl exec invocations and the model/mesh/results persist between them.
Output goes to stdout, errors to stderr — ideal for piping, logging, or LLM consumption.
Windows paths are safe. Backslash sequences like C:\new\file are preserved verbatim; no mangling occurs.

`pymapdl convert`

Convert an APDL script to a PyMAPDL Python script.

pymapdl convert [OPTIONS]

Key options

Option	Short	Default	Description
`--file`	`-f`	stdin	APDL input file
`--output`	`-o`	stdout	Output Python file
`--macros_as_functions`	`-mf`	True	Convert macros to Python functions
`--use_function_names`	`-fn`	True	Use method names (`mapdl.k`) instead of `mapdl.run('K')`
`--only_commands`	`-oc`	off	Emit only MAPDL calls (no imports/header/exit)
`--add_imports`	`-ai`	True	Add `launch_mapdl()` boilerplate
`--comment_solve`	`-cs`	off	Comment out SOLVE / /EOF lines

Example:

pymapdl convert -f model.inp -o model.py

Environment variables

Variable	Used by	Purpose
`PYMAPDL_PORT`	`start`, `exec`	Default gRPC port when `--port` is omitted
`PYMAPDL_IP`	`exec`	Default IP when `--ip` is omitted
`PYMAPDL_MAPDL_EXEC`	`start`	Path to MAPDL executable

Common workflows

Interactive modeling session

pymapdl start --port 50055
pymapdl exec --port 50055 -c /prep7
pymapdl exec --port 50055 -c "ET,1,186" -c "BLOCK,0,1,0,1,0,1" -c "VMESH,ALL"
pymapdl exec --port 50055 --file boundary_conditions.inp
pymapdl exec --port 50055 -c /solu -c SOLVE
pymapdl stop --port 50055

Run a full script in one shot

pymapdl start
pymapdl exec --file full_model.inp
pymapdl stop

Pipe commands from another tool

# Generate APDL dynamically and pipe it in
python generate_mesh.py | pymapdl exec -

Fresh database each time

pymapdl exec --clear-on-connect -c /prep7 -c "K,1,0,0,0"

流狐档案作者与许可取自来源；运行、权限和网络为流狐检测或估算

流狐分类: 写作
作者声明 Agent: 未找到明确声明；不据此推断已兼容或已测试
静态检查: 88 / 100 · 启发式扫描，不代表运行安全
作者 / 版本 / 许可: @ansys · 未声明 license
流狐 Token 估算: 低消耗
流狐接入估算: 需简单配置
是否需要外部 API Key: 未发现要求
检测到的系统要求: macOS · Linux · Windows
底层运行要求: Python
检测到的文件与系统行为: 只读
允许写入 / 修改
Shell 执行
读取环境变量
检测到的网络行为: 仅限本地
安装命令数: 无（仅作为资料）

档案由构建时根据 SKILL.md 与安装命令自动衍生，可能与作者实际意图存在差异。

需要注意： 未限定 allowed-tools，默认拥有全部工具权限。

输出预览 pymapdl-cli-ansys.preview

作者没有在当前 SKILL.md 中定义固定输出样例。

SKILL.md SKILL.md

# PyMAPDL CLI

The `pymapdl` CLI lets you manage MAPDL instances and execute APDL commands
directly from the terminal. It is installed automatically with the
`ansys-mapdl-core` Python package and requires the `click` dependency (included
by default).

A typical session looks like this:

```
pymapdl start                          # launch a solver instance
pymapdl exec -c /prep7 -c "K,1,0,0,0" # send commands to it
pymapdl exec --file model.inp          # or send a whole script
pymapdl stop                           # shut it down
```

All commands print human-readable output to **stdout** and errors to **stderr**.
Exit code is **0** on success, **1** on failure.

## Commands at a glance

| Command | Purpose |
|---------|---------|
| `pymapdl start`   | Launch a new local MAPDL instance |
| `pymapdl stop`    | Kill one or all running instances |
| `pymapdl list`    | Show running MAPDL processes |
| `pymapdl exec`    | Send APDL commands to a running instance |
| `pymapdl convert` | Translate an APDL script to Python |

---

## `pymapdl start`

Launch a new MAPDL gRPC server. Prints the IP, port, and PID on success.

```
pymapdl start [OPTIONS]
```

### Key options

| Option | Default | Description |
|--------|---------|-------------|
| `--port` | 50052 (or `PYMAPDL_PORT`) | gRPC port; first available port at or after this value |
| `--exec_file` | auto-detected | Path to the MAPDL executable |
| `--run_location` | temp dir | Working directory for the MAPDL process |
| `--jobname` | `file` | MAPDL jobname |
| `--nproc` | 2 | Number of processors |
| `--ram` | all available | Fixed memory in MB |
| `--override` | off | Delete stale lock files before starting |
| `--additional_switches` | none | Extra MAPDL command-line switches (e.g. `aa_r` for academic license) |

…

证据边界与执行链路

作者原文负责流程事实；流狐只索引当前章节、要点、文件与命令。

章节    -> Commands at a glance → pymapdl start → Key options → pymapdl stop → Options → pymapdl list
要点    -> stdout · stderr · on success, · Example — start on a custom port with 4 CPUs · Examples · Example · already running · Repeated -c / --command
文件/命令 -> pymapdl · ansys-mapdl-core · click · pymapdl start · pymapdl stop · pymapdl list · pymapdl exec · pymapdl convert
内容 SHA-256 -> d74c99556421

方法与流程

适用与边界

原文中的明确线索

PyMAPDL CLI

Commands at a glance

pymapdl start

Key options

pymapdl stop

Options

pymapdl list

Options

pymapdl exec

Three input modes (mutually exclusive)

Options

Behavior notes

pymapdl convert

Key options

Environment variables

Common workflows

Interactive modeling session

Run a full script in one shot

Pipe commands from another tool

Fresh database each time

讨论

`pymapdl start`

`pymapdl stop`

`pymapdl list`

`pymapdl exec`

`pymapdl convert`