wrfrun 0.1.8__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.
@@ -84,7 +156,9 @@ def prepare_wps_namelist():
             "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"}
     }
 
     # # update namelist
@@ -107,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"]
@@ -370,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/{_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/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"

wrfrun/res/{config.toml.template → config/wrf.template.toml}

@@ -1,46 +1,5 @@
-# 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.
-# 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 debug level
-debug_level = 100
-
-# ################################################### Only settings above is necessary ###########################################
-
-
-# ####################################### You can give more settings about the NWP you will use ##################################
-
-[model.wrf]
-# Config for WRF
-# WRF model path
+# Config for WRF model.
+# WRF model path.
 wps_path = '/path/to/your/WPS/folder'
 wrf_path = '/path/to/your/WRF/folder'
 # WRFDA is optional.
@@ -59,8 +18,10 @@ user_wrfda_namelist = ''
 # If you make a restart run?
 restart_mode = false
 
+# debug level for WRF model
+debug_level = 100
 
-[model.wrf.time]
+[time]
 # Advance time config for WRF
 # Set the start and end date. It will be used for all domains.
 # You can also provide all the dates as a list, with each date for the corresponding domain.
@@ -87,7 +48,7 @@ parent_time_step_ratio = [1, 3, 4]
 restart_interval = -1
 
 
-[model.wrf.domain]
+[domain]
 # Advance domain config for WRF.
 # Set domain number.
 domain_num = 3
@@ -119,7 +80,7 @@ ref_lon = 120.5
 stand_lon = 120.5
 
 
-[model.wrf.scheme]
+[scheme]
 # Advance physics scheme config for WRF.
 # To loop up the nickname for all physics schemes, please see: https://wrfrun.syize.cn.
 # Option contains many other settings related to the scheme.

wrfrun/res/run.template.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+{SCHEDULER_SETTINGS}
+
+ulimit -s unlimited
+
+{ENV_SETTINGS}
+
+cd {WORK_PATH}
+
+{WORK_COMMAND}

wrfrun/res/scheduler/lsf.template

@@ -0,0 +1,5 @@
+#BSUB -q {QUEUE_NAME}
+#BSUB -o {STDOUT_LOG_PATH}
+#BSUB -e {STDERR_LOG_PATH}
+#BSUB -n {CORE_NUM}
+#BSUB -J wrfrun

wrfrun/res/{job_scheduler → scheduler}/pbs.template

@@ -1,4 +1,4 @@
-#PBS -q batch
+#PBS -q {QUEUE_NAME}
 #PBS -N wrfrun
 #PBS -o {STDOUT_LOG_PATH}
 #PBS -e {STDERR_LOG_PATH}

wrfrun/res/{job_scheduler → scheduler}/slurm.template

@@ -3,4 +3,5 @@
 #SBATCH -n{CORE_NUM}                %core num
 #SBATCH --time=9999:00:00           %maximum run time
 #SBATCH --output={STDOUT_LOG_PATH}  %stdout output log path
-#SBATCH --error={STDERR_LOG_PATH}   %error output log path
+#SBATCH --error={STDERR_LOG_PATH}   %error output log path
+#SBATCH -p {QUEUE_NAME}

wrfrun/run.py

@@ -4,15 +4,15 @@
 
 import sys
 import threading
-from os.path import abspath, dirname, exists
+from os.path import abspath, dirname
 from typing import Optional, Tuple, Union
 
 from .core import ExecConfigRecorder, WRFRUNConfig, WRFRunBasicError, WRFRunServer, WRFRunServerHandler, replay_config_generator, stop_server
 from .data import prepare_wps_input_data
-from .model import clear_model_logs, plot_domain_area
-from .pbs import in_pbs, prepare_pbs_script
+from .model import clear_model_logs, generate_domain_area
+from .scheduler import in_job_scheduler, prepare_scheduler_script
 from .utils import call_subprocess, logger, logger_add_file_handler
-from .workspace import prepare_workspace
+from .workspace import prepare_workspace, check_workspace
 
 
 def confirm_model_area():
@@ -20,9 +20,9 @@ def confirm_model_area():
     Ask user to check domain area.
 
     """
-    plot_domain_area()
+    generate_domain_area()
 
-    if not in_pbs():
+    if not in_job_scheduler():
         # ask user
         logger.warning(f"Check the domain image, is it right?")
         answer = input("Is it right? [y/N]: ")
@@ -41,14 +41,14 @@ class WRFRun:
     _instance = None
     _initialized = False
 
-    def __init__(self, config_file: str, init_workspace=True, start_server=False, pbs_mode=False, prepare_wps_data=False, wps_data_area: Optional[Tuple[int, int, int, int]] = None):
+    def __init__(self, config_file: str, init_workspace=True, start_server=False, submit_job=False, prepare_wps_data=False, wps_data_area: Optional[Tuple[int, int, int, int]] = None):
         """
         WRFRun, a context class to achieve some goals before and after running WRF, like save a copy of config file, start and close WRFRunServer.
 
         :param config_file: ``wrfrun`` config file's path.
         :param init_workspace: If True, clean old files in workspace and re-create it.
         :param start_server: Whether to start WRFRunServer, defaults to True.
-        :param pbs_mode: If commit this task to the PBS system, defaults to True.
+        :param submit_job: If commit this task to the PBS system, defaults to True.
         :param prepare_wps_data: If True, download input datas for WPS first.
         :param wps_data_area: If ``prepare_wps_data==True``, you need to give the area range of input data so download function can download data from ERA5.
         :return:
@@ -63,7 +63,7 @@ class WRFRun:
         self._ip = ""
         self._port = -1
 
-        self._pbs_mode = pbs_mode
+        self._submit_job = submit_job
         self._init_workspace = init_workspace
         self._prepare_wps_data = prepare_wps_data
         self._wps_data_area = wps_data_area
@@ -89,31 +89,27 @@ class WRFRun:
 
     def __enter__(self):
         # check workspace
-        check_list = [WRFRUNConfig.WPS_WORK_PATH, WRFRUNConfig.WRF_WORK_PATH, WRFRUNConfig.WRFDA_WORK_PATH]
-        check_list = [WRFRUNConfig.parse_resource_uri(x) for x in check_list]
-        for _path in check_list:
-            if not exists(_path) and not self._init_workspace:
-                logger.info(f"Force re-create workspace because it is broken.")
-                self._init_workspace = True
-                break
+        if not check_workspace():
+            logger.info(f"Force re-create workspace because it is broken.")
+            self._init_workspace = True
 
         # here is the condition we need to initialize workspace:
-        # 1. pbs_mode = True and init_workspace = True, do prepare_workspace before committing the task to the PBS system.
-        # 2. pbs_mode = False and init_workspace = True, do prepare_workspace.
-        if self._pbs_mode and not in_pbs():
+        # 1. submit_job = True and init_workspace = True, do prepare_workspace before submitting the task to job scheduler.
+        # 2. submit_job = False and init_workspace = True, do prepare_workspace.
+        if self._submit_job and not in_job_scheduler():
             if self._init_workspace:
                 prepare_workspace()
 
             # ask user before commit the task
             confirm_model_area()
 
-            prepare_pbs_script(self._entry_file_path)
+            prepare_scheduler_script(self._entry_file_path)
 
             call_subprocess(["qsub", f"{self._entry_file_dir_path}/run.sh"])
             logger.info(f"Work has been submit to PBS system")
             exit(0)
 
-        elif not self._pbs_mode:
+        elif not self._submit_job:
             if self._init_workspace:
                 prepare_workspace()
 
@@ -139,7 +135,7 @@ class WRFRun:
             else:
                 prepare_wps_input_data(self._wps_data_area)
 
-        logger.info(r"Enter wrfrun context")
+        logger.debug(r"Enter wrfrun context")
 
         return self
 
@@ -157,7 +153,7 @@ class WRFRun:
 
         clear_model_logs()
 
-        logger.info(r"Exit wrfrun context")
+        logger.debug(r"Exit wrfrun context")
 
     def _start_wrfrun_server(self):
         """

wrfrun/scheduler/__init__.py

@@ -0,0 +1,35 @@
+"""
+wrfrun.scheduler
+################
+
+``wrfrun`` provides functions to help users take care of the job scheduler.
+
+Submodules
+**********
+
+======================================= ===========================================================
+:doc:`env </api/scheduler.env>`         Functions to manage environment variables in job scheduler.
+:doc:`lsf </api/scheduler.lsf>`         Scheduler interface for LSF job scheduler.
+:doc:`pbs </api/scheduler.pbs>`         Scheduler interface for PBS job scheduler.
+:doc:`script </api/scheduler.script>`   Generate shell scripts for job scheduler.
+:doc:`slurm </api/scheduler.slurm>`     Scheduler interface for Slurm job scheduler.
+:doc:`utils </api/scheduler.utils>`     Utility functions.
+======================================= ===========================================================
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    env <scheduler.env>
+    lsf <scheduler.lsf>
+    pbs <scheduler.pbs>
+    slurm <scheduler.slurm>
+    utils <scheduler.utils>
+"""
+
+from .env import *
+from .lsf import *
+from .pbs import *
+from .script import *
+from .slurm import *
+from .utils import *