wrfrun 0.1.7__py3-none-any.whl

wrfrun/utils.py

@@ -0,0 +1,257 @@
+import logging
+import subprocess
+from datetime import datetime
+from os import chdir, getcwd, makedirs
+from os.path import exists
+from shutil import rmtree
+from time import time
+from typing import Optional, List, Dict
+
+from rich.logging import RichHandler
+
+
+def set_logger(logger_list: List[str], logger_level: Optional[Dict] = None):
+    """
+    This function will replace all handlers of each logger in ``logger_list`` with RichHandler.
+    If there are some custom handlers in logger, they will be replaced too.
+
+    :param logger_list: A list contains loggers.
+    :type logger_list: list
+    :param logger_level: You can specify the log level in ``logger_level``, with the name of logger is the key, and the level of logger is the value.
+                         Default if None, with which all loggers' level will be set to ``logging.WARNING``.
+    :type logger_level: list | None
+    :return:
+    :rtype:
+    """
+    formatter = logging.Formatter(
+        "%(name)s :: %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
+    )
+    # use rich handler
+    handler = RichHandler()
+    handler.setFormatter(formatter)
+
+    for logger_name in logger_list:
+        if logger_name in logging.root.manager.loggerDict:
+            _logger = logging.getLogger(logger_name)
+            for _handler in _logger.handlers:
+                _logger.removeHandler(_handler)
+            _logger.addHandler(handler)
+
+            if logger_level is not None and logger_name in logger_level:
+                _logger.setLevel(logger_level[logger_name])
+            else:
+                _logger.setLevel(logging.WARNING)
+                
+                
+# init wrfrun logger
+logger = logging.getLogger("wrfrun")
+set_logger(["wrfrun", ], {"wrfrun": logging.DEBUG})
+
+
+def unify_logger_format():
+    """
+    This function is only supposed to be used internally.
+    This function will replace all handlers of each logger with ``rich.logging.RichHandler``.
+    Use this carefully.
+
+    :return:
+    :rtype:
+    """
+    set_logger(
+        ["cdsapi", "cfgrib", "datapi"],
+        {
+            "cdsapi": logging.INFO,
+            "cfgrib": logging.ERROR,
+            "datapi": logging.INFO
+        }
+    )
+
+
+def check_path(*args, force=False):
+    """Check and create all the path in *args
+
+    Returns:
+
+    """
+    for _path in args:
+        if exists(_path) and force:
+            rmtree(_path)
+        if not exists(_path):
+            makedirs(_path)
+
+
+def logger_add_file_handler(log_path: str):
+    """Add file handler to logger
+
+    Args:
+        log_path (str): Folder to place log file
+    """
+    # check log save path
+    check_path(log_path)
+
+    # add file handler
+    file_handler = logging.FileHandler(
+        f"{log_path}/{datetime.fromtimestamp(time()).strftime('%Y-%m-%d %H:%M:%S')}.log")
+    file_handler.setFormatter(logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s :: %(message)s", datefmt="%m-%d %H:%M:%S"))
+    logger.addHandler(file_handler)
+
+
+def rectify_domain_size(point_num: int, nest_ratio: int) -> int:
+    """Rectify domain size.
+
+    Args:
+        point_num (int): Point number of one side.
+        nest_ratio (int): The nesting ratio relative to the domain’s parent.
+
+    Returns:
+        int: New size.
+    """
+    # calculate remainder
+    point_num_mod = (point_num - 1) % nest_ratio
+
+    if point_num_mod == 0:
+        return point_num
+
+    if point_num_mod < nest_ratio / 2:
+        # # point_num_mod is closer to (nest_ratio - 1) than nest_ratio
+        point_num -= point_num_mod
+    else:
+        # # point_num_mod is closer to nest_ratio than (nest_ratio - 1)
+        point_num += (nest_ratio - point_num_mod)
+
+    return point_num
+
+
+def _calculate_domain_shape(step: float, resolution: int, grid_resolution=110, nest_ratio=1) -> int:
+    """Calculate domain shape based on its area
+
+    Args:
+        step (float): Length of the side. Unit: degree.
+        resolution (int): Resolution of domain. Unit: km.
+        grid_resolution (int, optional): Resolution of grid. Unit: km. Defaults to 110.
+        nest_ratio (int, optional): The nesting ratio relative to the domain’s parent.
+
+    Returns:
+        tuple[int, int]: (length of x, length of y)
+    """
+    # calculate res based on doamin area and resolution
+    res = int(step * grid_resolution) // resolution
+
+    # rectify
+
+    return rectify_domain_size(res, nest_ratio=nest_ratio)
+
+
+def calculate_domain_shape(lon_step: float, lat_step: float, resolution: int, grid_resolution=110, nest_ratio=1) -> tuple[int, int]:
+    """Calculate domain shape based on its area
+
+    Args:
+        lon_step (float): Length in X direction. Unit: degree.
+        lat_step (float): Length in Y direction. Unit: degree.
+        resolution (int): Resolution of domain. Unit: km.
+        grid_resolution (int, optional): Resolution of grid. Unit: km. Defaults to 110.
+        nest_ratio (int, optional): The nesting ratio relative to the domain’s parent.
+
+    Returns:
+        tuple[int, int]: (length of x, length of y)
+    """
+
+    return (
+        _calculate_domain_shape(
+            lon_step, resolution, grid_resolution=grid_resolution, nest_ratio=nest_ratio),
+        _calculate_domain_shape(
+            lat_step, resolution, grid_resolution=grid_resolution, nest_ratio=nest_ratio)
+    )
+
+
+def _check_domain_shape(point_num: int, nest_ratio: int) -> bool:
+    """Check domain shape.
+
+    Args:
+        point_num (int): Point number of one side.
+        nest_ratio (int): The nesting ratio relative to the domain’s parent.
+
+    Returns:
+        bool: True if pass check else False.
+    """
+    if (point_num - 1) % nest_ratio != 0:
+        return False
+    else:
+        return True
+
+
+def check_domain_shape(x_point_num: int, y_point_num: int, nest_ratio: int) -> tuple[bool, bool]:
+    """Check domain shape.
+
+    Args:
+        x_point_num (int): Point number of X side.
+        y_point_num (int): Point number of Y side.
+        nest_ratio (int): The nesting ratio relative to the domain’s parent.
+
+    Returns:
+        tuple[bool, bool]: Tuple of bool. True if pass check else False
+    """
+    return (
+        _check_domain_shape(x_point_num, nest_ratio=nest_ratio),
+        _check_domain_shape(y_point_num, nest_ratio=nest_ratio)
+    )
+
+
+def check_subprocess_status(status: subprocess.CompletedProcess):
+    """Check subprocess return code and print log if their return code != 0
+
+    Args:
+        status (CompletedProcess): Status from subprocess.
+    """
+    if status.returncode != 0:
+        # print command
+        command = status.args
+        logger.error(f"Failed to exec command: {command}")
+
+        # print log
+        logger.error(f"====== stdout ======")
+        logger.error(status.stdout.decode())
+        logger.error(f"====== ====== ======")
+        logger.error(f"====== stderr ======")
+        logger.error(status.stderr.decode())
+        logger.error(f"====== ====== ======")
+
+        # raise error
+        raise RuntimeError
+
+
+def call_subprocess(command: list[str], work_path: Optional[str] = None, print_output=False):
+    """
+    Execute the given command in system shell.
+
+    :param command: A list contains the command and parameters to be executed.
+    :type command: list
+    :param work_path: The work path of the command.
+                      If None, works in current directory.
+    :type work_path: str | None
+    :param print_output: If print standard output and error in the logger.
+    :type print_output: bool
+    :return:
+    :rtype:
+    """
+    if work_path is not None:
+        origin_path = getcwd()
+        chdir(work_path)
+    else:
+        origin_path = None
+
+    status = subprocess.run(' '.join(command), shell=True, capture_output=True)
+
+    if origin_path is not None:
+        chdir(origin_path)
+
+    check_subprocess_status(status)
+
+    if print_output:
+        logger.info(status.stdout.decode())
+        logger.warning(status.stderr.decode())
+
+
+__all__ = ["logger", "check_path", "logger_add_file_handler", "calculate_domain_shape", "rectify_domain_size", "check_domain_shape",
+           "check_subprocess_status", "call_subprocess", "set_logger", "unify_logger_format"]

wrfrun/workspace.py

@@ -0,0 +1,88 @@
+"""
+This file contains functions to interact with WRF workspace
+"""
+
+from os import listdir, makedirs, symlink
+from os.path import exists
+
+from .core import WRFRUNConfig
+from .utils import check_path, logger
+
+
+def prepare_workspace():
+    """Initialize workspace
+
+    """
+    logger.info(f"Initialize workspace...")
+
+    # extract WRF path
+    wrf_config = WRFRUNConfig.get_model_config("wrf")
+    wps_path = wrf_config["wps_path"]
+    wrf_path = wrf_config["wrf_path"]
+    wrfda_path = wrf_config["wrfda_path"]
+
+    WRFRUN_TEMP_PATH = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFRUN_TEMP_PATH)
+    WORK_PATH = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFRUN_WORKSPACE_PATH)
+    REPLAY_WORK_PATH = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFRUN_REPLAY_WORK_PATH)
+    WPS_WORK_PATH = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WPS_WORK_PATH)
+    WRF_WORK_PATH = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRF_WORK_PATH)
+    WRFDA_WORK_PATH = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFDA_WORK_PATH)
+    output_path = WRFRUNConfig.parse_resource_uri(WRFRUNConfig.WRFRUN_OUTPUT_PATH)
+
+    # check folder
+    check_path(WRFRUN_TEMP_PATH)
+    check_path(REPLAY_WORK_PATH, force=True)
+    check_path(output_path)
+
+    if exists(wrfda_path):
+        WRFRUNConfig.USE_WRFDA = True
+
+    # create folder to run WPS, and WRF
+    # check the path
+    if not (exists(wps_path) and exists(wrf_path)):
+        logger.error(f"Your WPS or WRF path is wrong")
+        raise FileNotFoundError(f"Your WPS or WRF path is wrong")
+
+    # remove old file
+    if exists(WORK_PATH):
+        logger.info(f"Remove old files...")
+    check_path(WPS_WORK_PATH, f"{WPS_WORK_PATH}/outputs",
+               WRF_WORK_PATH, WRFDA_WORK_PATH, force=True)
+    logger.info(f"Link essential files...")
+
+    # link {wps_path}/*
+    # collect file except folder geogrid
+    file_list = [
+        x for x in listdir(wps_path) if x not in ["geogrid", "namelist.wps"]
+    ]
+    for file in file_list:
+        symlink(f"{wps_path}/{file}", f"{WPS_WORK_PATH}/{file}")
+
+    # create folder geogrid and link default GEOGRID file
+    makedirs(f"{WPS_WORK_PATH}/geogrid")
+    symlink(
+        f"{wps_path}/geogrid/GEOGRID.TBL", f"{WPS_WORK_PATH}/geogrid/GEOGRID.TBL"
+    )
+
+    # # link {wrf_path}/run/*, except namelist.input
+    file_list = [x for x in listdir(
+        f"{wrf_path}/run") if not x.startswith("namelist")]
+    for file in file_list:
+        symlink(f"{wrf_path}/run/{file}", f"{WRF_WORK_PATH}/{file}")
+
+    if WRFRUNConfig.USE_WRFDA:
+        # # link {wrfda_path}/bin/*.exe
+        file_list = ["da_wrfvar.exe", "da_update_bc.exe"]
+        for file in file_list:
+            symlink(f"{wrfda_path}/var/build/{file}", f"{WRFDA_WORK_PATH}/{file}")
+
+        # # link {wrfda_path}/var/run/*
+        file_list = listdir(f"{wrfda_path}/var/run")
+        for file in file_list:
+            symlink(f"{wrfda_path}/var/run/{file}", f"{WRFDA_WORK_PATH}/{file}")
+
+        # # link {wrfda_path}/run/LANDUSE.TBL
+        symlink(f"{wrfda_path}/run/LANDUSE.TBL", f"{WRFDA_WORK_PATH}/LANDUSE.TBL")
+
+
+__all__ = ["prepare_workspace"]

wrfrun-0.1.7.dist-info/METADATA

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: wrfrun
+Version: 0.1.7
+Summary: wrfrun is a comprehensive toolkit for managing and using WRF
+Keywords: WRF
+Author-Email: Syize <syizeliu@gmail.com>
+Maintainer-Email: Syize <syizeliu@gmail.com>
+License: GPL-3.0-or-later
+Project-URL: homepage, https://github.com/Syize/wrfrun
+Project-URL: repository, https://github.com/Syize/wrfrun
+Project-URL: documentation, https://wrfrun.syize.cn
+Project-URL: Bug Tracker, https://github.com/Syize/wrfrun/issues
+Requires-Python: <3.13
+Requires-Dist: numpy<2.0.0
+Requires-Dist: xarray
+Requires-Dist: netCDF4
+Requires-Dist: rich
+Requires-Dist: pandas
+Requires-Dist: f90nml
+Requires-Dist: cdsapi
+Requires-Dist: matplotlib
+Requires-Dist: Cartopy
+Requires-Dist: wrf-python
+Requires-Dist: cfgrib
+Requires-Dist: tomli
+Requires-Dist: tomli-w
+Description-Content-Type: text/markdown
+
+# wrfrun: A toolkit to control WRF
+
+##  What is wrfrun？
+
+Using and managing WRF can be a tedious task. WRF's configuration file contains a large number of settings, which generally need to be configured separately for each simulation case, and the user usually needs to rely on other tools or scripts to manage the simulation of different cases, which causes a lot of inconvenience. In addition, the whole process of running the WRF model involves running many programs, which is very time-consuming to run manually and requires the use of scripts to automate certain processes.
+
+`wrfrun` is a comprehensive toolkit for managing and using WRF. `wrfrun` wraps the WRF model so that the user only needs to call the corresponding Python function to run the corresponding part of the model. `wrfrun` avoids cluttering up the user's working directory with a lot of useless files by creating a temporary directory in which the WRF model would be run. `wrfrun` automatically saves mode configurations and wrfrun configurations, which makes it easier to manage the simulation and reproduction of different cases. `wrfrun` also provides more features through extensions, which help users to do related research better.
+
+## Main Features
+
+The following are the main features that wrfrun wants to achieve. These features have been basically realized, and are still under continuous improvement.
+
+- Isolate the WRF runtime directory in a separate temporary directory.
+- Automatic saving of mode output, logs and configurations.
+- Provide an interface to run any part of the WRF model.
+- Real-time parsing of WRF logs, feedback on simulation progress.
+- Support for adding more functionality through extensions.
+
+## Dependencies
+
+You need to install `meson` and `ninja` at first, both of which can be installed using `pip`:
+
+```bash
+pip install meson ninja
+```
+
+Make sure the path `$HOME/.local/bin` has been added to your environment variable `PATH`.
+
+## Installation
+
+Install using pip:
+
+```bash
+pip install wrfrun
+```
+
+## Documentation
+
+Please check [Wiki](https://wrfrun.syize.cn).

wrfrun-0.1.7.dist-info/RECORD

@@ -0,0 +1,46 @@
+wrfrun-0.1.7.dist-info/METADATA,sha256=nrPBmS0UxcjIiCN9wLyL798-r3OKpirBJUPlWrzobw8,2912
+wrfrun-0.1.7.dist-info/WHEEL,sha256=5J4neoE7k6LMgx4Fz1FHgBiO3YevhJGtNQ3muDrdLQM,75
+wrfrun/__init__.py,sha256=l2zGk2qDWa3EXIlwvzqBYZHOU9273TN75Rmvx_7PAYM,58
+wrfrun/data.py,sha256=AjkDSZqkLROnWLw9qDOBUctoQmJ3R1bkfjnPzLMjPfs,14751
+wrfrun/pbs.py,sha256=gzRHbYqpU-c8lynu39TUKNvmPntvrPwfQVxK337yvjw,2454
+wrfrun/run.py,sha256=0mvuI98gLjq1gP1eaLUZiU1LJMCjtL668aKZTwu3n2g,9114
+wrfrun/utils.py,sha256=v3ZRu3Rd8-pZjo7I0PrJtgBN1zIBAt_nVPs0BP_DFwY,8118
+wrfrun/workspace.py,sha256=5tWIIFxwAE4hkdg_wJALGDc3P0bfwb_IRTIyPIjN-tE,3105
+wrfrun/core/__init__.py,sha256=bf9Fp6VS5i9xB10lazYBOkJapF2jnQpyiB6qucVjp0I,107
+wrfrun/core/base.py,sha256=S9Mqr3LOpos0CP0TsFwtCQl0tLIObIhjX7VxjS0LRDY,23172
+wrfrun/core/config.py,sha256=v7zdhAthlMmjv_BWINxkmgNHLvKZdzQhgM5B-Nlsl7M,23795
+wrfrun/core/error.py,sha256=fCWVC4-GTyDH2obzu9-D_bzF8_uzqZoUi7Ffy0B5qoc,1324
+wrfrun/core/replay.py,sha256=oyV9QppZG99GbAksQqoRxeBQ3jjXU-7YqkpxHRyfBvc,3229
+wrfrun/core/server.py,sha256=KK_yj4J-5F_s-rKO5FK7e8WojsnuZMbhWtMceWYbaBY,6524
+wrfrun/extension/__init__.py,sha256=alIDGBnxWH4JvP-UW-7N99seBBi0r1GV1h8f1ERFBec,21
+wrfrun/extension/utils.py,sha256=OBIAlAXakbh1QhrF2BFlYAFV062ZfJjX0mYJkmcU_RI,2751
+wrfrun/extension/littler/__init__.py,sha256=pG-YPVG0gJIJ6s4xcAz9S_CnUxpUcz33wl9eNUSgxGk,20
+wrfrun/extension/littler/utils.py,sha256=TsN3GiAFszPWF7RNM_hYdARRY_OLL8mYm87UyZupUtU,21615
+wrfrun/model/__init__.py,sha256=lQNNnh3evXZytLAjdnhlIEFWerP1L0XAgDAUQhqIRyE,119
+wrfrun/model/base.py,sha256=WnVNu12ICJgThfZR7kK6_XLCQWVYFsHrdyAz8wl_YRc,218
+wrfrun/model/plot.py,sha256=ATG5nl5kV8YfoeNFIPLCUnnIQIrfIFNGPb9d8raM6S0,1582
+wrfrun/model/utils.py,sha256=Pyj9D9NMKw3wQcZcM7pJaLG09Vov447AxFKoVeZZU2s,1155
+wrfrun/model/wrf/__init__.py,sha256=T3S1BD9QDoW4uq871QW4_8-2BvCRWYEecz71EcdbMaI,136
+wrfrun/model/wrf/core.py,sha256=FEzRXUKK5dENxev3wR_GON5n1Zxq4Hj-Bs_BNP7P_ok,32134
+wrfrun/model/wrf/exec_wrap.py,sha256=gIsGZDAjzRzxt24eo8t-laIK4UBiyKf_ysfAZLlE1og,3918
+wrfrun/model/wrf/geodata.py,sha256=X9OUOm0__5NI7sl2z1F9_ur5wZ4P0HkpBNcRZQYKof0,9740
+wrfrun/model/wrf/_metgrid.py,sha256=i2qILM_1LkdnBZqXXL3swVhMRvhFvq4bOcRPGI6kSzg,2248
+wrfrun/model/wrf/namelist.py,sha256=t_JuWYj4oNNVwzTMKo6BNlv2LIq4t3JC7ZgVkaKfNbA,14923
+wrfrun/model/wrf/_ndown.py,sha256=ZcWttGXiT5FzGCAohmbeNU6bi8GUOUleiTK0ivn2BaI,1548
+wrfrun/model/wrf/scheme.py,sha256=F7HxoaNkkPpjkse5t9sGS3CJDvn_yBdHoaCG7WLdbqY,8524
+wrfrun/model/wrf/vtable.py,sha256=0V4fo0Limnx4oJ2NByq_eHPzj8L4mnHNlrKL34Buw1A,2432
+wrfrun/plot/__init__.py,sha256=9Kn0IgkX10sHEqHJwk7mZV-dP14XMNcvXN8znO89FIw,19
+wrfrun/plot/wps.py,sha256=AQ1B6llNUrPU3PR8XKNLSzs_H-v60a0Wep-8Mcto6NM,5319
+wrfrun/res/__init__.py,sha256=YBcVaM2EZZJkDDvyKdk-WZmcFQoTFENZKCwcIQzEf3I,1133
+wrfrun/res/config.toml.template,sha256=aVXCSzhbV3P-MQCZOk2g-y0auRmqgr3jW920W3wks9g,4386
+wrfrun/res/run.sh.template,sha256=ZN7k0a9ONOtZUQ67JiTva-0DNVJG5O7BdOXQ8-LCscs,247
+wrfrun/res/extension/plotgrids.ncl,sha256=B0mvH1H1j_w7EEana9HmU1XJZtG0w9IccQ54zXpbQG0,7546
+wrfrun/res/namelist/namelist.input.da_wrfvar.template,sha256=Cwc-XPu_spJeQte4duWrulPBOLRMEBtn0mIn0pgMmKY,4912
+wrfrun/res/namelist/namelist.input.dfi.template,sha256=E7MVbIvMopkAM7xGUC4vniC1WOUVbIbdLfkTKHqzX_o,6591
+wrfrun/res/namelist/namelist.input.real.template,sha256=DDUiArtBFmzBwVjkZW4NOrBR34eIOk1vV0VsyL0stsk,6214
+wrfrun/res/namelist/namelist.input.wrf.template,sha256=myrKi79sQ8ABBsmQJkcgN0WLbWJdtMVPIjuAC1MTMuM,6213
+wrfrun/res/namelist/namelist.wps.template,sha256=HlA7-SHs4C-cKRb3h6D0Kl1Y-5VSJ1Lw9hLiXWGAN0Q,1017
+wrfrun/res/namelist/parame.in.template,sha256=vR8JSix20FAKGqj6jK8QuEAeWkGvg8_iptdVlzjPX6o,259
+wrfrun/res/job_scheduler/pbs.template,sha256=m7eyvZkzQRpjs43CvSeZ1biHYNyEJJkgXt3IU5ZhCmg,148
+wrfrun/res/job_scheduler/slurm.template,sha256=BrKL8DcHfpFfv0y0z7Qe_cqjwfzMyF-3V6vM72ehr9Y,312
+wrfrun-0.1.7.dist-info/RECORD,,

wrfrun-0.1.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: meson
+Root-Is-Purelib: true
+Tag: py3-none-any