cape.pykes.options.runctlopts: Run control options

Options interface for aspects of running a case of Kestrel. It is only moderately modified from the template module

class cape.pykes.options.runctlopts.RunControlOpts(*args, **kw)
get_ProjectName(j=None, i=None, **kw)

Get project root name, or file prefix

Call:
>>> ProjectName = opts.get_ProjectName(j=None, i=None, **kw)
Inputs:
opts: RunControlOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
ProjectName: {'pykes'} | str

project root name, or file prefix

get_XMLPrefix(j=None, i=None, **kw)

Get base name for Kestrel project XML files

Call:
>>> XMLPrefix = opts.get_XMLPrefix(j=None, i=None, **kw)
Inputs:
opts: RunControlOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
XMLPrefix: {'kestrel'} | str

base name for Kestrel project XML files

set_ProjectName(v, j=None, mode=None)

Get project root name, or file prefix

Call:
>>> opts.set_ProjectName(ProjectName, j=None, i=None, **kw)
Inputs:
opts: RunControlOpts

options interface

ProjectName: {'pykes'} | str

project root name, or file prefix

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_XMLPrefix(v, j=None, mode=None)

Get base name for Kestrel project XML files

Call:
>>> opts.set_XMLPrefix(XMLPrefix, j=None, i=None, **kw)
Inputs:
opts: RunControlOpts

options interface

XMLPrefix: {'kestrel'} | str

base name for Kestrel project XML files

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar