cape.cfdx.cmdrun: Execute system calls for CAPE

This template module provides an interface for simple command-line tools. The general approach for CAPE is to create a function for each command-line binary that is called. This module contains two methods, calli() and callf(), that are wrappers for the built-in subprocess.call(), and several useful command-line utilities.

See also:
cape.cfdx.cmdrun.aflr3(opts=None, j=0, **kw)

Run AFLR3 with the appropriate options

Call:
>>> aflr3(opts=None, j=0, **kw)
Inputs:
opts: cape.options.Options

Options interface with access to AFLR3 options

j: int

Phase number

kw: dict

Raw dictionary of command-line arguments

See also:
Versions:

  • 2016-04-04 @ddalle: v1.0

cape.cfdx.cmdrun.callf(cmdi: list, f: str | None = None, e: str | None = None, i: str | None = None, shell: bool = False, v: bool = True, check: bool = True) → int

Call a command with alternate STDOUT by filename

Call:
>>> ierr = callf(cmdi, **kw)
Inputs:
cmdi: list (str)

List of strings as for subprocess.call()

f: str

File name to which to store STDOUT

e: {f} | str

Separate file name for STDERR

i: {None} | str

Name of file to read and use as STDIN

shell: bool

Whether or not a shell is needed

v: {True} | False

Verbose option; display PWD and STDOUT values

check: {True} | False

Option to raise an exception with nonzero return code

Outputs:
ierr: int

Return code of command executed

Versions:

  • 2014-08-30 @ddalle: v1.0

  • 2015-02-13 @ddalle: v2.0; rely on calli()

  • 2017-03-12 @ddalle: v2.1; add v option

  • 2019-06-10 @ddalle: v2.2; add e option

  • 2024-05-25 @ddalle: v2.3; don’t remove RUNNING

  • 2025–1022 @ddalle: v2.4; add i option

cape.cfdx.cmdrun.calli(cmdi: list, f: str | None = None, e: str | None = None, i: str | None = None, shell: bool = False, v: bool = True) → int

Call a command with alternate STDOUT by filename

Call:
>>> ierr = calli(cmdi, f=None, e=None, shell=None, v=True)
Inputs:
cmdi: list[str]

List of strings as for subprocess.call()

f: {None} | str

File name to which to store STDOUT

e: {f} | str

Name of separate file to write STDERR to

i: {None} | str

Name of file to read and use as STDIN

shell: bool

Whether or not a shell is needed

v: {True} | False

Verbose option; display PWD and STDOUT values

Outputs:
ierr: int

Return code, 0 for successful execution

Versions:

  • 2014-08-30 @ddalle: v1.0

  • 2015-02-13 @ddalle: v2.0; return code

  • 2017-03-12 @ddalle: v2.1; Add v option

  • 2019-06-10 @ddalle: v2.2; Add e option

  • 2024-01-17 @ddalle: v2.3; flush() STDOUT manually

  • 2025-01-22 @ddalle: v2.4; Add i option

cape.cfdx.cmdrun.callo(cmdi: list, shell: bool = False) → str

Call a command and get the output text

This function is basically a substitute for subprocess.check_output(), which was not available in Python 2.6.

Call:
>>> txt = callo(cmdi, shell=False)
Inputs:
cmdi: list

List of strings to use as a command

shell: bool

Whether or not a shell is needed

Outputs:
txt: str

Output of running the command

Versions:

  • 2016-04-01 @ddalle: v1.0

cape.cfdx.cmdrun.check_output(cmdi: list)

Capture output from a system command

Call:
>>> txt = check_output(cmdi)
Inputs:
cmdi: list[str]

List of strings as for subprocess.call()

Outputs:
txt: str

Contents of STDOUT while executing cmdi

Versions:

  • 2017-03-13 @ddalle: v1.0

cape.cfdx.cmdrun.find_executable(cmdname: str | list | tuple, title: str) → str

Find an executable from a list of one or more candidates

Call:
>>> cmd = find_executable(cmdname, title)
>>> cmd = find_executable(cmdnames, title)
Inputs:
cmdname: str

Name of single command to check for

cmdnames: list[str]

Multiple candidates; returns first command found on path

title: str

Description of exectuable being sought

Outputs:
cmd: str

Name of executable found on current path

Raises:

SystemError if no candidate found on path

Versions:

  • 2025-01-22 @ddalle: v1.0

cape.cfdx.cmdrun.grep(regex, fname)

Search for a regular expression in a file

Call:
>>> lines = grep(regex, fname)
Inputs:
regex: str

Regular expression for which to search

fname: str

Name of file or wild card to search

Outputs:
lines: list (str)

List of lines containing the sought regular expression

Versions:

  • 2015-12-28 @ddalle: v1.0

cape.cfdx.cmdrun.head(fname, n=1)

Extract the first n lines of a file

Call:
>>> txt = head(fname, n=1)
Inputs:
fname: str

Name of file to tail

n: int

Number of lines to process

Outputs:
txt: str

Output of built-in tail function

Versions:

  • 2015-01-12 @ddalle: v1.0

cape.cfdx.cmdrun.intersect(opts=None, **kw)

Run Cart3D intersect to combine overlapping triangulations

Call:
>>> intersect(opts=None, **kw)
Inputs:
opts: cape.options.Options

Options interface with access to verify options

kw: dict

Raw dictionary of command-line arguments

See also:
Versions:

  • 2016-04-05 @ddalle: v1.0

cape.cfdx.cmdrun.pvpython(lay, *args, **kw)

Stand-alone function to execute a Paraview Python script

Call:
>>> pvpython(lay, *args, cmd="pvpython")
>>> pvpython(lay, a1, a2, ...)
Inputs:
lay: str

Name of script to run

cmd: {"pvpython"} | str

Name of executable to use, may be full path

a1: str

Command-line input to the script

Versions:

  • 2015-11-22 @ddalle: v1.0

cape.cfdx.cmdrun.tail(fname, n=1)

Tail the last n lines of a file

Call:
>>> txt = tail(fname, n=1)
Inputs:
fname: str

Name of file to tail

n: int

Number of lines to process

Outputs:
txt: str

Output of built-in tail function

Versions:

  • 2015-01-12 @ddalle: v1.0

cape.cfdx.cmdrun.tecmcr(mcr='export-lay.mcr', **kwargs)

Run a Tecplot macro

Call:
>>> tecmcr(mcr="export-lay.mcr")
Inputs:
mcr: str

File name of Tecplot macro

Versions:

  • 2015-03-10 @ddalle: v1.0

cape.cfdx.cmdrun.verify(opts=None, **kw)

Run Cart3D binary verify to test a triangulation

Call:
>>> verify(opts=None, **kw)
Inputs:
opts: cape.options.Options

Options interface with access to verify options

kw: dict

Raw dictionary of command-line arguments

See also:
Versions:

  • 2016-04-05 @ddalle: v1.0