Skip to content

input4mips_validation.cvs.institution_id#

input4mips_validation.cvs.institution_id #

Institution ID CV handling

For validation, see validation.

INSTITUTION_ID_FILENAME: str = 'input4MIPs_institution_id.json' module-attribute #

Default name of the file in which the institution ID CV is saved

InstitutionIDEntriesUnstructured: TypeAlias = list[str] module-attribute #

Form into which institution ID entries are serialised for the CVs

convert_institution_ids_to_unstructured_cv(institution_ids) #

Convert the structured institution_id entries to the raw CV form

Parameters:

Name Type Description Default
institution_ids tuple[str, ...]

Institution IDs

 required

Returns:

Type Description
Raw CV data
Source code in src/input4mips_validation/cvs/institution_id.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def convert_institution_ids_to_unstructured_cv(
    institution_ids: tuple[str, ...],
) -> InstitutionIDEntriesUnstructured:
    """
    Convert the structured institution_id entries to the raw CV form

    Parameters
    ----------
    institution_ids
        Institution IDs

    Returns
    -------
        Raw CV data
    """
    raw_cv_form = list(institution_ids)

    return raw_cv_form

convert_unstructured_cv_to_institution_ids(unstructured) #

Convert the raw CV data to its structured form

Parameters:

Name Type Description Default
unstructured InstitutionIDEntriesUnstructured

Unstructured CV data

 required

Returns:

Type Description
Institution IDs
Source code in src/input4mips_validation/cvs/institution_id.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def convert_unstructured_cv_to_institution_ids(
    unstructured: InstitutionIDEntriesUnstructured,
) -> tuple[str, ...]:
    """
    Convert the raw CV data to its structured form

    Parameters
    ----------
    unstructured
        Unstructured CV data

    Returns
    -------
        Institution IDs
    """
    return converter_json.structure(unstructured, tuple[str, ...])

load_institution_ids(raw_cvs_loader, filename=INSTITUTION_ID_FILENAME) #

Load the instution IDs in the CVs

Parameters:

Name Type Description Default
raw_cvs_loader RawCVLoader

Loader of raw CVs data.

 required
filename str

Name of the file from which to load the CVs.

Passed to raw_cvs_loader.load_raw.

 INSTITUTION_ID_FILENAME

Returns:

Type Description
Institution IDs
Source code in src/input4mips_validation/cvs/institution_id.py 
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
def load_institution_ids(
    raw_cvs_loader: RawCVLoader,
    filename: str = INSTITUTION_ID_FILENAME,
) -> tuple[str, ...]:
    """
    Load the instution IDs in the CVs

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

    filename
        Name of the file from which to load the CVs.

        Passed to
        [`raw_cvs_loader.load_raw`][input4mips_validation.cvs.loading_raw.RawCVLoader.load_raw].

    Returns
    -------
        Institution IDs
    """
    return convert_unstructured_cv_to_institution_ids(
        json.loads(raw_cvs_loader.load_raw(filename=filename))
    )