`cape.cfdx.cli`: Command-line interface to `cape` (executable)¶

This module provides the main() function that is used by the executable called cape.

class cape.cfdx.cli.Cfdx1to2Args(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxAgentArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxAgenticArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxApplyArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxApproveArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxArchiveArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxArgReader(*args, **kw)¶

Bases: ArgReader

casecntl_mod¶

cntl_cls¶

cntl_mod¶

runner_cls¶

class cape.cfdx.cli.CfdxBatchArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxCheckArgs(*args, **kw)¶: Bases: _CfdxCaseLoopArgs

class cape.cfdx.cli.CfdxCheckDBArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxCheckFMArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxCheckLLArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxCheckTriqFMArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxCleanArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxCollectCutPlaneArgs(*args, **kw)¶: Bases: CfdxCollectSurfArgs

class cape.cfdx.cli.CfdxCollectSurfArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxDefailArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxDezombieArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxDispatchArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxEditArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxExecArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxExtendArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxExtractDexArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractFMArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractIterFMArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractLLArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractPropArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractPyFuncArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractSurfCpArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractTimeSeriesArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractTriqFMArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxExtractTriqPTArgs(*args, **kw)¶: Bases: _CfdxExtractArgs

class cape.cfdx.cli.CfdxFailArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxFindArgs(*args, **kw)¶: Bases: _CfdxCaseLoopArgs

class cape.cfdx.cli.CfdxFindJSONArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxFindLargeArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxFrontDesk(*args, **kw)¶

Bases: CfdxArgReader

infer_cmdname() → str¶

Infer sub-command if not determined by first argument

This command is usually overwritten in subclasses for special command-line interfaces where the primary task is inferred from options. This version always returns None

Call:

>>> cmdname = parser.infer_cmdname()

Inputs:

parser: ArgReader: Command-line argument parser

Outputs:

cmdname: str: Name of sub-command

class cape.cfdx.cli.CfdxGetCaseStateArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxGetColStateArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxGetConfigArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxGetKeysArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxGetSubfigArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxHelpOptArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxInspectJsonArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxListKeysArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxListSubfigsArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxOpenImgArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxOpenPDFArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxOpenPNGArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxOpenSubfigArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxPerformArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxPostFileArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxQdelArgs(*args, **kw)¶: Bases: _CfdxCaseLoopArgs

class cape.cfdx.cli.CfdxReceiveFileArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxRemoveCasesArgs(*args, **kw)¶: Bases: _CfdxCaseLoopArgs

class cape.cfdx.cli.CfdxReportArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxReviewArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxRunArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxSearchLargeArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxSetConfigArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxSkeletonArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxStartArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxTriangulateCutPlaneArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxTuiArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxUIArgs(*args, **kw)¶: Bases: CfdxArgReader

class cape.cfdx.cli.CfdxUnarchiveArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

class cape.cfdx.cli.CfdxUnmarkArgs(*args, **kw)¶: Bases: _CfdxSubsetArgs

cape.cfdx.cli.cape_1to2(*, h: bool | None = None, solver: str | None = None) → Tuple[int, Any]¶

Run cape 1to2 command

Convert Python and JSON files from CAPE 1 to 2 standard

Call:

>>> ierr, v = cape_1to2(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
1to2: {True} | bool: Convert Python modules in current folder from CAPE 1 to 2

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_agent(*, h: bool | None = None, solver: str | None = None, agent: str = None) → Tuple[int, Any]¶

Run cape agent command

Run one CAPE agent prompt and exit

Call:

>>> ierr, v = cape_agent(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
agent: str: Run one CAPE agent prompt and exit

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_agentic(**kw) → Tuple[int, Any]¶

Run %(title)s command

%(description)s

Call:

>>> ierr, v = %(name)s(*a, **kw)

Inputs:

%(options)s

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape apply command

Re-apply current settings to case(s)

Call:

>>> ierr, v = cape_apply(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
apply: bool: Apply current JSON settings to existing case(s)
qsub: {False} | bool: Don’t submit PBS/Slurm jobs even if otherwise specified

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape approve command

Mark selected cases as complete

Call:

>>> ierr, v = cape_approve(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
PASS: bool: Mark case(s) as PASS

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape archive command

Archive cases; delete files not needed for post-processing

Call:

>>> ierr, v = cape_archive(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
archive: bool: Archive files from case(s) and delete extra files

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_batch(*, h: bool | None = None, solver: str | None = None) → Tuple[int, Any]¶

Run cape batch command

Submit CAPE command as a PBS/Slurm batch job

Call:

>>> ierr, v = cape_batch(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape check command

Check status of one or more cases

Call:

>>> ierr, v = cape_c(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
add-cols: str | list: Additional columns to show in run matrix status table
add-counters: str | list: Additional keys to show totals after run mat table
cols: str | list: Explicit list of status columns
counters: str | list: Explicit list of keys to show totals for in py{x} -c
hide-cols: str | list: Standard columns to hide in run matrix status table
hide-counters: str | list: Standard keys to omit totals after run mat table
j: bool: List PBS/Slurm job ID in -c output
c: bool: Check and display case(s) status
nproc: {8} | int: Number of parallel processes to use
u: str: Pretend to be user UID

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape get-case-state command

Show iterative state of report columns for case(s)

Call:

>>> ierr, v = cape_case_state(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
nlast: int: Last iteration to include in iterative statistics
v: bool: Show additional output while running command

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape check-db command

Check completion of all databook components

Call:

>>> ierr, v = cape_check_db(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
check-db: {True} | bool: Check completion of all databook products
check-fm: bool: Check completion of force & moment components
check-ll: bool: Check completion of line load components
check-triqfm: bool: Check completion of patch load (triqfm) components

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape check-fm command

Check completion of all force & moment components

Call:

>>> ierr, v = cape_check_fm(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
check-fm: {True} | bool: Check completion of force & moment components

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape check-ll command

Check completion of all line load components

Call:

>>> ierr, v = cape_check_ll(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
check-ll: {True} | bool: Check completion of line load components

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape check-triqfm command

Check completion of TriqFM components

Call:

>>> ierr, v = cape_check_triqfm(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
check-triqfm: {True} | bool: Check completion of patch load (triqfm) components

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape clean command

Remove extra files not necessary for running a case

Call:

>>> ierr, v = cape_clean(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
clean: bool: Remove files not necessary for running and not archived

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape get-col-state command

Show iterative state of one column for case(s)

Call:

>>> ierr, v = cape_col_state(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
col: str: Name of column to analyze
comp: str: Name of DataBook component
nlast: int: Last iteration to include in iterative statistics
v: bool: Show additional output while running command

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape collect-cutplane command

Collect cut-plane data in current case folder

Call:

>>> ierr, v = cape_collect_cutplane(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
nsurf: int: Index of surface to process
batchsize: int: Number of snapshots to collect into each batch files
clean: {False} | bool: Remove files not necessary for running and not archived
nmax: int: Maximum number of snapshots to process
nproc: int: Number of parallel processes to use
adaptive: bool: Save the adapted-mesh version of flow data (more data)
constant: bool: Assume a fixed (not adaptive) mesh for data collection
fixed: bool: Interpolate flow data to common grid
raw: bool: Collect raw flow data w/o triangulating or interpolating

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape collect-surf command

Collect surface data in current case folder

Call:

>>> ierr, v = cape_collect_surfdata(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
nsurf: {1} | int: Index of surface to process
batchsize: int: Number of snapshots to collect into each batch files
clean: {False} | bool: Remove files not necessary for running and not archived
nmax: int: Maximum number of snapshots to process
nproc: int: Number of parallel processes to use

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape defail command

Remove FAIL files from case(s)and other failure artifacts

Call:

>>> ierr, v = cape_defail(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
defail: bool: Clean up FAIL cases, deletes FAIL and others

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape dezombie command

Delete job and clean-up stalled cases (aka ‘zombie’ cases)

Call:

>>> ierr, v = cape_dezombie(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
dezombie: bool: Clean up ZOMBIE cases, RUNNING but no recent file mods
early: bool: Reduce PhaseIters to current iter; makes case DONE

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape dispatch command

Interactively dispatch case(s) by status only

Call:

>>> ierr, v = cape_dispatch(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_edit(edit: str, *, h: bool | None = None, solver: str | None = None, f: str | None = None, fjson: str | None = None) → Tuple[int, Any]¶

Run cape edit-json command

Edit JSON settings from command-line

Call:

>>> ierr, v = cape_edit(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
f: str: Use the JSON (or YAML) file JSON
edit: str: Text of JSON settings to edit and rewrite
fjson: str: Apply settings from file FJSON

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape exec command

Run a shell command in folder of case(s)

Call:

>>> ierr, v = cape_exec(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
e: str: Execute the command EXEC

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extend command

Extend unmarked cases

Call:

>>> ierr, v = cape_extend(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
extend: {1} | bool | int: Extend case(s) by N_EXT copies of last phase
imax: int: Do not extend a case beyond iteration M
qsub: {False} | bool: Don’t submit PBS/Slurm jobs even if otherwise specified

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract command

Extract DataBook components

Call:

>>> ierr, v = cape_extract_dex(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
dex: bool | str: Extract DataBook components matching pattern DEX

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-fm command

Extract averaged force & moment results

Call:

>>> ierr, v = cape_extract_fm(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
fm: bool | str: Extract force & moment data [comps matching PAT] for case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-iter-fm command

Extract iterative force & moment histories

Call:

>>> ierr, v = cape_extract_iterfm(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
iter-fm: bool | str: Extract iterative force & moment histories

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-ll command

Compute and extract line load results

Call:

>>> ierr, v = cape_extract_ll(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
ll: bool | str: Extract line load data [comps matching PAT] for case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-prop command

Extract other scalar results

Call:

>>> ierr, v = cape_extract_prop(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
prop: bool | str: Extract scalar properties [comps matching PAT]

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-pyfunc command

Extract data from custom Python functions

Call:

>>> ierr, v = cape_extract_pyfunc(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
dbpyfunc: bool | str: Extract scalar data from custom Python function

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-surfcp command

Extract surfcp data

Call:

>>> ierr, v = cape_extract_surfcp(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
surfcp: bool | str: Extract surface pressure data for case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-timeseries command

Extract time series data

Call:

>>> ierr, v = cape_extract_timeseries(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
ts: bool | str: Extract time-series data [comps matching PAT]

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-triqfm command

Extract post-processed patch loads

Call:

>>> ierr, v = cape_extract_triqfm(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
triqfm: bool | str: Extract triq F&M data [comps matching PAT] for case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape extract-triqpt command

Collect post-processed point sensor data

Call:

>>> ierr, v = cape_extract_triqpt(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
delete: bool: Delete DataBook entries instead of adding new ones
pt: bool | str: Extract surf point sensors [comps matching PAT] for case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape fail command

Mark selected cases as ERRORs

Call:

>>> ierr, v = cape_fail(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
FAIL: bool: Mark case(s) as ERRORs

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape find command

Find indices of cases meeting constraints

Call:

>>> ierr, v = cape_find(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
add-cols: str | list: Additional columns to show in run matrix status table
add-counters: str | list: Additional keys to show totals after run mat table
cols: str | list: Explicit list of status columns
counters: str | list: Explicit list of keys to show totals for in py{x} -c
hide-cols: str | list: Standard columns to hide in run matrix status table
hide-counters: str | list: Standard keys to omit totals after run mat table
j: bool: List PBS/Slurm job ID in -c output

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_find_json(pat: str | None = None, *, h: bool | None = None, solver: str | None = None) → Tuple[int, list]¶

Run cape find-json command

Find CAPE JSON files

Call:

>>> ierr, v = cape_find_json(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
pat: str: Consider file names matching pattern PAT

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape find-large command

Find folders with large file size

Call:

>>> ierr, v = cape_find_large(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
cutoff: str: Min file size or count for ‘large’

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_get_config(opt: str, *, h: bool | None = None, solver: str | None = None) → Tuple[int, list]¶

Run cape get-config command

Show value of user CAPE configuration

Call:

>>> ierr, v = cape_get_config(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
opt: str: CAPE user configuration variable name

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_get_keys(*, h: bool | None = None, solver: str | None = None, f: str | None = None) → Tuple[int, Any]¶

Run cape get-keys command

Show properties of run matrix keys as JSON

Call:

>>> ierr, v = cape_get_keys(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
f: str: Use the JSON (or YAML) file JSON

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape get-subfig command

Create one report subfigure and cache its image

Call:

>>> ierr, v = cape_get_subfig(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
subfig: str: Name of report subfigure to create

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape help-opt command

Show help and docs for JSON options

Call:

>>> ierr, v = cape_help_opt(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
f: str: Use the JSON (or YAML) file JSON
jq: str: Show help for JSON option or section at path JQ
maxdepth: int: Max depth of dicts and subsections to expand

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape inspect-json command

Show item or subset of JSON options

Call:

>>> ierr, v = cape_inspect_json(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
f: str: Use the JSON (or YAML) file JSON
jq: str: Show item or subset of JSON options at path JQ
maxdepth: int: Max depth of dicts to show in inspect-json output

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_list_keys(*, h: bool | None = None, solver: str | None = None, f: str | None = None) → Tuple[int, Any]¶

Run cape list-keys command

List run matrix keys

Call:

>>> ierr, v = cape_list_keys(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
f: str: Use the JSON (or YAML) file JSON

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape list-subfigs command

List report subfigures

Call:

>>> ierr, v = cape_list_subfigs(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
f: str: Use the JSON (or YAML) file JSON
report: bool | str: Generate the report RP or the first in the list

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_open_img(img: str, *, h: bool | None = None, solver: str | None = None, dpi: int = 120, page: int = 0, terminal: bool = True) → Tuple[int, Any]¶

Run cape open-img command

Open an image file in preferred viewer

Call:

>>> ierr, v = cape_open_img(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
dpi: {120} | int: Resolution, in DPI, for converting PDF to image
img: str: Name of image file to open
page: {0} | int: Page of PDF to display
terminal: {True} | bool: Show PNG image in terminal if supported

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape open-pdf command

Open a PDF file in preferred reader

Call:

>>> ierr, v = cape_open_pdf(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
fpdf: str: Name of PDF file to open/write/send
local: bool: Force an action to be done locally, without SSH transfer
pull: bool: Pull remote file to local dir before opening
remote-dir: str: Base path to use on remote host
wait: bool: Wait until application closed before returning control

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_open_png(fpng: str, *, h: bool | None = None, solver: str | None = None, terminal: bool = True, wait: bool | None = None) → Tuple[int, Any]¶

Run cape open-png command

Open a PNG image in preferred viewer

Call:

>>> ierr, v = cape_open_png(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
fpng: str: Name of PNG image file to open
terminal: {True} | bool: Show PNG image in terminal if supported
wait: bool: Wait until application closed before returning control

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape open-subfig command

Create one report subfigure and open its image

Call:

>>> ierr, v = cape_open_subfig(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
dpi: {120} | int: Resolution, in DPI, for converting PDF to image
force: bool: Update report and ignore subfigure cache
page: {0} | int: Page of PDF to display
subfig: str: Name of report subfigure to create
terminal: {True} | bool: Show PNG image in terminal if supported

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape perform command

Perform an Actions action on case(s)

Call:

>>> ierr, v = cape_perform(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
action: str: Name of Actions action to perform on case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape post-file command

Send one or more files to RemoteHost

Call:

>>> ierr, v = cape_post_file(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
pat: str: Consider file names matching pattern PAT
v: bool: Show additional output while running command

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape qdel command

Delete PBS/Slurm job of case(s)

Call:

>>> ierr, v = cape_qdel(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
add-cols: str | list: Additional columns to show in run matrix status table
add-counters: str | list: Additional keys to show totals after run mat table
cols: str | list: Explicit list of status columns
counters: str | list: Explicit list of keys to show totals for in py{x} -c
hide-cols: str | list: Standard columns to hide in run matrix status table
hide-counters: str | list: Standard keys to omit totals after run mat table
j: bool: List PBS/Slurm job ID in -c output
qdel: {True} | bool: Delete a PBS/Slurm job

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_receive_file(*, h: bool | None = None, solver: str | None = None) → Tuple[int, list]¶

Run cape receive-file command

Receive posted file from remote host

Call:

>>> ierr, v = cape_receive_file(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape report command

Update automated PDF reports

Call:

>>> ierr, v = cape_report(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
compile: bool: Create images for report but don’t compile PDF
force: bool: Update report and ignore subfigure cache
report: bool | str: Generate the report RP or the first in the list
rm: bool: Remove report figures instead of updating report

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape review command

Interactively review report subfigures for case(s)

Call:

>>> ierr, v = cape_review(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
dpi: {120} | int: Resolution, in DPI, for converting PDF to image
force: bool: Update report and ignore subfigure cache
page: {0} | int: Page of PDF to display
report: bool | str: Generate the report RP or the first in the list
v: bool: Show additional output while running command

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape rm command

Delete entire case folders

Call:

>>> ierr, v = cape_rm(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
add-cols: str | list: Additional columns to show in run matrix status table
add-counters: str | list: Additional keys to show totals after run mat table
cols: str | list: Explicit list of status columns
counters: str | list: Explicit list of keys to show totals for in py{x} -c
hide-cols: str | list: Standard columns to hide in run matrix status table
hide-counters: str | list: Standard keys to omit totals after run mat table
j: bool: List PBS/Slurm job ID in -c output
rm: {True} | bool: Remove indicated cases
prompt: bool: Don’t ask for confirmation when deleting cases w/o iters

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_run(*, h: bool | None = None, solver: str | None = None) → Tuple[int, Any]¶

Run cape run command

Run case in current folder

Call:

>>> ierr, v = cape_run(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape search-large command

Find large cases from all run matrices in repo

Call:

>>> ierr, v = cape_search_large(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
pat: str: Consider file names matching pattern PAT
cutoff: str: Min file size or count for ‘large’

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_set_config(opt: str, *, h: bool | None = None, solver: str | None = None) → Tuple[int, list]¶

Run cape get-config command

Show value of user CAPE configuration

Call:

>>> ierr, v = cape_set_config(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
opt: str: CAPE user configuration variable name

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape skeleton command

Clean up case folder; leave only key files

Call:

>>> ierr, v = cape_skeleton(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
skeleton: bool: Delete most files from indicaded PASSED cases

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape start command

Setup, start, and/or submit cases

Call:

>>> ierr, v = cape_start(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
auto: bool: Ignore RunControl > NJob if set
n: int: Submit at most N cases
j: bool: List PBS/Slurm job ID in -c output
q: bool: Submit to PBS/Slurm queue QUEUE, overrides value in JSON file
qsub: bool: Don’t submit PBS/Slurm jobs even if otherwise specified
u: str: Pretend to be user UID
start: {True} | bool: Set up but do not start (or submit) cases

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape collect-cutplane command

Collect cut-plane data in current case folder

Call:

>>> ierr, v = cape_triangulate_cutplane(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
nsurf: int: Index of surface to process
batchsize: int: Number of snapshots to collect into each batch files
clean: {False} | bool: Remove files not necessary for running and not archived
nmax: int: Maximum number of snapshots to process
nproc: int: Number of parallel processes to use
adaptive: bool: Save the adapted-mesh version of flow data (more data)
constant: bool: Assume a fixed (not adaptive) mesh for data collection
fixed: bool: Interpolate flow data to common grid
raw: bool: Collect raw flow data w/o triangulating or interpolating

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_tui(*, h: bool | None = None, solver: str | None = None, tui: bool | None = None) → Tuple[int, Any]¶

Run cape tui command

Run rich interactive CAPE terminal user interface

Call:

>>> ierr, v = cape_tui(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
tui: bool: Run rich interactive CAPE terminal user interface

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.cape_ui(*, h: bool | None = None, solver: str | None = None, ui: bool | None = None) → Tuple[int, Any]¶

Run cape ui command

Run interactive CAPE user interface

Call:

>>> ierr, v = cape_ui(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
ui: bool: Run interactive CAPE user interface

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape unarchive command

Expand files from archive

Call:

>>> ierr, v = cape_unarchive(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
unarchive: bool: Unarchive one or more cases

Outputs:

ierr: int: Return code
v: any: Output from API function

Run cape unmark command

Remove PASS/ERROR markings for selected cases

Call:

>>> ierr, v = cape_unmark(*a, **kw)

Inputs:

h: bool: Print this help message and exit
solver: str: Name of CAPE module to use (or determine automatically)
I: str: Specific case indices, e.g. -I 4:8,12
cons: str: Constraints on run matrix keys, e.g. "mach>1.0"
f: str: Use the JSON (or YAML) file JSON
filter: str: Limit to cases containing the string TXT
glob: str: Limit to cases whose name matches the filename pattern PAT
marked: bool: Show only cases marked either PASS or ERROR
me: bool: Limit to cases owned by current user (equiv. --user $USER)
re: str: Limit to cases containing regular expression REGEX
status: str: Find cases with a specific status
unmarked: bool: Show cases with no PASS/ERROR markings
user: str: Restrict to cases with this username
x: str: Execute Python script PYSCRIPT after reading JSON
unmark: bool: Remove PASS/ERROR marking for case(s)

Outputs:

ierr: int: Return code
v: any: Output from API function

cape.cfdx.cli.main(argv: list | None = None) → int¶

Main interface to cape-cfdx

This is basically an interface to cape.cfdx.cntl.Cntl.cli().

Call:

>>> main()

Versions:

2021-03-04 @ddalle: v1.0

cape.cfdx.cli.main1(argv: list | None = None) → int¶

cape.cfdx.cli.main_template(parser_cls: CfdxFrontDesk, argv: list | None = None) → int¶

cape.cfdx.cli.read_cntl(cls: ArgReader, *a, **kw)¶

Read a CAPE run matrix control instance of appropriate class

Call:

>>> cntl, parsed_kw = read_cntl_quiet(cls, *a, **kw)

Inputs:

cls: type: Subclass of CfdxArgReader to parse args with
a: tuple: Args passed by main function
kw: dict: Keyword args passed by main function

Outputs:

cntl: cape.cfdx.cntl.Cntl: CAPE run matrix control instance (solver-specific)
parsed_kw: dict: Kwargs with checks and aliases applied

Versions:

2024-12-19 @ddalle: v1.0
2025-01-24 @ddalle: v2.0; use module name instead of cls

cape.cfdx.cli.read_cntl_cache(fname: str | None, solver: str | None = None) → CntlBase¶

Read a CAPE JSON file

Call:

>>> cntl = read_cntl_cache(fname=None, solver=None)

Inputs:

fname: {None} | str: Name of JSON file (or use most recent)
solver: {None} | str: Solver module (or determine based on fname)

Outputs:

cntl: cape.cfdx.cntl.Cntl: CAPE run matrix control instance (solver-specific)

cape.cfdx.cli.read_cntl_q(fname: str | None = None, solver: str | None = None) → CntlBase¶

Read a CAPE JSON file; suppress STDOUT temporarily

Call:

>>> cntl = read_cntl_q(fname=None, solver=None)

Inputs:

fname: {None} | str: Name of JSON file (or use most recent)
solver: {None} | str: Solver module (or determine based on fname)

Outputs:

cntl: cape.cfdx.cntl.Cntl: CAPE run matrix control instance (solver-specific)

cape.cfdx.cli.read_cntl_quiet(cls: ArgReader, *a, **kw)¶

Read a CAPE run matrix control instance; suppress STDOUT

Call:

>>> cntl, parsed_kw = read_cntl_quiet(cls, *a, **kw)

Inputs:

cls: type: Subclass of CfdxArgReader to parse args with
a: tuple: Args passed by main function
kw: dict: Keyword args passed by main function

Outputs:

cntl: cape.cfdx.cntl.Cntl: CAPE run matrix control instance (solver-specific)
parsed_kw: dict: Kwargs with checks and aliases applied

cape.cfdx.cli.read_runner(**kw) → tuple¶

Read a CAPE case runner instance to interact with CFD in $PWD

Call:

>>> runner, kw = read_runner(**kw)

Inputs:

solver: {None} | str: Solver module (e.g. "pyfun"), or auto-determine

Outputs:

runner: cape.cfdx.casecntl.CaseRunner: Case runner instance to control case in current folder
kw: dict: Preprocessed keyword arguments

Versions:

2024-12-30 @ddalle: v1.0
2025-01-24 @ddalle: v2.0; use module name instead of cls

`cape.cfdx.cli`: Command-line interface to `cape` (executable)¶

Previous topic

Next topic

This Page

cape.cfdx.cli: Command-line interface to cape (executable)¶

`cape.cfdx.cli`: Command-line interface to `cape` (executable)¶