Skip to content

openscm_calibration.store.scmdata#

Store of scmdata-based results

Functions:

Name Description
add_iteration_to_res_scmrun

Add iteration information to a result stored as [scmdata.run.BaseScmRun][scmdata.run.BaseScmRun]

add_iteration_to_res_scmrun #

add_iteration_to_res_scmrun(
    res: BaseScmRun,
    iteration: int,
    iteration_metadata_column: str = "it",
) -> BaseScmRun

Add iteration information to a result stored as [scmdata.run.BaseScmRun][scmdata.run.BaseScmRun]

Parameters:

Name Type Description Default
res BaseScmRun

Result of the run

 required
iteration int

Iteration to assign to the run

 required
iteration_metadata_column str

Metadata column in which to store the iteration information

 'it'

Returns:

Type Description
BaseScmRun

Result with iteration information added.
Source code in src/openscm_calibration/store/scmdata.py 
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
def add_iteration_to_res_scmrun(
    res: scmdata.run.BaseScmRun, iteration: int, iteration_metadata_column: str = "it"
) -> scmdata.run.BaseScmRun:
    """
    Add iteration information to a result stored as [`scmdata.run.BaseScmRun`][]

    Parameters
    ----------
    res
        Result of the run

    iteration
        Iteration to assign to the run

    iteration_metadata_column
        Metadata column in which to store the iteration information

    Returns
    -------
    :
        Result with iteration information added.
    """
    out = res.copy()
    out[iteration_metadata_column] = iteration

    return out