cape.pyover.options.runctlopts: OVERFLOW run control options

This is the "RunControl" options module specific to cape.pyover. It is based primarily on

and provides the class

Among the OVERFLOW-specific options interfaced here are the options for the OVERFLOW executables, defined in the "overrun" section

class cape.pyover.options.runctlopts.OverrunOpts(*args, **kw)

Class for overrun settings

Call:
>>> opts = OverrunOpts(**kw)
Inputs:
kw: dict

Raw options

Outputs:
opts: OverrunOpts

CLI options for overrun or overrunmpi

Versions:

  • 2016-02-01 @ddalle: Version 1.0 (flowCart)

  • 2022-11-04 @ddalle: Version 2.0; use optdict

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

Get string of extra args to overrun

Call:
>>> args = opts.get_overrun_args(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
args: {''} | str

string of extra args to overrun

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

Get auxiliary CLI args to overrun

Call:
>>> aux = opts.get_overrun_aux(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
aux: {'"-v pcachem -- dplace -s1"'} | str

auxiliary CLI args to overrun

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

Get name of OVERFLOW executable to use

Call:
>>> cmd = opts.get_overrun_cmd(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
cmd: {'overrunmpi'} | str

name of OVERFLOW executable to use

get_overrun_kw(j=None, **kw)

Get other inputs to overrun

Call:
>>> kw = opts.get_overrun_kw(i=None)
Inputs:
opts: cape.pyover.options.Options

Options interface

i: int

Phase number

Outputs:
kw: dict

Dictionary of additional arguments to overrun

Versions:

  • 2016-02-01 @ddalle: Version 1.0

  • 2022-11-03 @ddalle: Version 2.0; OptionsDict

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

Get number of OpenMP threads

Call:
>>> nthreads = opts.get_overrun_nthreads(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
nthreads: {None} | int

number of OpenMP threads

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

Get overrun verbosity option

Call:
>>> v = opts.get_overrun_v(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
v: {None} | True | False

overrun verbosity option

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

Get string of extra args to overrun

Call:
>>> opts.set_overrun_args(args, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

args: {''} | str

string of extra args to overrun

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_overrun_aux(v, j=None, mode=None)

Get auxiliary CLI args to overrun

Call:
>>> opts.set_overrun_aux(aux, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

aux: {'"-v pcachem -- dplace -s1"'} | str

auxiliary CLI args to overrun

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_overrun_cmd(v, j=None, mode=None)

Get name of OVERFLOW executable to use

Call:
>>> opts.set_overrun_cmd(cmd, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

cmd: {'overrunmpi'} | str

name of OVERFLOW executable to use

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_overrun_nthreads(v, j=None, mode=None)

Get number of OpenMP threads

Call:
>>> opts.set_overrun_nthreads(nthreads, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

nthreads: {None} | int

number of OpenMP threads

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_overrun_v(v, j=None, mode=None)

Get overrun verbosity option

Call:
>>> opts.set_overrun_v(v, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

v: {None} | True | False

overrun verbosity option

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

class cape.pyover.options.runctlopts.RunControlOpts(*args, **kw)
apply_ArchiveTemplate()

Apply OVERFLOW-specific archiving defaults

Call:
>>> opts.apply_ArchiveTemplate()
Inputs:
opts: ArchiveOpts

Options interface

Versions:

  • 2016-02-29 @ddalle: v1.0

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

Get project root name, or file prefix

Call:
>>> Prefix = opts.get_Prefix(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:
Prefix: {'run'} | str

project root name, or file prefix

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

Get value of option “overrun”

Call:
>>> overrun = opts.get_overrun(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:
overrun: {None} | object

value of option “overrun”

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

Get string of extra args to overrun

Call:
>>> args = opts.get_overrun_args(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
args: {''} | str

string of extra args to overrun

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

Get auxiliary CLI args to overrun

Call:
>>> aux = opts.get_overrun_aux(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
aux: {'"-v pcachem -- dplace -s1"'} | str

auxiliary CLI args to overrun

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

Get name of OVERFLOW executable to use

Call:
>>> cmd = opts.get_overrun_cmd(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
cmd: {'overrunmpi'} | str

name of OVERFLOW executable to use

get_overrun_kw(j=None, **kw)

Get other inputs to overrun

Call:
>>> kw = opts.get_overrun_kw(i=None)
Inputs:
opts: cape.pyover.options.Options

Options interface

i: int

Phase number

Outputs:
kw: dict

Dictionary of additional arguments to overrun

Versions:

  • 2016-02-01 @ddalle: Version 1.0

  • 2022-11-03 @ddalle: Version 2.0; OptionsDict

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

Get number of OpenMP threads

Call:
>>> nthreads = opts.get_overrun_nthreads(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
nthreads: {None} | int

number of OpenMP threads

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

Get overrun verbosity option

Call:
>>> v = opts.get_overrun_v(j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

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:
v: {None} | True | False

overrun verbosity option

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

Get project root name, or file prefix

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

options interface

Prefix: {'run'} | 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_overrun(v, j=None, mode=None)

Get value of option “overrun”

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

options interface

overrun: {None} | object

value of option “overrun”

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_overrun_args(v, j=None, mode=None)

Get string of extra args to overrun

Call:
>>> opts.set_overrun_args(args, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

args: {''} | str

string of extra args to overrun

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_overrun_aux(v, j=None, mode=None)

Get auxiliary CLI args to overrun

Call:
>>> opts.set_overrun_aux(aux, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

aux: {'"-v pcachem -- dplace -s1"'} | str

auxiliary CLI args to overrun

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_overrun_cmd(v, j=None, mode=None)

Get name of OVERFLOW executable to use

Call:
>>> opts.set_overrun_cmd(cmd, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

cmd: {'overrunmpi'} | str

name of OVERFLOW executable to use

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_overrun_nthreads(v, j=None, mode=None)

Get number of OpenMP threads

Call:
>>> opts.set_overrun_nthreads(nthreads, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

nthreads: {None} | int

number of OpenMP threads

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_overrun_v(v, j=None, mode=None)

Get overrun verbosity option

Call:
>>> opts.set_overrun_v(v, j=None, i=None, **kw)
Inputs:
opts: OverrunOpts

options interface

v: {None} | True | False

overrun verbosity option

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