pycart: Interact with Cart3D run matrix using CAPE

Usage:

$ pycart 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

Interact with Cart3D run matrix using CAPE

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