wrfrun 0.1.7__py3-none-any.whl

wrfrun/model/plot.py

@@ -0,0 +1,54 @@
+from os import chdir, getcwd
+from os.path import abspath, exists
+from shutil import copyfile, move
+
+from wrfrun.core import WRFRUNConfig
+from wrfrun.res import EXT_NCL_PLOT_SCRIPT
+from wrfrun.utils import call_subprocess, check_path, logger
+from .wrf.namelist import prepare_wps_namelist
+from .base import NamelistName
+
+
+def plot_domain_area():
+    """Generate namelist and plot domain area with WRF NCL script.
+
+    """
+    prepare_wps_namelist()
+
+    # get save path
+    save_path = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFRUN_OUTPUT_PATH)
+
+    # check
+    check_path(save_path)
+
+    # conver to absolute path
+    save_path = abspath(save_path)
+    save_path = f"{save_path}/wps_show_dom.png"
+
+    # record original path
+    origin_path = getcwd()
+
+    # enter WPS WORK PATH
+    chdir(WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WPS_WORK_PATH))
+
+    # save namelist
+    WRFRUNConfig.write_namelist(f"./{NamelistName.WPS}", "wps", overwrite=True)
+
+    # copy plot script and plot
+    copyfile(WRFRUNConfig.parse_resource_uri(EXT_NCL_PLOT_SCRIPT), f"./plotgrids.ncl")
+    call_subprocess(["ncl", "./plotgrids.ncl"], print_output=True)
+
+    # save image
+    # we need to check image file, because sometimes ncl doesn't return error code
+    if not exists("./wps_show_dom.png"):
+        logger.error(f"Fail to plot domain with NCL. Check the log above")
+        raise FileNotFoundError
+    move("./wps_show_dom.png", save_path)
+
+    logger.info(f"The image of domain area has been saved to {save_path}")
+
+    # go back
+    chdir(origin_path)
+
+
+__all__ = ["plot_domain_area"]

wrfrun/model/utils.py

@@ -0,0 +1,34 @@
+from os import listdir
+from shutil import move
+
+from ..core import WRFRUNConfig
+from ..utils import check_path, logger
+
+
+def clear_model_logs():
+    """
+    This function can automatically collect WRF log files and save them to ``output_path``.
+    This function is used inside the wrfrun package.
+    If you want to do something about the log files, check the corresponding code of interface functions in ``wrfrun.model.run``.
+
+    :return:
+    :rtype:
+    """
+    work_status = WRFRUNConfig.WRFRUN_WORK_STATUS
+    work_path = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRF_WORK_PATH)
+
+    log_files = [x for x in listdir(work_path) if x.startswith("rsl.")]
+
+    if len(log_files) > 0:
+        logger.warning(f"Found unprocessed log files of {work_status}")
+
+        log_save_path = f"{WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFRUN_OUTPUT_PATH)}/{work_status}/logs"
+        check_path(log_save_path)
+
+        for _file in log_files:
+            move(f"{work_path}/{_file}", f"{log_save_path}/{_file}")
+
+        logger.warning(f"Unprocessed log files of {work_status} has been saved to {log_save_path}, check it")
+
+
+__all__ = ["clear_model_logs"]

wrfrun/model/wrf/__init__.py

@@ -0,0 +1,6 @@
+from .core import *
+from .exec_wrap import *
+from .geodata import *
+from .namelist import *
+from .scheme import *
+from .vtable import *

wrfrun/model/wrf/_metgrid.py

@@ -0,0 +1,71 @@
+from os import listdir
+from os.path import exists
+from typing import Dict
+
+from xarray import open_dataset
+
+from wrfrun.core import WRFRUNConfig
+from wrfrun.utils import logger
+
+
+def get_metgrid_levels(nc_file: str) -> Dict[str, int]:
+    """Read metgrid output file and get metgrid levels, land cat and metgrid soil levels
+
+    Args:
+        nc_file (str): Output nc file path
+
+    Returns:
+        Dict[str, int]: {num_metgrid_levels: number, num_land_cat: number, num_metgrid_soil_level: number}
+    """
+    # check file
+    if not exists(nc_file):
+        logger.error(f"File {nc_file} not exists")
+        raise FileNotFoundError
+
+    # read data
+    dataset = open_dataset(nc_file)
+
+    # read variables
+    num_metgrid_levels = dataset["num_metgrid_levels"].size
+    num_land_cat = dataset.attrs["NUM_LAND_CAT"]
+    num_metgrid_soil_levels = dataset.attrs["NUM_METGRID_SOIL_LEVELS"]
+
+    return dict(
+        num_metgrid_levels=num_metgrid_levels,
+        num_land_cat=num_land_cat,
+        num_metgrid_soil_levels=num_metgrid_soil_levels
+    )
+
+
+def reconcile_namelist_metgrid(metgrid_path: str):
+    """
+    There are some settings in WRF namelist that are affected by metgrid output, for example, ``num_metgrid_levels``.
+    Namelist should be checked and modified before be used by WRF.
+
+    :param metgrid_path: The path store output from metgrid.exe.
+                         If it is None, the default output path will be used.
+    :type metgrid_path: str
+    :return:
+    :rtype:
+    """
+    logger.info(f"Checking values in WRF namelist and metgrid output ...")
+    metgrid_output_name = [x for x in listdir(metgrid_path) if x.endswith(".nc")]
+    metgrid_output_name.sort()
+    metgrid_output_name = metgrid_output_name[0]
+
+    metgrid_levels = get_metgrid_levels(f"{metgrid_path}/{metgrid_output_name}")
+
+    update_values = {
+        "domains": {
+            "num_metgrid_levels": metgrid_levels["num_metgrid_levels"],
+            "num_metgrid_soil_levels": metgrid_levels["num_metgrid_soil_levels"],
+        },
+        "physics": {
+            "num_land_cat": metgrid_levels["num_land_cat"]
+        }
+    }
+
+    WRFRUNConfig.update_namelist(update_values, "wrf")
+
+
+__all__ = ["get_metgrid_levels", "reconcile_namelist_metgrid"]

wrfrun/model/wrf/_ndown.py

@@ -0,0 +1,39 @@
+from wrfrun.core import WRFRUNConfig
+from wrfrun.utils import logger
+
+
+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__ = ["process_after_ndown"]