Skip to content

gcages.post_processing#

General post-processing tools

Classes:

Name Description
PostProcessingResult

Results of post-processing

PostProcessingResult #

Results of post-processing

The data is separated into tables that have the same index levels. This simplifies further processing (at the expense of making it more complex to get data into the object).

Attributes:

Name Type Description
metadata_categories Series[str]

Metadata of categories
metadata_exceedance_probabilities Series[float]

Metadata of exceedance probabilities
metadata_quantile Series[float]

Metadata that includes a quantile index level
metadata_run_id Series[float]

Metadata that includes a run_id index level
timeseries_exceedance_probabilities DataFrame

Timeseries of exceedance probabilities
timeseries_quantile DataFrame

Timeseries that includes a quantile index level
timeseries_run_id DataFrame

Timeseries that includes a run_id index level
Source code in src/gcages/post_processing.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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@define
class PostProcessingResult:
    """
    Results of post-processing

    The data is separated into tables that have the same index levels.
    This simplifies further processing
    (at the expense of making it more complex to get data into the object).
    """

    timeseries_run_id: pd.DataFrame
    """Timeseries that includes a run_id index level"""

    timeseries_quantile: pd.DataFrame
    """Timeseries that includes a quantile index level"""

    timeseries_exceedance_probabilities: pd.DataFrame
    """
    Timeseries of exceedance probabilities

    These are reported separately because they contain
    extra index levels to handle the threshold information.
    """

    metadata_run_id: pd.Series[float]
    """Metadata that includes a run_id index level"""

    metadata_quantile: pd.Series[float]
    """Metadata that includes a quantile index level"""

    metadata_exceedance_probabilities: pd.Series[float]
    """
    Metadata of exceedance probabilities

    These are reported separately because they contain
    extra index levels to handle the threshold information.
    """

    metadata_categories: pd.Series[str]
    """
    Metadata of categories
    """

metadata_categories instance-attribute #

metadata_categories: Series[str]

Metadata of categories

metadata_exceedance_probabilities instance-attribute #

metadata_exceedance_probabilities: Series[float]

Metadata of exceedance probabilities

These are reported separately because they contain extra index levels to handle the threshold information.

metadata_quantile instance-attribute #

metadata_quantile: Series[float]

Metadata that includes a quantile index level

metadata_run_id instance-attribute #

metadata_run_id: Series[float]

Metadata that includes a run_id index level

timeseries_exceedance_probabilities instance-attribute #

timeseries_exceedance_probabilities: DataFrame

Timeseries of exceedance probabilities

These are reported separately because they contain extra index levels to handle the threshold information.

timeseries_quantile instance-attribute #

timeseries_quantile: DataFrame

Timeseries that includes a quantile index level

timeseries_run_id instance-attribute #

timeseries_run_id: DataFrame

Timeseries that includes a run_id index level