cape.pylava.options.lavaopts: Options for Superlava executable

class cape.pylava.options.lavaopts.SuperlavaOpts(*args, **kw)

Class for superlava settings

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

Raw options

Outputs:
opts: SuperlavaOpts

CLI options for superlava

Versions:

  • 2024-08-01 @sneuhoff: v1.0

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

Get path to superlava executable

Call:
>>> executable = opts.get_lava_executable(j=None, i=None, **kw)
Inputs:
opts: SuperlavaOpts

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

path to superlava executable

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

Get name of LAVA YAML file to use

Call:
>>> yamlfile = opts.get_lava_yamlfile(j=None, i=None, **kw)
Inputs:
opts: SuperlavaOpts

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:
yamlfile: {'run.yaml'} | str

name of LAVA YAML file to use

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

Get path to superlava executable

Call:
>>> opts.set_lava_executable(executable, j=None, i=None, **kw)
Inputs:
opts: SuperlavaOpts

options interface

executable: {'superlava'} | str

path to superlava executable

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

Get name of LAVA YAML file to use

Call:
>>> opts.set_lava_yamlfile(yamlfile, j=None, i=None, **kw)
Inputs:
opts: SuperlavaOpts

options interface

yamlfile: {'run.yaml'} | str

name of LAVA YAML file 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