cape.pylch.options.runctlopts.py: Loci/CHEM run control options

This module provides special options for the "RunControl" section for operating Loci/CHEM. This includes a RunControlOpts class with additional options and classes for the Loci/CHEM executables.

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

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

Get value of option “ProjectName”

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

value of option “ProjectName”

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

Get path to Loci/CHEM executable

Call:

>>> executable = opts.get_chem_executable(j=None, i=None, **kw)

Inputs:

opts: ChemOpts

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

path to Loci/CHEM executable

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

Get value of option “ProjectName”

Call:

>>> opts.set_ProjectName(ProjectName, j=None, i=None, **kw)

Inputs:

opts: RunControlOpts

options interface

ProjectName: {'pylch'} | str

value of option “ProjectName”

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

Get path to Loci/CHEM executable

Call:

>>> opts.set_chem_executable(executable, j=None, i=None, **kw)

Inputs:

opts: ChemOpts

options interface

executable: {'chem'} | str

path to Loci/CHEM 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