Skip to content

climate_ref_core.esgf.obs4mips #

Obs4MIPs dataset request implementation.

Obs4MIPsRequest #

Bases: IntakeESGFMixin

Represents an Obs4MIPs dataset request.

These data are fetched from ESGF based on the provided facets.

Source code in packages/climate-ref-core/src/climate_ref_core/esgf/obs4mips.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
class Obs4MIPsRequest(IntakeESGFMixin):
    """
    Represents an Obs4MIPs dataset request.

    These data are fetched from ESGF based on the provided facets.
    """

    source_type = "obs4MIPs"

    obs4mips_path_items = (
        "activity_id",
        "institution_id",
        "source_id",
        "variable_id",
        "grid_label",
    )

    obs4mips_filename_paths = (
        "variable_id",
        "source_id",
        "grid_label",
    )

    avail_facets = (
        "activity_id",
        "institution_id",
        "source_id",
        "frequency",
        "variable_id",
        "grid_label",
        "version",
        "data_node",
        "project",
    )

    def __init__(
        self,
        slug: str,
        facets: dict[str, Any],
        remove_ensembles: bool = False,
        time_span: tuple[str, str] | None = None,
    ):
        """
        Initialize an Obs4MIPs request.

        Parameters
        ----------
        slug
            Unique identifier for this request
        facets
            ESGF search facets (e.g., source_id, variable_id)
        remove_ensembles
            If True, keep only one ensemble member (typically not relevant for obs)
        time_span
            Optional time range filter (start, end) in YYYY-MM format
        """
        self.slug = slug
        self.facets = {"project": "obs4MIPs", **facets}
        self.remove_ensembles = remove_ensembles
        self.time_span = time_span

        for key in self.obs4mips_path_items:
            if key not in self.avail_facets:
                raise ValueError(f"Path item {key!r} not in available facets")
        for key in self.obs4mips_filename_paths:
            if key not in self.avail_facets:
                raise ValueError(f"Filename path {key!r} not in available facets")

    def fetch_datasets(self) -> pd.DataFrame:
        """Fetch dataset metadata from ESGF with project=obs4MIPs."""
        # Ensure project facet is set to obs4MIPs
        if "project" not in self.facets:
            self.facets["project"] = "obs4MIPs"

        return super().fetch_datasets()

    def __repr__(self) -> str:
        return f"Obs4MIPsRequest(slug={self.slug!r}, facets={self.facets!r})"

__init__(slug, facets, remove_ensembles=False, time_span=None) #

Initialize an Obs4MIPs request.

Parameters:

Name Type Description Default
slug str

Unique identifier for this request

 required
facets dict[str, Any]

ESGF search facets (e.g., source_id, variable_id)

 required
remove_ensembles bool

If True, keep only one ensemble member (typically not relevant for obs)

 False
time_span tuple[str, str] | None

Optional time range filter (start, end) in YYYY-MM format

 None
Source code in packages/climate-ref-core/src/climate_ref_core/esgf/obs4mips.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def __init__(
    self,
    slug: str,
    facets: dict[str, Any],
    remove_ensembles: bool = False,
    time_span: tuple[str, str] | None = None,
):
    """
    Initialize an Obs4MIPs request.

    Parameters
    ----------
    slug
        Unique identifier for this request
    facets
        ESGF search facets (e.g., source_id, variable_id)
    remove_ensembles
        If True, keep only one ensemble member (typically not relevant for obs)
    time_span
        Optional time range filter (start, end) in YYYY-MM format
    """
    self.slug = slug
    self.facets = {"project": "obs4MIPs", **facets}
    self.remove_ensembles = remove_ensembles
    self.time_span = time_span

    for key in self.obs4mips_path_items:
        if key not in self.avail_facets:
            raise ValueError(f"Path item {key!r} not in available facets")
    for key in self.obs4mips_filename_paths:
        if key not in self.avail_facets:
            raise ValueError(f"Filename path {key!r} not in available facets")

fetch_datasets() #

Fetch dataset metadata from ESGF with project=obs4MIPs.

Source code in packages/climate-ref-core/src/climate_ref_core/esgf/obs4mips.py 
85
86
87
88
89
90
91
def fetch_datasets(self) -> pd.DataFrame:
    """Fetch dataset metadata from ESGF with project=obs4MIPs."""
    # Ensure project facet is set to obs4MIPs
    if "project" not in self.facets:
        self.facets["project"] = "obs4MIPs"

    return super().fetch_datasets()