cape.pykes.cmdgen: Create commands for Kestrel executables

This module creates system commands as lists of strings for executable binaries or scripts for Kestrel. The command-line interface to Kestrel is quite simple, so commands just take the form

$ csi -p NUMCORES -i XMLFILE
cape.pykes.cmdgen.csi(opts=None, j=0, **kw)

Create commands for main Kestrel executable

Call:
>>> cmdi = csi(opts, j=0)
>>> cmdi = csi(**kw)
Inputs:
opts: Options | RunControl

Global pykes options interface or “RunControl” interface

j: {0} | int

Phase number

nProc: {None} | int

Directly specified number of cores

XMLPrefix: {"kestrel"} | str

Directly specified XML prefix

xmlfile: {None} | str

Name of XML file; usually from proj

Outputs:
cmdi: list[str]

Command split into a list of strings

Versions:
  • 2021-10-20 @ddalle: Version 1.0