Skip to content

get_param_names API Reference

geoloop.utils.helpers.get_param_names 

get_param_names(
    config: (
        SingleRunConfig | StochasticRunConfig | None
    ) = None,
) -> tuple[list[str], list[str]]

Identify locked and variable parameter names from a configuration dictionary for Monte Carlo simulations.

These parameters are used to organize results in HDF5 files during simulation post-processing.

Parameters:

Name Type Description Default
config SingleRunConfig

Configuration object that may contain additional optional parameters. If provided, certain optional keys will be added to the list of locked parameters.

 None

Returns:

Type Description
tuple of (list of str, list of str)
  • variable_param_names : List of variable parameter names that can change between Monte Carlo runs.
  • locked_param_names : List of locked parameter names that remain fixed across runs. Optional parameters found in config are also included.