getresultsvar_fordims API Reference

geoloop.utils.helpers.getresultsvar_fordims

getresultsvar_fordims(
    var_names_dim: list[str], results_object: Any
) -> np.ndarray

Extract an array of result values for specified variable names from a results object.

Parameters:

Name	Type	Description	Default
`var_names_dim`	`list of str`	List of variable names to extract from the results object.	required
`results_object`	`SingleRunResult`	SingleRunResult object containing the results of a single model run. The function will attempt to access each variable as an attribute of this object.	required

Returns:

Type	Description
`ndarray`	Array of result values corresponding to the requested variable names. If a variable is not present in the object, `None` is used for that entry.

Notes

The resulting array preserves the order of var_names_dim.