Skip to content

input4mips_validation.dataset.metadata#

input4mips_validation.dataset.metadata #

Metadata for Input4MIPsDataset objects

See Input4MIPsDataset

Input4MIPsDatasetMetadata #

Metadata for an input4MIPs dataset

Source code in src/input4mips_validation/dataset/metadata.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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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
83
84
85
86
87
88
89
90
91
92
93
94
95
@frozen
class Input4MIPsDatasetMetadata:
    """
    Metadata for an input4MIPs dataset
    """

    activity_id: str
    """Activity ID that applies to the file"""

    contact: str
    """Email addresses to contact in case of questions about the file"""

    dataset_category: str
    """The file's category"""

    frequency: str
    """Frequency of the data in the file"""

    further_info_url: str
    """URL where further information about the file/data in the file can be found"""

    grid_label: str = field()
    """
    Label that identfies the file's grid

    [TODO: cross-ref to the CVs]
    """

    institution_id: str
    """ID of the institute that created the file"""

    license: str
    """License information for the dataset"""

    mip_era: str
    """The MIP era to which this file belong"""

    nominal_resolution: str
    """Nominal resolution of the data in the file"""

    realm: str
    """The realm of the data in the file"""

    source_id: str
    """The ID of the file's source"""

    source_version: str
    """The version of the file, as defined by the source"""

    target_mip: str
    """The MIP that this file targets"""

    variable_id: str
    """The ID of the variable contained in the file"""

    comment: Union[str, None] = None
    """
    Comments that apply to the file

    These are the comments included in the file itself.
    As a result, they can only apply to the file at the time of writing.
    For comments made about the file after the fact,
    e.g. reasons for deprecation,
    see `comment_post_publication`.
    """

    doi: Union[str, None] = None
    """The digital object identifier (DOI) associated with the file."""

    institution: Union[str, None] = None
    """Long-form description of the institute referred to by `institution_id`"""

    license_id: Union[str, None] = None
    """ID of the license that applies to this dataset"""

    product: Union[str, None] = None
    """The kind of data in the file"""

    region: Union[str, None] = None
    """The region of the data in the file"""

    source: Union[str, None] = None
    """Long-form description of the source referred to by `source_id`"""

activity_id: str instance-attribute #

Activity ID that applies to the file

comment: Union[str, None] = None class-attribute instance-attribute #

Comments that apply to the file

These are the comments included in the file itself. As a result, they can only apply to the file at the time of writing. For comments made about the file after the fact, e.g. reasons for deprecation, see comment_post_publication.

contact: str instance-attribute #

Email addresses to contact in case of questions about the file

dataset_category: str instance-attribute #

The file's category

doi: Union[str, None] = None class-attribute instance-attribute #

The digital object identifier (DOI) associated with the file.

frequency: str instance-attribute #

Frequency of the data in the file

further_info_url: str instance-attribute #

URL where further information about the file/data in the file can be found

grid_label: str = field() class-attribute instance-attribute #

Label that identfies the file's grid

[TODO: cross-ref to the CVs]

institution: Union[str, None] = None class-attribute instance-attribute #

Long-form description of the institute referred to by institution_id

institution_id: str instance-attribute #

ID of the institute that created the file

license: str instance-attribute #

License information for the dataset

license_id: Union[str, None] = None class-attribute instance-attribute #

ID of the license that applies to this dataset

mip_era: str instance-attribute #

The MIP era to which this file belong

nominal_resolution: str instance-attribute #

Nominal resolution of the data in the file

product: Union[str, None] = None class-attribute instance-attribute #

The kind of data in the file

realm: str instance-attribute #

The realm of the data in the file

region: Union[str, None] = None class-attribute instance-attribute #

The region of the data in the file

source: Union[str, None] = None class-attribute instance-attribute #

Long-form description of the source referred to by source_id

source_id: str instance-attribute #

The ID of the file's source

source_version: str instance-attribute #

The version of the file, as defined by the source

target_mip: str instance-attribute #

The MIP that this file targets

variable_id: str instance-attribute #

The ID of the variable contained in the file