Skip to content

gcages.cmip7_scenariomip.pre_processing.reaggregation.common#

Common components used across different re-aggregation strategies

Classes:

Name Description
ToCompleteResult

Result of calling to_complete on a reaggregator

ToCompleteResult #

Result of calling to_complete on a reaggregator

Attributes:

Name Type Description
assumed_zero DataFrame | None

The timeseries that were assumed to be zero to make self.complete
complete DataFrame

Complete pd.DataFrame
Source code in src/gcages/cmip7_scenariomip/pre_processing/reaggregation/common.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@define
class ToCompleteResult:
    """
    Result of calling `to_complete` on a reaggregator
    """

    complete: pd.DataFrame
    """Complete [pd.DataFrame][pandas.DataFrame]"""

    assumed_zero: pd.DataFrame | None
    """
    The timeseries that were assumed to be zero to make `self.complete`

    If `None`, no timeseries were assumed to be zero.
    """

assumed_zero instance-attribute #

assumed_zero: DataFrame | None

The timeseries that were assumed to be zero to make self.complete

If None, no timeseries were assumed to be zero.

complete instance-attribute #

complete: DataFrame

Complete pd.DataFrame