pycopm.utils.input_values module

Create configuration objects from command-line arguments and TOML files.

pycopm.utils.input_values.create_deck_config(cmdargs: dict[str, str]) → ConfigViaDeck

Create a deck configuration from parsed command arguments.

Parameters:

cmdargs – Arguments returned by the command-line parser.

Returns:

Configuration for a deck-based workflow.

Return type:

ConfigViaDeck

pycopm.utils.input_values.load_toml_config(input_file: str, output_directory: str, resource_directory: str, significant_digits: int) → ConfigViaTOML

Load a TOML configuration and derive reference-grid dimensions.

Parameters:

• input_file – TOML configuration path.

• output_directory – Generated-project directory.

• resource_directory – Directory containing templates and reference simulations.

• significant_digits – Precision used when writing floating-point values.

Returns:

Validated configuration populated with reference-grid metadata.

Return type:

ConfigViaTOML

pycopm.utils.input_values.parse_axis_modifications(uniform: str, localized: list) → tuple[NDArray, list]

Parse uniform or axis-specific grid modifications.

Uniform input contains one value for each axis. Axis-specific input can contain explicit arrays; coarsening also accepts one-based indices and inclusive ranges such as 2:4,7.

Parameters:

• uniform – Comma-separated x, y, and z modification values.

• localized – Axis-specific specifications in x, y, and z order.

Returns:

Uniform axis values and the three parsed axis-specific arrays. Only one representation is populated.

Return type:

cijk, axis_values