Skip to content

input4mips_validation.dataset.metadata_data_producer_minimum#

input4mips_validation.dataset.metadata_data_producer_minimum #

Minimum metadata required from an input4MIPs dataset producer

Input4MIPsDatasetMetadataDataProducerMinimum #

Minimum metadata required from an input4MIPs dataset producer

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

Source code in src/input4mips_validation/dataset/metadata_data_producer_minimum.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@frozen
class Input4MIPsDatasetMetadataDataProducerMinimum:
    """
    Minimum metadata required from an input4MIPs dataset producer

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

    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"""

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

source_id: str instance-attribute #

The ID of the file's source

target_mip: str instance-attribute #

The MIP that this file targets