`cape`: Control run matrix or case for any solver¶

Usage:

$ cape CMD [ARGS] [OPTIONS]

Sub-commands:

help: Display help message and exit
run: Run case in current folder
start: Setup, start, and/or submit cases
check: Check status of case(s)
agent: Run one CAPE agent prompt and exit
agentic: Run CAPE in agentic mode
1to2: Convert Python and JSON files from CAPE 1 to 2 standard
apply: Re-apply current settings to case(s)
approve: Mark selected cases as complete
archive: Archive cases; delete files not needed for post-processing
batch: Resubmit this command as a PBS/Slurm job
check-db: Check completion of all databook components
check-fm: Check completion of all force & moment components
check-ll: Check completion of all line load components
check-triqfm: Check completion of TriqFM components
clean: Remove extra files not necessary for running a case
collect-cutplane: Collect cut-plane data in current case folder
collect-surf: Collect surface data in current case folder
defail: Remove FAIL files from case(s)and other failure artifacts
dezombie: Delete job and clean-up stalled cases (aka ‘zombie’ cases)
dispatch: Interactively dispatch case(s) by status only
edit-json: Edit JSON settings from command-line
exec: Run a shell command in folder of case(s)
extend: Extend unmarked cases
extract: Extract DataBook components
extract-fm: Extract averaged force & moment results
extract-iter-fm: Extract iterative force & moment histories
extract-ll: Compute and extract line load results
extract-pyfunc: Extract data from custom Python functions
extract-prop: Extract other scalar results
extract-surfcp: Extract surfcp data
extract-timeseries: Extract time series data
extract-triqfm: Extract post-processed patch loads
extract-triqpt: Collect post-processed point sensor data
fail: Mark selected cases as ERRORs
find: Find indices of cases meeting constraints
find-cases: Control run matrix or case for any solver
find-json: Find CAPE JSON files
find-large: Find folders with large file size
get-col-state: Show iterative state of one column for case(s)
get-config: Show value of user CAPE configuration
get-keys: Show properties of run matrix keys as JSON
get-subfig: Create one report subfigure and cache its image
help-opt: Show help and docs for JSON options
inspect-json: Show item or subset of JSON options
list-keys: List run matrix keys
list-subfigs: List report subfigures
open-pdf: Open a PDF file in preferred reader
open-img: Open an image file in preferred viewer
open-png: Open a PNG image in preferred viewer
open-subfig: Create one report subfigure and open its image
perform: Perform an Actions action on case(s)
post-file: Send one or more files to RemoteHost
qdel: Delete PBS/Slurm job of case(s)
receive-file: Receive posted file from remote host
report: Update automated PDF reports
review: Interactively review report subfigures for case(s)
rm: Delete entire case folders
search-large: Find large cases from all run matrices in repo
set-config: Set value of a user CAPE configuration
get-case-state: Show iterative state of report columns for case(s)
skeleton: Clean up case folder; leave only key files
triangulate-cutplane: Triangulate oversetting cut-plane flow viz files
tui: Run rich interactive CAPE terminal user interface
ui: Run interactive CAPE user interface
unarchive: Expand files from archive
unmark: Remove PASS/ERROR markings for selected cases

Options:

-h, --help: Print this help message and exit
-f, --file, --json JSON: Use the JSON (or YAML) file JSON
-n N: Submit at most N cases
-I INDS: Specific case indices, e.g. -I 4:8,12
--cons, --constraints CONS: Constraints on run matrix keys, e.g. "mach>1.0"
--re, --regex REGEX: Limit to cases containing regular expression REGEX
--me: Limit to cases owned by current user (equiv. --user $USER)
--marked: Show only cases marked either PASS or ERROR
--unmarked: Show cases with no PASS/ERROR markings
--batch: Submit PBS/Slurm job and run this command there
-e, --exec EXEC: Execute the command EXEC
--no-restart: When submitting new jobs, only submit new cases
--no-start: Set up but do not start (or submit) cases
-x PYSCRIPT: Execute Python script PYSCRIPT after reading JSON

`cape help`: Display help message and exit¶

Prints the main help message shown above.

`cape run`: Run case in current folder¶

Usage:

$ cape run [OPTIONS]

Options:

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

`cape start`: Setup, start, and/or submit cases¶

Usage:

$ cape start [OPTIONS]

Options:

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

`cape check`: Check status of one or more cases¶

Usage:

$ cape check [OPTIONS]

Options:

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

`cape agent`: Run one CAPE agent prompt and exit¶

Usage:

$ cape agent [OPTIONS]

Options:

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

`cape agentic`: Run CAPE in agentic mode¶

Usage:

$ cape agentic [OPTIONS]

Options:

-h, --help: Print this help message and exit
--solver SOLVER: Name of CAPE module to use (or determine automatically)
--no-agent-tui: Disable the Textual interface for interactive CAPE agent
--agentic: Run CAPE in interactive agentic mode

`cape 1to2`: Convert Python and JSON files from CAPE 1 to 2 standard¶

Usage:

$ cape 1to2 [OPTIONS]

Options:

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

`cape apply`: Re-apply current settings to case(s)¶

Usage:

$ cape apply [OPTIONS]

Options:

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

`cape approve`: Mark selected cases as complete¶

Usage:

$ cape approve [OPTIONS]

Options:

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

`cape archive`: Archive cases; delete files not needed for post-processing¶

Usage:

$ cape archive [OPTIONS]

Options:

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

`cape batch`: Submit CAPE command as a PBS/Slurm batch job¶

Usage:

$ cape batch [OPTIONS]

Options:

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

`cape check-db`: Check completion of all databook components¶

Usage:

$ cape check-db [OPTIONS]

Options:

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

`cape check-fm`: Check completion of all force & moment components¶

Usage:

$ cape check-fm [OPTIONS]

Options:

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

`cape check-ll`: Check completion of all line load components¶

Usage:

$ cape check-ll [OPTIONS]

Options:

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

`cape check-triqfm`: Check completion of TriqFM components¶

Usage:

$ cape check-triqfm [OPTIONS]

Options:

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

`cape clean`: Remove extra files not necessary for running a case¶

Usage:

$ cape clean [OPTIONS]

Options:

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

`cape collect-cutplane`: Collect cut-plane data in current case folder¶

Usage:

$ cape collect-cutplane [NSURF] [OPTIONS]

Arguments:

NSURF: Index of surface to process

Options:

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

`cape collect-surf`: Collect surface data in current case folder¶

Usage:

$ cape collect-surf [NSURF] [OPTIONS]

Arguments:

NSURF: Index of surface to process 1

Options:

-h, --help: Print this help message and exit
--solver SOLVER: Name of CAPE module to use (or determine automatically)
--nsurf, --surf SURF: Index of surface to process {1}
--batchsize, --nbatch N: Number of snapshots to collect into each batch files
--clean: Remove files not necessary for running and not archived {False}
--nmax NMAX: Maximum number of snapshots to process
--nproc NPROC: Number of parallel processes to use

`cape defail`: Remove FAIL files from case(s)and other failure artifacts¶

Usage:

$ cape defail [OPTIONS]

Options:

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

`cape dezombie`: Delete job and clean-up stalled cases (aka ‘zombie’ cases)¶

Usage:

$ cape dezombie [OPTIONS]

Options:

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

`cape dispatch`: Interactively dispatch case(s) by status only¶

Usage:

$ cape dispatch [OPTIONS]

Options:

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

`cape edit-json`: Edit JSON settings from command-line¶

Usage:

$ cape edit-json [EDIT] [OPTIONS]

Arguments:

EDIT: Text of JSON settings to edit and rewrite

Options:

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

`cape exec`: Run a shell command in folder of case(s)¶

Usage:

$ cape exec [OPTIONS]

Options:

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

`cape extend`: Extend unmarked cases¶

Usage:

$ cape extend [OPTIONS]

Options:

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

–extend [N_EXT]: Extend case(s) by N_EXT copies of last phase {1}

--imax M: Do not extend a case beyond iteration M
--no-qsub: Don’t submit PBS/Slurm jobs even if otherwise specified {False}

`cape extract`: Extract DataBook components¶

Usage:

$ cape extract [DEX] [OPTIONS]

Arguments:

DEX: Extract DataBook components matching pattern DEX

Options:

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

–dex [DEX]: Extract DataBook components matching pattern DEX

`cape extract-fm`: Extract averaged force & moment results¶

Usage:

$ cape extract-fm [FM] [OPTIONS]

Arguments:

FM: Extract force & moment data [comps matching PAT] for case(s)

Options:

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

–fm, –aero [PAT]: Extract force & moment data [comps matching PAT] for case(s)

`cape extract-iter-fm`: Extract iterative force & moment histories¶

Usage:

$ cape extract-iter-fm [ITER-FM] [OPTIONS]

Arguments:

ITER-FM: Extract iterative force & moment histories

Options:

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

–iter-fm, –iterfm [PAT]: Extract iterative force & moment histories

`cape extract-ll`: Compute and extract line load results¶

Usage:

$ cape extract-ll [LL] [OPTIONS]

Arguments:

LL: Extract line load data [comps matching PAT] for case(s)

Options:

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

–ll [PAT]: Extract line load data [comps matching PAT] for case(s)

`cape extract-pyfunc`: Extract data from custom Python functions¶

Usage:

$ cape extract-pyfunc [DBPYFUNC] [OPTIONS]

Arguments:

DBPYFUNC: Extract scalar data from custom Python function

Options:

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

–dbpyfunc [PAT]: Extract scalar data from custom Python function

`cape extract-prop`: Extract other scalar results¶

Usage:

$ cape extract-prop [PROP] [OPTIONS]

Arguments:

PROP: Extract scalar properties [comps matching PAT]

Options:

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

–prop [PAT]: Extract scalar properties [comps matching PAT]

`cape extract-surfcp`: Extract surfcp data¶

Usage:

$ cape extract-surfcp [SURFCP] [OPTIONS]

Arguments:

SURFCP: Extract surface pressure data for case(s)

Options:

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

`cape extract-timeseries`: Extract time series data¶

Usage:

$ cape extract-timeseries [TS] [OPTIONS]

Arguments:

TS: Extract time-series data [comps matching PAT]

Options:

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

–ts [PAT]: Extract time-series data [comps matching PAT]

`cape extract-triqfm`: Extract post-processed patch loads¶

Usage:

$ cape extract-triqfm [TRIQFM] [OPTIONS]

Arguments:

TRIQFM: Extract triq F&M data [comps matching PAT] for case(s)

Options:

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

–triqfm [PAT]: Extract triq F&M data [comps matching PAT] for case(s)

`cape extract-triqpt`: Collect post-processed point sensor data¶

Usage:

$ cape extract-triqpt [OPTIONS]

Options:

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

–pt [PAT]: Extract surf point sensors [comps matching PAT] for case(s)

`cape fail`: Mark selected cases as ERRORs¶

Usage:

$ cape fail [OPTIONS]

Options:

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

`cape find`: Find indices of cases meeting constraints¶

Usage:

$ cape find [OPTIONS]

Options:

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

`cape find-cases`: Find indices of cases meeting constraints¶

Usage:

$ cape find [OPTIONS]

Options:

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

`cape find-json`: Find CAPE JSON files¶

Usage:

$ cape find-json [PAT] [OPTIONS]

Arguments:

PAT: Consider file names matching pattern PAT

Options:

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

`cape find-large`: Find folders with large file size¶

Usage:

$ cape find-large [CUTOFF] [OPTIONS]

Arguments:

CUTOFF: Min file size or count for ‘large’

Options:

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

`cape get-col-state`: Show iterative state of one column for case(s)¶

Usage:

$ cape get-col-state [COMP [COL]] [OPTIONS]

Arguments:

COMP: Name of DataBook component COL: Name of column to analyze

Options:

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

`cape get-config`: Show value of user CAPE configuration¶

Usage:

$ cape get-config [OPT] [OPTIONS]

Arguments:

OPT: CAPE user configuration variable name

Options:

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

`cape get-keys`: Show properties of run matrix keys as JSON¶

Usage:

$ cape get-keys [OPTIONS]

Options:

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

`cape get-subfig`: Create one report subfigure and cache its image¶

Usage:

$ cape get-subfig [SUBFIG] [OPTIONS]

Arguments:

SUBFIG: Name of report subfigure to create

Options:

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

`cape help-opt`: Show help and docs for JSON options¶

Usage:

$ cape help-opt [JQ] [OPTIONS]

Arguments:

JQ: Show help for JSON option or section at path JQ

Options:

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

`cape inspect-json`: Show item or subset of JSON options¶

Usage:

$ cape inspect-json [JQ] [OPTIONS]

Arguments:

JQ: Show item or subset of JSON options at path JQ

Options:

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

`cape list-keys`: List run matrix keys¶

Usage:

$ cape list-keys [OPTIONS]

Options:

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

`cape list-subfigs`: List report subfigures¶

Usage:

$ cape list-subfigs [OPTIONS]

Options:

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

–report [RP]: Generate the report RP or the first in the list

`cape open-pdf`: Open a PDF file in preferred reader¶

Usage:

$ cape open-pdf [FPDF] [OPTIONS]

Arguments:

FPDF: Name of PDF file to open/write/send

Options:

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

`cape open-img`: Open an image file in preferred viewer¶

Usage:

$ cape open-img [IMG] [OPTIONS]

Arguments:

IMG: Name of image file to open

Options:

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

`cape open-png`: Open a PNG image in preferred viewer¶

Usage:

$ cape open-png [FPNG] [OPTIONS]

Arguments:

FPNG: Name of PNG image file to open

Options:

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

`cape open-subfig`: Create one report subfigure and open its image¶

Usage:

$ cape open-subfig [SUBFIG] [OPTIONS]

Arguments:

SUBFIG: Name of report subfigure to create

Options:

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

`cape perform`: Perform an Actions action on case(s)¶

Usage:

$ cape perform [ACTION] [OPTIONS]

Arguments:

ACTION: Name of Actions action to perform on case(s)

Options:

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

`cape post-file`: Send one or more files to RemoteHost¶

Usage:

$ cape post-file PAT [PATS] [OPTIONS]

Arguments:

PAT: Consider file names matching pattern PAT PATS: Additional file name patterns

Options:

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

`cape qdel`: Delete PBS/Slurm job of case(s)¶

Usage:

$ cape qdel [OPTIONS]

Options:

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

`cape receive-file`: Receive posted file from remote host¶

Usage:

$ cape receive-file [OPTIONS]

Options:

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

`cape report`: Update automated PDF reports¶

Usage:

$ cape report [OPTIONS]

Options:

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

–report [RP]: Generate the report RP or the first in the list

--rm: Remove report figures instead of updating report

`cape review`: Interactively review report subfigures for case(s)¶

Usage:

$ cape review [OPTIONS]

Options:

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

–report [RP]: Generate the report RP or the first in the list

-v, --verbose: Show additional output while running command

`cape rm`: Delete entire case folders¶

Usage:

$ cape rm [OPTIONS]

Options:

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

`cape search-large`: Find large cases from all run matrices in repo¶

Usage:

$ cape search-large [PAT [CUTOFF]] [OPTIONS]

Arguments:

PAT: Consider file names matching pattern PAT CUTOFF: Min file size or count for ‘large’

Options:

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

`cape set-config`: Set value of a user CAPE configuration¶

Usage:

$ cape set-config [OPT [VAL]] [OPTIONS]

Arguments:

OPT: CAPE user configuration variable name VAL: Value to set option to

Options:

-h, --help: Print this help message and exit
--solver SOLVER: Name of CAPE module to use (or determine automatically)
--opt OPT: CAPE user configuration variable name
--val VALUE: Value to set option to
--blend: Combine option values rather than overwrite

`cape get-case-state`: Show iterative state of report columns for case(s)¶

Usage:

$ cape get-case-state [OPTIONS]

Options:

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

`cape skeleton`: Clean up case folder; leave only key files¶

Usage:

$ cape skeleton [OPTIONS]

Options:

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

`cape triangulate-cutplane`: Triangulate oversetting cut-plane flow viz files¶

Usage:

$ cape triangulate-cutplane [NSURF] [OPTIONS]

Arguments:

NSURF: Index of surface to process

Options:

-h, --help: Print this help message and exit
--solver SOLVER: Name of CAPE module to use (or determine automatically)
--nproc NPROC: Number of parallel processes to use
--nsurf, --surf SURF: Index of surface to process
--clean: Remove files not necessary for running and not archived {False}
--nmax NMAX: Maximum number of snapshots to process

`cape tui`: Run rich interactive CAPE terminal user interface¶

Usage:

$ cape tui [OPTIONS]

Options:

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

`cape ui`: Run interactive CAPE user interface¶

Usage:

$ cape ui [OPTIONS]

Options:

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

`cape unarchive`: Expand files from archive¶

Usage:

$ cape unarchive [OPTIONS]

Options:

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

`cape unmark`: Remove PASS/ERROR markings for selected cases¶

Usage:

$ cape unmark [OPTIONS]

Options:

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

cape: Control run matrix or case for any solver¶

cape help: Display help message and exit¶

cape run: Run case in current folder¶

cape start: Setup, start, and/or submit cases¶

cape check: Check status of one or more cases¶

cape agent: Run one CAPE agent prompt and exit¶

cape agentic: Run CAPE in agentic mode¶

cape 1to2: Convert Python and JSON files from CAPE 1 to 2 standard¶

cape apply: Re-apply current settings to case(s)¶

cape approve: Mark selected cases as complete¶

cape archive: Archive cases; delete files not needed for post-processing¶

cape batch: Submit CAPE command as a PBS/Slurm batch job¶

cape check-db: Check completion of all databook components¶

cape check-fm: Check completion of all force & moment components¶

cape check-ll: Check completion of all line load components¶

cape check-triqfm: Check completion of TriqFM components¶

cape clean: Remove extra files not necessary for running a case¶

cape collect-cutplane: Collect cut-plane data in current case folder¶

cape collect-surf: Collect surface data in current case folder¶

cape defail: Remove FAIL files from case(s)and other failure artifacts¶

cape dezombie: Delete job and clean-up stalled cases (aka ‘zombie’ cases)¶

cape dispatch: Interactively dispatch case(s) by status only¶

cape edit-json: Edit JSON settings from command-line¶

cape exec: Run a shell command in folder of case(s)¶

cape extend: Extend unmarked cases¶

cape extract: Extract DataBook components¶

cape extract-fm: Extract averaged force & moment results¶

cape extract-iter-fm: Extract iterative force & moment histories¶

cape extract-ll: Compute and extract line load results¶

cape extract-pyfunc: Extract data from custom Python functions¶

cape extract-prop: Extract other scalar results¶

cape extract-surfcp: Extract surfcp data¶

cape extract-timeseries: Extract time series data¶

cape extract-triqfm: Extract post-processed patch loads¶

cape extract-triqpt: Collect post-processed point sensor data¶

cape fail: Mark selected cases as ERRORs¶

cape find: Find indices of cases meeting constraints¶

cape find-cases: Find indices of cases meeting constraints¶

cape find-json: Find CAPE JSON files¶

cape find-large: Find folders with large file size¶

cape get-col-state: Show iterative state of one column for case(s)¶

cape get-config: Show value of user CAPE configuration¶

cape get-keys: Show properties of run matrix keys as JSON¶

cape get-subfig: Create one report subfigure and cache its image¶

cape help-opt: Show help and docs for JSON options¶

cape inspect-json: Show item or subset of JSON options¶

cape list-keys: List run matrix keys¶

cape list-subfigs: List report subfigures¶

cape open-pdf: Open a PDF file in preferred reader¶

cape open-img: Open an image file in preferred viewer¶

cape open-png: Open a PNG image in preferred viewer¶

cape open-subfig: Create one report subfigure and open its image¶

cape perform: Perform an Actions action on case(s)¶

cape post-file: Send one or more files to RemoteHost¶

cape qdel: Delete PBS/Slurm job of case(s)¶

cape receive-file: Receive posted file from remote host¶

cape report: Update automated PDF reports¶

cape review: Interactively review report subfigures for case(s)¶

cape rm: Delete entire case folders¶

cape search-large: Find large cases from all run matrices in repo¶

cape set-config: Set value of a user CAPE configuration¶

cape get-case-state: Show iterative state of report columns for case(s)¶

cape skeleton: Clean up case folder; leave only key files¶

cape triangulate-cutplane: Triangulate oversetting cut-plane flow viz files¶

cape tui: Run rich interactive CAPE terminal user interface¶

cape ui: Run interactive CAPE user interface¶

cape unarchive: Expand files from archive¶

cape unmark: Remove PASS/ERROR markings for selected cases¶

`cape`: Control run matrix or case for any solver¶

`cape help`: Display help message and exit¶

`cape run`: Run case in current folder¶

`cape start`: Setup, start, and/or submit cases¶

`cape check`: Check status of one or more cases¶

`cape agent`: Run one CAPE agent prompt and exit¶

`cape agentic`: Run CAPE in agentic mode¶

`cape 1to2`: Convert Python and JSON files from CAPE 1 to 2 standard¶

`cape apply`: Re-apply current settings to case(s)¶

`cape approve`: Mark selected cases as complete¶

`cape archive`: Archive cases; delete files not needed for post-processing¶

`cape batch`: Submit CAPE command as a PBS/Slurm batch job¶

`cape check-db`: Check completion of all databook components¶

`cape check-fm`: Check completion of all force & moment components¶

`cape check-ll`: Check completion of all line load components¶

`cape check-triqfm`: Check completion of TriqFM components¶

`cape clean`: Remove extra files not necessary for running a case¶

`cape collect-cutplane`: Collect cut-plane data in current case folder¶

`cape collect-surf`: Collect surface data in current case folder¶

`cape defail`: Remove FAIL files from case(s)and other failure artifacts¶

`cape dezombie`: Delete job and clean-up stalled cases (aka ‘zombie’ cases)¶

`cape dispatch`: Interactively dispatch case(s) by status only¶

`cape edit-json`: Edit JSON settings from command-line¶

`cape exec`: Run a shell command in folder of case(s)¶

`cape extend`: Extend unmarked cases¶

`cape extract`: Extract DataBook components¶

`cape extract-fm`: Extract averaged force & moment results¶

`cape extract-iter-fm`: Extract iterative force & moment histories¶

`cape extract-ll`: Compute and extract line load results¶

`cape extract-pyfunc`: Extract data from custom Python functions¶

`cape extract-prop`: Extract other scalar results¶

`cape extract-surfcp`: Extract surfcp data¶

`cape extract-timeseries`: Extract time series data¶

`cape extract-triqfm`: Extract post-processed patch loads¶

`cape extract-triqpt`: Collect post-processed point sensor data¶

`cape fail`: Mark selected cases as ERRORs¶

`cape find`: Find indices of cases meeting constraints¶

`cape find-cases`: Find indices of cases meeting constraints¶

`cape find-json`: Find CAPE JSON files¶

`cape find-large`: Find folders with large file size¶

`cape get-col-state`: Show iterative state of one column for case(s)¶

`cape get-config`: Show value of user CAPE configuration¶

`cape get-keys`: Show properties of run matrix keys as JSON¶

`cape get-subfig`: Create one report subfigure and cache its image¶

`cape help-opt`: Show help and docs for JSON options¶

`cape inspect-json`: Show item or subset of JSON options¶

`cape list-keys`: List run matrix keys¶

`cape list-subfigs`: List report subfigures¶

`cape open-pdf`: Open a PDF file in preferred reader¶

`cape open-img`: Open an image file in preferred viewer¶

`cape open-png`: Open a PNG image in preferred viewer¶

`cape open-subfig`: Create one report subfigure and open its image¶

`cape perform`: Perform an Actions action on case(s)¶

`cape post-file`: Send one or more files to RemoteHost¶

`cape qdel`: Delete PBS/Slurm job of case(s)¶

`cape receive-file`: Receive posted file from remote host¶

`cape report`: Update automated PDF reports¶

`cape review`: Interactively review report subfigures for case(s)¶

`cape rm`: Delete entire case folders¶

`cape search-large`: Find large cases from all run matrices in repo¶

`cape set-config`: Set value of a user CAPE configuration¶

`cape get-case-state`: Show iterative state of report columns for case(s)¶

`cape skeleton`: Clean up case folder; leave only key files¶

`cape triangulate-cutplane`: Triangulate oversetting cut-plane flow viz files¶

`cape tui`: Run rich interactive CAPE terminal user interface¶

`cape ui`: Run interactive CAPE user interface¶

`cape unarchive`: Expand files from archive¶

`cape unmark`: Remove PASS/ERROR markings for selected cases¶