cmlm.utils.input_file

A module for interacting with (loading data from) input files.

Classes

TomlParmParse([file_name, allow_cl_override])

Query or get parameters from a TOML input file.

class cmlm.utils.input_file.TomlParmParse(file_name=None, allow_cl_override=True)

Bases: object

Query or get parameters from a TOML input file.

Inspired by the ParmParse class from AMReX

Parameters:

• file_name (str) – path to input file

• allow_cl_override (bool, optional) – if True, sys.argv[1] replaces file_name. Default True.

get(prefix, var)

Look up a value from the input file, if not present raise error.

Parameters:

• prefix (str) – section of TOML file

• var (str) – entry in TOML file

Returns:

value – value from TOML file

Return type:

any type

query(prefix, var, default)

Look up a value from the input file, if not present use default.

Parameters:

• prefix (str) – section of TOML file

• var (str) – entry in TOML file

• default (any type) – default to use if entry not found

Returns:

value – value from TOML file or default if not present

Return type:

any type