Skip to content

climate_ref_ilamb.datasets #

A module for defining and fetching ILAMB/IOMB datasets

registry_to_collection(registry) #

Convert a ILAMB/IOMB registry to a DatasetCollection for use in REF.

Parameters:

Name Type Description Default
registry Pooch

The pooch registry.

 required

Returns:

Type Description
DatasetCollection

The converted collection.
Source code in packages/climate-ref-ilamb/src/climate_ref_ilamb/datasets.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def registry_to_collection(registry: pooch.Pooch) -> DatasetCollection:
    """
    Convert a ILAMB/IOMB registry to a DatasetCollection for use in REF.

    Parameters
    ----------
    registry : pooch.Pooch
        The pooch registry.

    Returns
    -------
    DatasetCollection
        The converted collection.
    """
    df = pd.DataFrame(
        [
            {
                "key": key,
                "path": registry.abspath / Path(key),  # type: ignore
            }
            for key in registry.registry.keys()
        ]
    )
    collection = DatasetCollection(df, "key")
    return collection