Refactor downloader constants

Author: f-PLT

climateset/download/constants/cmip6.py

@@ -1,26 +1,35 @@
+# pylint: disable=C0103
+from dataclasses import dataclass
+from typing import Final
+
+from climateset.utils import get_yaml_config
+
 # TODO remove raw variables from here
+
+
+@dataclass(frozen=True)
 class Cmip6plusConstants:
     """
+    Dataclass to represent CMIP6PLUS constants that are used by the download module.
+
     Attributes:
-        NODE_LINK (str): Where the data can be accessed
-        MODEL_SOURCES (List<str>): Identifiers for supported climate models
-        VAR_SOURCE_LOOKUP (Dict<str, List<str>>): model and raw variables
-        SUPPORTED_EXPERIMENTS (list<str>): experiments of climate models (runs) that are supported
+        NODE_LINK : Where the data can be accessed
+        MODEL_SOURCES : Identifiers for supported climate models
+        VAR_SOURCE_LOOKUP : model and raw variables
+        SUPPORTED_EXPERIMENTS : experiments of climate models (runs) that are supported
     """
 
-    NODE_LINK = "http://esgf-data2.llnl.gov"
+    NODE_LINK: Final[str]
+    MODEL_SOURCES: Final[tuple[str, ...]]
+    VAR_SOURCE_LOOKUP: Final[tuple[str, ...]]
+    SUPPORTED_EXPERIMENTS: Final[tuple[str, ...]]
 
-    MODEL_SOURCES = [
-        "HasGEM3-GC31-LL",
-    ]
 
-    VAR_SOURCE_LOOKUP = [
-        "areacella",
-        "mrsofc",
-    ]
+_data = get_yaml_config("downloader/constants/cmip6plus.yaml")
 
-    SUPPORTED_EXPERIMENTS = [
-        "hist-lu",
-        "hist-piAer",
-        "hist-piVolc",
-    ]
+CMIP6PLUS_CONSTANTS = Cmip6plusConstants(
+    NODE_LINK=_data["node_link"],
+    MODEL_SOURCES=tuple(_data["model_sources"]),
+    SUPPORTED_EXPERIMENTS=tuple(_data["supported_experiments"]),
+    VAR_SOURCE_LOOKUP=tuple(_data["var_source_lookup"]),
+)

climateset/download/constants/cmip6plus.py

@@ -1,5 +1,5 @@
-from .cmip6 import Cmip6Constants
-from .cmip6plus import Cmip6plusConstants
+from .cmip6 import CMIP6_CONSTANTS
+from .cmip6plus import CMIP6PLUS_CONSTANTS
 from .input4mips import INPUT4MIPS_CONSTANTS
 
 CMIP6 = "CMIP6"
@@ -11,8 +11,8 @@
 # constant classes for esgf projects implemented here
 # add your own esgf project for downloading to download/constants/ and add the constant class to the dict and lists here
 ESGF_PROJECTS_CONSTANTS = {
-    CMIP6: Cmip6Constants,
-    CMIP6PLUS: Cmip6plusConstants,
+    CMIP6: CMIP6_CONSTANTS,
+    CMIP6PLUS: CMIP6PLUS_CONSTANTS,
     INPUT4MIPS: INPUT4MIPS_CONSTANTS,
 }
 

climateset/download/constants/esgf.py

@@ -10,6 +10,17 @@
 
 @dataclass(frozen=True)
 class Input4MIPSConstants:
+    """
+    Data class to represent Input4MIPS constants that are used by the download module.
+
+    Attributes:
+        NODE_LINK : Node link is used to run an ESGF search
+        EMISSION_ENDINGS : File endings for emission variables
+        META_ENDINGS_PRC : File endings for PRC meta variables
+        META_ENDINGS_SHARE : File endings for SHARE meta variables
+        VAR_SOURCE_LOOKUP : Model and raw variables
+    """
+
     NODE_LINK: Final[str]
     EMISSIONS_ENDINGS: Final[tuple[str, ...]]
     META_ENDINGS_PRC: Final[tuple[str, ...]]