Skip to content

gcages.sci_june_2026.infilling#

Infilling configuration and related things for the SCIJune2026 workflow.

Functions:

Name Description
create_scijune2026_infiller

Infiller that follows the same logic as was used in SCI

create_scijune2026_infiller #

create_scijune2026_infiller(
    infilling_leader_emissions_file: Path,
    ghg_inversions_file: Path,
    historical_emissions_file: Path,
    harmonisation_year: int = 2023,
    pre_industrial_year: int = 1750,
    run_checks: bool = True,
    ur: UnitRegistry | None = None,
) -> CMIP7ScenarioMIPInfiller

Infiller that follows the same logic as was used in SCI

Parameters:

Name Type Description Default
infilling_leader_emissions_file Path

Infilling leaders database file for infilling leader emissions.

 required
ghg_inversions_file Path

Green house gasses inversion dataframe file.

 required
historical_emissions_file Path

Historical emissions file used for harmonisation

 required
harmonisation_year int

Year in which to harmonise

 2023
pre_industrial_year int

Pre-Industrial year

 1750
run_checks bool

If True, run checks on both input and output data

If you are sure about your workflow, you can disable the checks to speed things up (but we don't recommend this unless you really are confident about what you're doing).

 True
ur UnitRegistry | None

UnitRegistry

 None

Returns:

Type Description
CMIP7ScenarioMIPInfiller
Source code in src/gcages/sci_june_2026/infilling.py 
 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
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def create_scijune2026_infiller(  # noqa: PLR0913
    infilling_leader_emissions_file: Path,
    ghg_inversions_file: Path,
    historical_emissions_file: Path,
    harmonisation_year: int = 2023,
    pre_industrial_year: int = 1750,
    run_checks: bool = True,
    ur: UnitRegistry | None = None,
) -> CMIP7ScenarioMIPInfiller:
    """
    Infiller that follows the same logic as was used in SCI

    Parameters
    ----------
    infilling_leader_emissions_file
        Infilling leaders database file for infilling leader emissions.

    ghg_inversions_file
        Green house gasses inversion dataframe file.

    historical_emissions_file
        Historical emissions file used for harmonisation

    harmonisation_year
        Year in which to harmonise

    pre_industrial_year
        Pre-Industrial year

    run_checks
        If `True`, run checks on both input and output data

        If you are sure about your workflow,
        you can disable the checks to speed things up
        (but we don't recommend this unless you really
        are confident about what you're doing).

    ur
        UnitRegistry

    Returns
    -------
    :
    """
    if ur is None:
        try:
            import openscm_units  # noqa: PLC0415

            ur = openscm_units.unit_registry
        except ImportError as exc:
            raise MissingOptionalDependencyError(
                "openscm_units",
                requirement="openscm_units",
            ) from exc

    infilling_leader_emissions = load_timeseries_csv(
        infilling_leader_emissions_file,
        lower_column_names=True,
        index_columns=["model", "scenario", "region", "variable", "unit"],
        out_columns_type=int,
    )
    # CMIP7 GHG inversions
    ghg_inversions = load_timeseries_csv(
        ghg_inversions_file,
        lower_column_names=True,
        index_columns=["model", "scenario", "region", "variable", "unit"],
        out_columns_type=int,
    )
    # History
    historical_emissions = load_historical_emissions(
        historical_emissions_file=historical_emissions_file,
    )
    # Use gcages naming convention.
    infilling_leader_emissions = rename_variables(
        infilling_leader_emissions,
        from_convention=SupportedNamingConventions.CMIP7_SCENARIOMIP,
        to_convention=SupportedNamingConventions.GCAGES,
    )
    ghg_inversions = rename_variables(
        ghg_inversions,
        from_convention=SupportedNamingConventions.OPENSCM_RUNNER,
        to_convention=SupportedNamingConventions.GCAGES,
    )

    if run_checks:
        assert_harmonised(
            infilling_leader_emissions,
            history=historical_emissions.reset_index(
                level=[
                    lvl
                    for lvl in ["model", "scenario"]
                    if lvl in historical_emissions.index.names
                ],
                drop=True,
            ),
            harmonisation_time=harmonisation_year,
            history_unit_level="unit",
            ur=ur,
        )

    # Notes: currently this uses RMSClosest under the hood.
    # That's probably not a bad decision, and avoids the OC-BC decoupling from AR6.
    # Can be investigated more in future in other applications.
    return CMIP7ScenarioMIPInfiller(
        infilling_db=infilling_leader_emissions,
        historical_emissions=historical_emissions,
        cmip7_ghg_inversions=ghg_inversions,
        harmonisation_year=harmonisation_year,
        pre_industrial_year=pre_industrial_year,
        run_checks=run_checks,
        # TODO: add something like this back in
        # progress=progress,
        ur=ur,
    )