7.4. pyover
: Interact with OVERFLOW run matrix using CAPE¶
- Usage:
$ pyover 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)
apply
Interact with OVERFLOW run matrix using CAPE
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
dezombie
Delete job and clean-up stalled cases (aka ‘zombie’ cases)
exec
Run a shell command in folder of case(s)
extend
Extend unmarked cases
extract-fm
Extract averaged force & moment results
extract-ll
Compute and extract line load results
extract-pyfunc
Extract data from custom Python functions
extract-prop
Extract other scalar results
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
qdel
Delete PBS/Slurm job of case(s)
report
Update automated PDF reports
rm
Delete entire case folders
skeleton
Clean up case folder; leave only key files
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
- -j
List PBS/Slurm job ID in
-c
output- -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
- --filter TXT
Limit to cases containing the string TXT
- --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 {True}
- --no-start
Set up but do not start (or submit) cases {True}
- -q, --queue QUEUE
Submit to PBS/Slurm queue QUEUE, overrides value in JSON file
- -u UID
Pretend to be user UID
- -x PYSCRIPT
Execute Python script PYSCRIPT after reading JSON