create_clp_guide_dataset

glotaran.utils.io.create_clp_guide_dataset(result: Result | xr.Dataset, clp_label: str, dataset_name: str | None = None) → xr.Dataset[source]

Create dataset for clp guidance.

Parameters:

  • result (Result | xr.Dataset) – Optimization result object or dataset, created with pyglotaran>=0.6.0.

  • clp_label (str) – Label of the clp to guide.

  • dataset_name (str | None) – Name of dataset to extract the guide from. Defaults to None.

Returns:

DataArray containing the clp guide, with clp_label dimension replaced by the model dimensions first value.

Return type:

xr.Dataset

Raises:

  • ValueError – If result is an instance of Result and dataset_name is None or not in result.

  • ValueError – If clp_labels is not in result.

  • ValueError – The result dataset was created with pyglotaran<0.6.0.

Examples

Extracting the clp guide from an optimization result object.

from glotaran.io import save_dataset
from glotaran.utils.io import create_clp_guide_dataset

clp_guide = create_clp_guide_dataset(result, "species_1", "dataset_1")
save_dataset(clp_guide, "clp_guide__result_dataset_1__species_1.nc")

Extracting the clp guide from a result dataset loaded from file.

from glotaran.io import load_dataset
from glotaran.io import save_dataset
from glotaran.utils.io import create_clp_guide_dataset

result_dataset = load_dataset("result_dataset_1.nc")
clp_guide = create_clp_guide_dataset(result_dataset, "species_1")
save_dataset(clp_guide, "clp_guide__result_dataset_1__species_1.nc")