wrfrun 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

wrfrun/model/wrf/exec_wrap.py

@@ -1,13 +1,30 @@
-from os.path import basename
+"""
+wrfrun.model.wrf.exec_wrap
+##########################
+
+Function wrapper of WPS / WRF :doc:`Executables </api/model.wrf.core>`.
+
+.. autosummary::
+    :toctree: generated/
+
+    geogrid
+    ungrib
+    metgrid
+    real
+    wrf
+    dfi
+    ndown
+"""
+
 from typing import Optional, Union
 
 from wrfrun import WRFRUNConfig
-from .core import DFI, GeoGrid, MetGrid, Real, UnGrib, WRF, NDown
+from .core import DFI, GeoGrid, MetGrid, NDown, Real, UnGrib, WRF
 
 
 def geogrid(geogrid_tbl_file: Union[str, None] = None):
     """
-    Interface to execute geogrid.exe.
+    Function interface for :class:`GeoGrid <wrfrun.model.wrf.core.GeoGrid>`.
 
     :param geogrid_tbl_file: Custom GEOGRID.TBL file path. Defaults to None.
     """
@@ -16,67 +33,66 @@ def geogrid(geogrid_tbl_file: Union[str, None] = None):
 
 def ungrib(vtable_file: Union[str, None] = None, input_data_path: Optional[str] = None, prefix="FILE"):
     """
-    Interface to execute ungrib.exe.
+    Function interface for :class:`UnGrib <wrfrun.model.wrf.core.UnGrib>`.
 
-    :param vtable_file: Vtable file used to run ungrib. Defaults to None.
+    :param vtable_file: Path of the Vtable file.
+                        Defaults to :attr:`VtableFiles.ERA_PL <vtable.VtableFiles.ERA_PL>`.
     :type vtable_file: str
-    :param input_data_path: Directory path of the input data. If None, ``wrfrun`` will read its value from the config file.
+    :param input_data_path: Directory path of input GRIB files.
+                            Defaults to ``input_data_path`` set in user's config file.
     :type input_data_path: str
-    :param prefix: Prefix of ungrib output.
+    :param prefix: Prefix of outputs.
     :type prefix: str
     """
-    prefix = basename(prefix)
-    WRFRUNConfig.set_ungrib_out_prefix(prefix)
-
-    UnGrib(vtable_file, input_data_path)()
+    UnGrib(vtable_file, input_data_path).set_ungrib_output_prefix(prefix)()
 
 
 def metgrid(geogrid_data_path: Optional[str] = None, ungrib_data_path: Optional[str] = None, fg_names: Union[str, list[str]] = "FILE"):
     """
-    Interface to execute metgrid.exe.
+    Function interface for :class:`MetGrid <wrfrun.model.wrf.core.MetGrid>`.
 
-    :param geogrid_data_path: Directory path of outputs from geogrid.exe. If None, tries to use the output path specified by config file.
+    :param geogrid_data_path: Directory path of :class:`GeoGrid <wrfrun.model.wrf.core.GeoGrid>` outputs.
+                              If is ``None``, try to use the output path specified by config file.
     :type geogrid_data_path: str
-    :param ungrib_data_path: Directory path of outputs from ungrib.exe. If None, tries to use the output path specified by config file.
+    :param ungrib_data_path: Directory path of :class:`UnGrib <wrfrun.model.wrf.core.UnGrib>` outputs.
+                             If is ``None``, try to use the output path specified by config file.
     :type ungrib_data_path: str
-    :param fg_names: Set ``fg_name`` of metgrid, a single prefix string or a string list.
+    :param fg_names: ``fg_name`` of metgrid, a single prefix string or a string list.
     :type fg_names: str | list
     """
-    if isinstance(fg_names, str):
-        fg_names = [fg_names, ]
-    fg_names = [basename(x) for x in fg_names]
-    WRFRUNConfig.set_metgrid_fg_names(fg_names)
-
-    MetGrid(geogrid_data_path, ungrib_data_path, WRFRUNConfig.get_core_num())()
+    MetGrid(
+        geogrid_data_path, ungrib_data_path, WRFRUNConfig.get_core_num()
+    ).set_metgrid_fg_names(fg_names)()
 
 
 def real(metgrid_data_path: Union[str, None] = None):
     """
-    Interface to execute real.exe.
+    Function interface for :class:`Real <wrfrun.model.wrf.core.Real>`.
 
-    :param metgrid_data_path: The path store output from metgrid.exe. If it is None, the default output path will be used.
+    :param metgrid_data_path: Directory path of :class:`MetGrid <wrfrun.model.wrf.core.MetGrid>` outputs.
+                              If is ``None``, try to use the workspace path or output path in the config file.
     """
     Real(metgrid_data_path, WRFRUNConfig.get_core_num())()
 
 
 def wrf(input_file_dir_path: Union[str, None] = None, restart_file_dir_path: Optional[str] = None, save_restarts=False):
     """
-    Interface to execute wrf.exe.
+    Function interface for :class:`WRF <wrfrun.model.wrf.core.WRF>`.
 
-    :param input_file_dir_path: The path store input data which will be feed into wrf.exe. Defaults to None.
-    :param restart_file_dir_path: The path store WRF restart files. This parameter will be ignored if ``restart=False`` in your config.
-    :param save_restarts: Also save restart files to the output directory.
+    :param input_file_dir_path: Directory path of input data.
+    :param restart_file_dir_path: Directory path of restart files.
+    :param save_restarts: If saving restart files. Defaults to False.
     """
     WRF(input_file_dir_path, restart_file_dir_path, save_restarts, WRFRUNConfig.get_core_num())()
 
 
 def dfi(input_file_dir_path: Optional[str] = None, update_real_output=True):
     """
-    Execute "wrf.exe" to run DFI.
+    Function interface for :class:`DFI <wrfrun.model.wrf.core.DFI>`.
 
-    :param input_file_dir_path: Path of the directory that stores input data for "wrf.exe".
+    :param input_file_dir_path: Directory path of input data.
     :type input_file_dir_path: str
-    :param update_real_output: If update the corresponding file in real.exe output directory.
+    :param update_real_output: If update corresponding files in :class:`Real <wrfrun.model.wrf.core.Real>` outputs.
     :type update_real_output: bool
     """
     DFI(input_file_dir_path, update_real_output, WRFRUNConfig.get_core_num())()
@@ -84,16 +100,14 @@ def dfi(input_file_dir_path: Optional[str] = None, update_real_output=True):
 
 def ndown(wrfout_file_path: str, real_output_dir_path: Optional[str] = None, update_namelist=True):
     """
-    Execute "ndown.exe".
+    Function interface for :class:`NDown <wrfrun.model.wrf.core.NDown>`.
 
     :param wrfout_file_path: wrfout file path.
     :type wrfout_file_path: str
-    :param real_output_dir_path: Path of the directory that contains output of "real.exe".
+    :param real_output_dir_path: Directory path of :class:`Real <wrfrun.model.wrf.core.Real>` outputs.
     :type real_output_dir_path: str
-    :param update_namelist: If update wrf's namelist for the final integral.
+    :param update_namelist: If update namelist settings for the final integral.
     :type update_namelist: bool
-    :return:
-    :rtype:
     """
     NDown(wrfout_file_path, real_output_dir_path, update_namelist, WRFRUNConfig.get_core_num())()
 

wrfrun/model/wrf/namelist.py

@@ -1,13 +1,85 @@
 from datetime import datetime, timedelta
-from os.path import exists
+from os.path import exists, dirname, basename
 from typing import Union
 
 from wrfrun.core import WRFRUNConfig
 from wrfrun.res import NAMELIST_DFI, NAMELIST_WPS, NAMELIST_WRF, NAMELIST_WRFDA
 from wrfrun.utils import logger
+from wrfrun.workspace.wrf import WORKSPACE_MODEL_WPS
 from .scheme import *
 
 
+UNGRIB_OUTPUT_DIR = "./outputs"
+
+
+def get_ungrib_out_dir_path() -> str:
+    """
+    Get the output directory of ungrib output (WRF intermediate file).
+
+    :return: URI path.
+    :rtype: str
+    """
+    wif_prefix = WRFRUNConfig.get_namelist("wps")["ungrib"]["prefix"]
+    wif_path = f"{WORKSPACE_MODEL_WPS}/{dirname(wif_prefix)}"
+
+    return wif_path
+
+
+def get_ungrib_out_prefix() -> str:
+    """
+    Get the prefix string of ungrib output (WRF intermediate file).
+
+    :return: Prefix string of ungrib output (WRF intermediate file).
+    :rtype: str
+    """
+    wif_prefix = WRFRUNConfig.get_namelist("wps")["ungrib"]["prefix"]
+    wif_prefix = basename(wif_prefix)
+    return wif_prefix
+
+
+def set_ungrib_out_prefix(prefix: str):
+    """
+    Set the prefix string of ungrib output (WRF intermediate file).
+
+    :param prefix: Prefix string of ungrib output (WRF intermediate file).
+    :type prefix: str
+    """
+    WRFRUNConfig.update_namelist(
+        {
+            "ungrib": {"prefix": f"{UNGRIB_OUTPUT_DIR}/{prefix}"}
+        }, "wps"
+    )
+
+
+def get_metgrid_fg_names() -> list[str]:
+    """
+    Get prefix strings from "fg_name" in namelist "metgrid" section.
+
+    :return: Prefix strings list.
+    :rtype: list
+    """
+    fg_names = WRFRUNConfig.get_namelist("wps")["metgrid"]["fg_name"]
+    fg_names = [basename(x) for x in fg_names]
+    return fg_names
+
+
+def set_metgrid_fg_names(prefix: Union[str, list[str]]):
+    """
+    Set prefix strings of "fg_name" in namelist "metgrid" section.
+
+    :param prefix: Prefix strings list.
+    :type prefix: str | list
+    """
+    if isinstance(prefix, str):
+        prefix = [prefix, ]
+    fg_names = [f"{UNGRIB_OUTPUT_DIR}/{x}" for x in prefix]
+    WRFRUNConfig.update_namelist(
+        {
+            "metgrid": {"fg_name": fg_names}
+        }, "wps"
+    )
+
+
 def _check_start_end_date(max_dom: int, start_date: Union[datetime, list[datetime]], end_date: Union[datetime, list[datetime]]) -> tuple[list[datetime], list[datetime]]:
     """
     Format start date and end date.
@@ -79,18 +151,16 @@ def prepare_wps_namelist():
             "dy": wrf_config["domain"]["dy"],
             "ref_lat": wrf_config["domain"]["ref_lat"],
             "ref_lon": wrf_config["domain"]["ref_lon"],
+            "map_proj": wrf_config["domain"]["map_proj"],
+            "truelat1": wrf_config["domain"]["truelat1"],
+            "truelat2": wrf_config["domain"]["truelat2"],
             "stand_lon": wrf_config["domain"]["stand_lon"],
             "geog_data_path": wrf_config["geog_data_path"]
-        }
+        },
+        "ungrib": {"prefix": f"{UNGRIB_OUTPUT_DIR}/FILE"},
+        "metgrid": {"fg_name": f"{UNGRIB_OUTPUT_DIR}/FILE"}
     }
 
-    # # use loop to process config of map_proj
-    for key in wrf_config["domain"]["map_proj"]:
-        if key == "name":
-            update_value["geogrid"]["map_proj"] = wrf_config["domain"]["map_proj"][key]
-        else:
-            update_value["geogrid"][key] = wrf_config["domain"]["map_proj"][key]
-
     # # update namelist
     WRFRUNConfig.update_namelist(update_value, "wps")
 
@@ -111,7 +181,7 @@ def prepare_wrf_namelist():
     wrf_config = WRFRUNConfig.get_model_config("wrf")
 
     # get debug level
-    debug_level = WRFRUNConfig["model"]["debug_level"]
+    debug_level = wrf_config["debug_level"]
 
     # get domain number, start_date and end_date
     max_dom = wrf_config["domain"]["domain_num"]
@@ -374,4 +444,5 @@ def prepare_wrfda_namelist():
         WRFRUNConfig.update_namelist(user_namelist_data, "wrfda")
 
 
-__all__ = ["prepare_wrf_namelist", "prepare_wps_namelist", "prepare_wrfda_namelist", "prepare_dfi_namelist"]
+__all__ = ["prepare_wrf_namelist", "prepare_wps_namelist", "prepare_wrfda_namelist", "prepare_dfi_namelist", "get_ungrib_out_prefix", "get_ungrib_out_dir_path",
+           "set_ungrib_out_prefix", "get_metgrid_fg_names", "set_metgrid_fg_names"]

wrfrun/model/wrf/scheme.py

@@ -308,4 +308,88 @@ class SchemeSurfaceLayer:
         return integer_label_map[key]
 
 
-__all__ = ["SchemeCumulus", "SchemeLandSurfaceModel", "SchemeLongWave", "SchemePBL", "SchemeShortWave", "SchemeSurfaceLayer"]
+@dataclass()
+class SchemeMicrophysics:
+    """
+    Microphysics schemes.
+    """
+    OFF = 0
+    KESSLER = 1
+    PURDUE_LIN = 2
+    WSM_3_CLASS_ICE = 3
+    WSM_5_CLASS = 4
+    FERRIER_ETA = 5
+    WSM_6_CLASS_GRAUPEL = 6
+    GODDARD_4_ICE = 7
+    THOMPSON_GRAUPEL = 8
+    MILBRANDT_YAU_2_MOMENT = 9
+    MORRISON_2_MOMENT = 10
+    CAM_V51_5_CLASS = 11
+    SBU_YLIN_5_CLASS = 13
+    WDM_5_CLASS = 14
+    HIGH_FERRIER_ADVECTION = 15
+    WDM_6_CLASS = 16
+    NSSL_2_MOMENT_4_ICE = 18
+    WSM7 = 24
+    WDM7 = 26
+    AEROSOL_AWARE_THOMPSON = 28
+    HUJI = 30
+    THOMPSON_HAIL_GRAUPEL_AEROSOL = 38
+    MORRISON_WITH_CESM_AEROSOL = 40
+    P3_1_ICE_1_MOMENT_QCLOUD = 50
+    P3_1_ICE_2_MOMENT_QCLOUD = 51
+    P3_2_ICE_2_MOMENT_QCLOUD = 52
+    P3_1_ICE_3_MOMENT_ICE_2_MOMENT_QCLOUD = 53
+    JENSEN_ISHMAEL = 55
+    NTU = 56
+
+    @classmethod
+    def get_scheme_id(cls, key: str = "lin"):
+        """Get corresponding integer label for microphysics scheme
+
+        Args:
+            key (str, optional): Name of microphysics scheme. Defaults to "PURDUE_LIN".
+        """
+        # Here is the map of scheme name and integer label in WRF
+        # Reference link: https://www2.mmm.ucar.edu/wrf/users/wrf_users_guide/build/html/namelist_variables.html
+        integer_label_map = {
+            "off": cls.OFF,
+            "kessler": cls.KESSLER,
+            "lin": cls.PURDUE_LIN,
+            "wsm3": cls.WSM_3_CLASS_ICE,
+            "wsm5": cls.WSM_5_CLASS,
+            "ferrier": cls.FERRIER_ETA,
+            "wsm6": cls.WDM_6_CLASS,
+            "goddard4": cls.GODDARD_4_ICE,
+            "thompson": cls.THOMPSON_GRAUPEL,
+            "milbrandt": cls.MILBRANDT_YAU_2_MOMENT,
+            "morrison2": cls.MORRISON_2_MOMENT,
+            "cam": cls.CAM_V51_5_CLASS,
+            "sbu": cls.SBU_YLIN_5_CLASS,
+            "wdm5": cls.WDM_5_CLASS,
+            "high_ferrier": cls.HIGH_FERRIER_ADVECTION,
+            "wdm6": cls.WDM_6_CLASS,
+            "nssl": cls.NSSL_2_MOMENT_4_ICE,
+            "wsm7": cls.WSM7,
+            "wdm7": cls.WDM7,
+            "thompson_aerosol": cls.AEROSOL_AWARE_THOMPSON,
+            "cesm_morrison": cls.MORRISON_WITH_CESM_AEROSOL,
+            "p311": cls.P3_1_ICE_1_MOMENT_QCLOUD,
+            "p312": cls.P3_1_ICE_2_MOMENT_QCLOUD,
+            "p322": cls.P3_2_ICE_2_MOMENT_QCLOUD,
+            "p3132": cls.P3_1_ICE_3_MOMENT_ICE_2_MOMENT_QCLOUD,
+            "jensen": cls.JENSEN_ISHMAEL,
+            "ntu": cls.NTU,
+        }
+
+        # check if key is in map
+        if key not in integer_label_map:
+            logger.error(
+                f"Key error: {key}. Valid key: {list(integer_label_map.keys())}"
+            )
+            raise KeyError
+
+        return integer_label_map[key]
+
+
+__all__ = ["SchemeCumulus", "SchemeLandSurfaceModel", "SchemeLongWave", "SchemePBL", "SchemeShortWave", "SchemeSurfaceLayer", "SchemeMicrophysics"]

wrfrun/model/wrf/{_metgrid.py → utils.py}

@@ -4,7 +4,7 @@ from typing import Dict
 
 from xarray import open_dataset
 
-from wrfrun.core import WRFRUNConfig
+from wrfrun import WRFRUNConfig
 from wrfrun.utils import logger
 
 
@@ -68,4 +68,38 @@ def reconcile_namelist_metgrid(metgrid_path: str):
     WRFRUNConfig.update_namelist(update_values, "wrf")
 
 
-__all__ = ["get_metgrid_levels", "reconcile_namelist_metgrid"]
+def process_after_ndown():
+    """
+    After running ndown.exe, namelist settings are supposed to be changed,
+    so WRF can simulate a higher resolution domain according to `WRF User's Guide <https://www2.mmm.ucar.edu/wrf/users/wrf_users_guide/build/html/running_wrf.html#wrf-nesting>`_.
+    `wrfrun` provide this function to help you change these settings which have multiple values for each domain.
+    The first value will be removed to ensure the value of higher resolution domain is the first value.
+
+    :return:
+    """
+    namelist_data = WRFRUNConfig.get_namelist("wrf")
+
+    for section in namelist_data:
+        if section in ["bdy_control", "namelist_quilt"]:
+            continue
+
+        for key in namelist_data[section]:
+            if key in ["grid_id", "parent_id", "i_parent_start", "j_parent_start", "parent_grid_ratio", "parent_time_step_ratio", "eta_levels"]:
+                continue
+
+            if isinstance(namelist_data[section][key], list):
+
+                if len(namelist_data[section][key]) > 1:
+                    namelist_data[section][key] = namelist_data[section][key][1:]
+
+    namelist_data["domains"]["max_dom"] = 1
+
+    time_ratio = namelist_data["domains"]["parent_time_step_ratio"][1]
+    namelist_data["domains"]["time_step"] = namelist_data["domains"]["time_step"] // time_ratio
+
+    WRFRUNConfig.update_namelist(namelist_data, "wrf")
+
+    logger.info(f"Update namelist after running ndown.exe")
+
+
+__all__ = ["reconcile_namelist_metgrid", "get_metgrid_levels", "process_after_ndown"]

wrfrun/model/wrf/vtable.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass
 
 from wrfrun.core import WRFRUNConfig
+from wrfrun.workspace.wrf import WORKSPACE_MODEL_WPS
 
 
 VTABLE_URI = ":WRFRUN_VTABLE:"
@@ -59,7 +60,7 @@ class VtableFiles:
 
 # register uri
 if not WRFRUNConfig.check_resource_uri(VTABLE_URI):
-    WRFRUNConfig.register_resource_uri(VTABLE_URI, f"{WRFRUNConfig.WPS_WORK_PATH}/ungrib/Variable_Tables")
+    WRFRUNConfig.register_resource_uri(VTABLE_URI, f"{WORKSPACE_MODEL_WPS}/ungrib/Variable_Tables")
 
 
 __all__ = ["VtableFiles"]

wrfrun/plot/wps.py

@@ -12,29 +12,29 @@ from xarray import DataArray
 from wrfrun.utils import logger
 
 # Here defines the colormap for landuse and soiltype
-LANDUSE_CMAP = ListedColormap([
-    [0, .4, 0],         # 1 Evergreen Needleleaf Forest
-    [0, .4, .2],        # 2 Evergreen Broadleaf Forest
-    [.2, .8, .2],       # 3 Deciduous Needleleaf Forest
-    [.2, .8, .4],       # 4 Deciduous Broadleaf Forest
-    [.2, .6, .2],       # 5 Mixed Forests
-    [.3, .7, 0],        # 6 Closed Shrublands
-    [.82, .41, .12],    # 7 Open Shurblands
-    [.74, .71, .41],    # 8 Woody Savannas
-    [1, .84, .0],       # 9 Savannas
-    [0, 1, 0],          # 10 Grasslands
-    [0, 1, 1],          # 11 Permanant Wetlands
-    [1, 1, 0],          # 12 Croplands
-    [1, 0, 0],          # 13 Urban and Built-up
-    [.7, .9, .3],       # 14 Cropland/Natual Vegation Mosaic
-    [1, 1, 1],          # 15 Snow and Ice
-    [.914, .914, .7],   # 16 Barren or Sparsely Vegetated
-    [.5, .7, 1],        # 17 Water (like oceans)
-    [.86, .08, .23],    # 18 Wooded Tundra
-    [.97, .5, .31],     # 19 Mixed Tundra
-    [.91, .59, .48],    # 20 Barren Tundra
-    [0, 0, .88],        # 21 Lake
-])
+LANDUSE_CMAP = ListedColormap((
+    [0, .4, 0],         # 1: Evergreen Needleleaf Forest
+    [0, .4, .2],        # 2: Evergreen Broadleaf Forest
+    [.2, .8, .2],       # 3: Deciduous Needleleaf Forest
+    [.2, .8, .4],       # 4: Deciduous Broadleaf Forest
+    [.2, .6, .2],       # 5: Mixed Forests
+    [.3, .7, 0],        # 6: Closed Shrublands
+    [.82, .41, .12],    # 7: Open Shurblands
+    [.74, .71, .41],    # 8: Woody Savannas
+    [1, .84, .0],       # 9: Savannas
+    [0, 1, 0],          # 10: Grasslands
+    [0, 1, 1],          # 11: Permanent Wetlands
+    [1, 1, 0],          # 12: Croplands
+    [1, 0, 0],          # 13: Urban and Built-up
+    [.7, .9, .3],       # 14: Cropland/Natual Vegation Mosaic
+    [1, 1, 1],          # 15: Snow and Ice
+    [.914, .914, .7],   # 16: Barren or Sparsely Vegetated
+    [.5, .7, 1],        # 17: Water (like oceans)
+    [.86, .08, .23],    # 18: Wooded Tundra
+    [.97, .5, .31],     # 19: Mixed Tundra
+    [.91, .59, .48],    # 20: Barren Tundra
+    [0, 0, .88],        # 21: Lake
+))
 
 LANDUSE_LABELS = [
     'Evergreen Needleleaf Forest',
@@ -61,25 +61,25 @@ LANDUSE_LABELS = [
 ]
 
 
-# Here defines the colormap and labels for soil type
-SOILTYPE_CMAP = ListedColormap([
-    [0, .4, 0],         # 1 Sand
-    [0, .4, .2],        # 2 Loamy Sand
-    [.2, .8, .2],       # 3 Sandy Loam
-    [.2, .8, .4],       # 4 Silt Loam
-    [.2, .6, .2],       # 5 Silt
-    [.3, .7, 0],        # 6 Loam
-    [.82, .41, .12],    # 7 Sandy Clay Loam
-    [.74, .71, .41],    # 8 Silty Clay Loam
-    [1, .84, .0],       # 9 Clay Loam
-    [0, 1, 0],          # 10 Sandy Clay
-    [0, 1, 1],          # 11 Silty Clay
-    [1, 1, 0],          # 12 Clay
-    [1, 0, 0],          # 13 Organic Material
-    [.7, .9, .3],       # 14 Water
-    [1, 1, 1],          # 15 Bedrock
-    [.914, .914, .7]    # 16 Other
-])
+# Here defines the colormap and labels for soil types
+SOILTYPE_CMAP = ListedColormap((
+    [0, .4, 0],         # 1: Sand
+    [0, .4, .2],        # 2: Loamy Sand
+    [.2, .8, .2],       # 3: Sandy Loam
+    [.2, .8, .4],       # 4: Silt Loam
+    [.2, .6, .2],       # 5: Silt
+    [.3, .7, 0],        # 6: Loam
+    [.82, .41, .12],    # 7: Sandy Clay Loam
+    [.74, .71, .41],    # 8: Silty Clay Loam
+    [1, .84, .0],       # 9: Clay Loam
+    [0, 1, 0],          # 10: Sandy Clay
+    [0, 1, 1],          # 11: Silty Clay
+    [1, 1, 0],          # 12: Clay
+    [1, 0, 0],          # 13: Organic Material
+    [.7, .9, .3],       # 14: Water
+    [1, 1, 1],          # 15: Bedrock
+    [.914, .914, .7]    # 16: Other
+))
 
 SOILTYPE_LABELS = [
     "Sand",
@@ -102,13 +102,13 @@ SOILTYPE_LABELS = [
 
 
 def get_cmap_ticks(name: str) -> tuple:
-    """Get corresponding colormap, labels and ticks.
-
-    Args:
-        name (str): Field name.
+    """
+    Get corresponding colormap, labels and ticks.
 
-    Returns:
-        tuple: (colormap, labels, ticks)
+    :param name: File name.
+    :type name: str
+    :return: (colormap, labels, ticks)
+    :rtype: tuple
     """
     # name map
     cmap_ticks_map = {
@@ -141,15 +141,23 @@ def get_cmap_ticks(name: str) -> tuple:
 
 
 def draw_geogrid(data_path: str, field: str, fig: Figure, nrow: int, ncol: int, index: int) -> Tuple[GeoAxes, QuadMesh]:
-    """Draw specific data in geo_em*
-
-    Args:
-        data_path (str): data path.
-        field (str): Which field you want to draw.
-        fig (Figure): Matplotlib figure object.
-        nrow (int): Row number of axes.
-        ncol (int): Column number of axes.
-        index (int): Index of axes.
+    """
+    Draw specific data in geogrid outputs.
+
+    :param data_path: Data path.
+    :type data_path: str
+    :param field: Which field you want to draw.
+    :type field: str
+    :param fig: Matplotlib figure object.
+    :type fig: Figure
+    :param nrow: Row number of axes.
+    :type nrow: int
+    :param ncol: Column number of axes.
+    :type ncol: int
+    :param index: Index of axes.
+    :type index: int
+    :return: (GeoAxes, QuadMesh)
+    :rtype: tuple
     """
     # take out data
     data: DataArray = getvar(Dataset(data_path), field)     # type: ignore
@@ -159,7 +167,7 @@ def draw_geogrid(data_path: str, field: str, fig: Figure, nrow: int, ncol: int,
         data = data.argmax(dim="soil_cat", keep_attrs=True)     # type: ignore
         # get data attrs
         data_attrs = data.attrs
-        data = data + 1
+        data = data + 1     # type: ignore
         data.attrs = data_attrs
 
     # get latitude and longitude

wrfrun/res/__init__.py

@@ -6,17 +6,20 @@ from wrfrun.core import WRFRUNConfig
 RES_PATH = abspath(dirname(__file__))
 WRFRUNConfig.register_resource_uri(WRFRUNConfig.WRFRUN_RESOURCE_PATH, RES_PATH)
 
-CONFIG_TOML_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/config.toml.template"
+RUN_SH_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/run.template.sh"
 EXT_NCL_PLOT_SCRIPT = ":WRFRUN_RESOURCE_PATH:/extension/plotgrids.ncl"
-TASKSYS_PBS_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/job_scheduler/pbs.template"
-TASKSYS_SLURM_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/job_scheduler/slurm.template"
+SCHEDULER_LSF_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/scheduler/lsf.template"
+SCHEDULER_PBS_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/scheduler/pbs.template"
+SCHEDULER_SLURM_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/scheduler/slurm.template"
 NAMELIST_WRFDA = ":WRFRUN_RESOURCE_PATH:/namelist/namelist.input.da_wrfvar.template"
 NAMELIST_DFI = ":WRFRUN_RESOURCE_PATH:/namelist/namelist.input.dfi.template"
 NAMELIST_REAL = ":WRFRUN_RESOURCE_PATH:/namelist/namelist.input.real.template"
 NAMELIST_WRF = ":WRFRUN_RESOURCE_PATH:/namelist/namelist.input.wrf.template"
 NAMELIST_WPS = ":WRFRUN_RESOURCE_PATH:/namelist/namelist.wps.template"
+CONFIG_MAIN_TOML_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/config/config.template.toml"
+CONFIG_WRF_TOML_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/config/wrf.template.toml"
 
-WRFRUNConfig.set_config_template_path(CONFIG_TOML_TEMPLATE)
+WRFRUNConfig.set_config_template_path(CONFIG_MAIN_TOML_TEMPLATE)
 
 
-__all__ = ["CONFIG_TOML_TEMPLATE", "EXT_NCL_PLOT_SCRIPT", "TASKSYS_PBS_TEMPLATE", "TASKSYS_SLURM_TEMPLATE", "NAMELIST_WRFDA", "NAMELIST_DFI", "NAMELIST_REAL", "NAMELIST_WRF", "NAMELIST_WPS"]
+__all__ = ["RUN_SH_TEMPLATE", "EXT_NCL_PLOT_SCRIPT", "SCHEDULER_LSF_TEMPLATE", "SCHEDULER_PBS_TEMPLATE", "SCHEDULER_SLURM_TEMPLATE", "NAMELIST_WRFDA", "NAMELIST_DFI", "NAMELIST_REAL", "NAMELIST_WRF", "NAMELIST_WPS", "CONFIG_MAIN_TOML_TEMPLATE", "CONFIG_WRF_TOML_TEMPLATE"]

wrfrun/res/config/config.template.toml

@@ -0,0 +1,50 @@
+# Config template of wrfrun.
+# Path of the directory which contains input data.
+input_data_path = ""
+
+# Path of the directory to store all outputs.
+output_path = "./outputs"
+log_path = "./logs"
+
+# wrfrun can launch a socket server during NWP execution to report simulation progress.
+# To enable the server, you need to configure the IP address and port on which it will listen to.
+server_host = "localhost"
+server_port = 54321
+
+# How many cores you will use.
+# Note that if you use a job scheduler (like PBS), this value means the number of cores each node you use.
+core_num = 36
+
+
+[job_scheduler]
+# Job scheduler settings.
+# Which job scheduler you want to use
+# wrfrun supports following job schedulers:
+# 1. PBS: "pbs"
+# 2. LSF: "lfs"
+# 3. Slurm: "slurm
+job_scheduler = "pbs"
+
+# Which queue should the task be submited to
+queue_name = ""
+
+# How many nodes you will use.
+node_num = 1
+
+# Custom environment settings
+env_settings = {}
+
+# Path of the python interpreter that will be used to run wrfrun.
+# You can also give its name only.
+python_interpreter = "/usr/bin/python3"     # or just "python3"
+
+
+[model]
+
+[model.wrf]
+# If you want to use WRF model, set use to true.
+use = false
+# Import configurations from another toml file.
+# You can give both absolute and relative path.
+# The relative path is resolved based on this configuration file.
+include = "./configs/wrf.toml"