spectre.file_io.toml_io

Utilities for reading and writing SPEC input parameters in TOML format.

Module Contents

spectre.file_io.toml_io.input_parameters_to_dict(params: spectre.file_io.input_parameters.InputParameters) → dict[str, Any]

Convert an InputParameters instance into a TOML-friendly mapping.

The returned dictionary contains only plain Python types (dict, list, int/float/bool/str). Numpy containers are converted to lists to ensure compatibility with tomli_w.

spectre.file_io.toml_io.input_parameters_from_dict(data: Mapping[str, Any]) → spectre.file_io.input_parameters.InputParameters

Create an InputParameters instance from a mapping.

spectre.file_io.toml_io.write_input_parameters_to_toml(params: spectre.file_io.input_parameters.InputParameters, destination: PathLike) → None

Serialise params to TOML and write them to destination.

Parameters

params:

The InputParameters instance to write.

destination:

Filesystem path that will be opened in binary write mode.

spectre.file_io.toml_io.read_input_parameters_from_toml(source: PathLike) → spectre.file_io.input_parameters.InputParameters

Read source and return an InputParameters instance.