cape.cfdx.environopts: Options for environment variables

This module provides the class EnvironOpts, which controls options for environment variables that users may wish to set at the beginning of each individual case in a run matrix.

class cape.cfdx.options.environopts.EnvironOpts(*args, **kw)

Class for environment variables

Call:

>>> opts = EnvironOpts(**kw)

Inputs:

kw: dict

Dictionary of environment variables

Outputs:

opts: cape.options.runControl.Environ

System environment variable options interface

Versions:

• 2015-11-10 @ddalle: v1.0 (Environ)

• 2022-10-28 @ddalle: v2.0; OptionsDict

get_Environ(opt, j=0, i=None)

Get an environment variable setting by name

Call:

>>> val = opts.get_Environ(opt, j=0)

Inputs:

opts: cape.options.Options

Options interface

opt: str

Name of the environment variable

i: {None} | int

Case index

j: {0} | None | int

Phase number

Outputs:

val: str

Value to set the environment variable to

Versions:

• 2015-11-10 @ddalle: v1.0

• 2022-10-29 @ddalle: v2.0; OptionsDict methods

set_Environ(opt, val, j=None)

Set an environment variable setting by name

Call:

>>> val = opts.get_Environ(opts, j=0)

Inputs:

opts: cape.options.Options

Options interface

opt: str

Name of the environment variable

val: str

Value to set the environment variable to

j: {None} | int

Phase index

Versions:

• 2015-11-10 @ddalle: v1.0

• 2022-10-29 @ddalle: v2.0; OptionsDict methods