Skip to content

input4mips_validation.cvs.loading#

input4mips_validation.cvs.loading #

Loading of CVs from a given source

load_cvs(cv_source=None, **kwargs) #

Load CVs

Parameters:

Name Type Description Default
cv_source None | str | Path

String identifying the source of the CVs.

For full details of possible options, see get_raw_cvs_loader.

 None
kwargs Any

Passed through to get_raw_cvs_loader.

 {}

Returns:

Type Description
Input4MIPsCVs

Loaded CVs
Source code in src/input4mips_validation/cvs/loading.py 
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
def load_cvs(
    cv_source: None | str | Path = None,
    **kwargs: Any,
) -> Input4MIPsCVs:
    """
    Load CVs

    Parameters
    ----------
    cv_source
        String identifying the source of the CVs.

        For full details of possible options, see
        [`get_raw_cvs_loader`][input4mips_validation.cvs.loading_raw.get_raw_cvs_loader].

    kwargs
        Passed through to
        [`get_raw_cvs_loader`][input4mips_validation.cvs.loading_raw.get_raw_cvs_loader].

    Returns
    -------
    :
        Loaded CVs
    """
    raw_cvs_loader = get_raw_cvs_loader(cv_source=cv_source)
    logger.debug(f"{raw_cvs_loader=}")

    return load_cvs_known_loader(raw_cvs_loader=raw_cvs_loader)

load_cvs_known_loader(raw_cvs_loader) #

Load CVs from a known loader

Parameters:

Name Type Description Default
raw_cvs_loader RawCVLoader

Loader of the raw CVs data

 required

Returns:

Type Description
Loaded CVs
Source code in src/input4mips_validation/cvs/loading.py 
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
def load_cvs_known_loader(raw_cvs_loader: RawCVLoader) -> Input4MIPsCVs:
    """
    Load CVs from a known loader

    Parameters
    ----------
    raw_cvs_loader
        Loader of the raw CVs data

    Returns
    -------
        Loaded CVs
    """
    activity_id_entries = load_activity_id_entries(raw_cvs_loader=raw_cvs_loader)
    drs = load_drs(raw_cvs_loader=raw_cvs_loader)
    institution_ids = load_institution_ids(raw_cvs_loader=raw_cvs_loader)
    license_entries = load_license_entries(raw_cvs_loader=raw_cvs_loader)
    source_id_entries = load_source_id_entries(raw_cvs_loader=raw_cvs_loader)

    return Input4MIPsCVs(
        raw_loader=raw_cvs_loader,
        DRS=drs,
        activity_id_entries=activity_id_entries,
        institution_ids=institution_ids,
        license_entries=license_entries,
        source_id_entries=source_id_entries,
    )