Skip to content

input4mips_validation.dataset.metadata_data_producer_multiple_variable_minimum#

input4mips_validation.dataset.metadata_data_producer_multiple_variable_minimum #

Minimum metadata required from an input4MIPs dataset producer for a multi-variable file

Input4MIPsDatasetMetadataDataProducerMultipleVariableMinimum #

Minimum metadata required from input4MIPs dataset producer for a multi-variable file

This is the minimum metadata required to create a valid Input4MIPsDataset object using from_data_producer_minimum_information_multiple_variable.

Source code in src/input4mips_validation/dataset/metadata_data_producer_multiple_variable_minimum.py 
 9
10
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
@frozen
class Input4MIPsDatasetMetadataDataProducerMultipleVariableMinimum:
    """
    Minimum metadata required from input4MIPs dataset producer for a multi-variable file

    This is the minimum metadata required to create a valid
    [`Input4MIPsDataset`][input4mips_validation.dataset.Input4MIPsDataset] object using
    [`from_data_producer_minimum_information_multiple_variable`][input4mips_validation.dataset.dataset.Input4MIPsDataset.from_data_producer_minimum_information_multiple_variable].
    """

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

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

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

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

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

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

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

dataset_category: str instance-attribute #

The file's category

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

Label that identfies the file's grid

[TODO: cross-ref to the CVs]

nominal_resolution: str instance-attribute #

Nominal resolution of the data in the file

realm: str instance-attribute #

The realm of the data in the file

source_id: str instance-attribute #

The ID of the file's source

target_mip: str instance-attribute #

The MIP that this file targets