wrfrun 0.2.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

wrfrun/model/type.py

@@ -0,0 +1,116 @@
+"""
+wrfrun.model.type
+#################
+
+Definition of types used in ``wrfrun.model``.
+
+.. autosummary::
+    :toctree: generated/
+
+    DomainSetting
+"""
+
+from typing import Literal, TypedDict, Union
+
+
+class DomainSetting(TypedDict):
+    """
+    Domain settings which can be used to create a projection.
+
+    .. py:attribute:: resolution_x
+        :type: int
+
+        Spacing of the domain 1 grid points along the longitude direction, unit: meter.
+
+    .. py:attribute:: resolution_y
+        :type: int
+
+        Spacing of the domain 1 grid points along the latitude direction, unit: meter.
+
+    .. py:attribute:: points_x
+        :type: Union[list[int], tuple[int]]
+
+        Number of the grid points along the longitude direction of each domain.
+
+    .. py:attribute:: points_y
+        :type: Union[list[int], tuple[int]]
+
+        Number of the grid points along the latitude direction of each domain.
+
+    .. py:attribute:: x_parent_index
+        :type: Union[list[int], tuple[int]]
+
+        Corresponding x index in the parent grid of the first point.
+
+    .. py:attribute:: y_parent_index
+        :type: Union[list[int], tuple[int]]
+
+        Corresponding y index in the parent grid of the first point.
+
+    .. py:attribute:: domain_num
+        :type: int
+
+        Domain number.
+
+    .. py:attribute:: grid_spacing_ratio
+        :type: Union[list[int], tuple[int]]
+
+        Ratio of the grid resolution of each domain compared to the domain 1.
+
+    .. py:attribute:: projection_type
+        :type: Literal["lambert", "polar", "mercator", "lat-lon"]
+
+        Projection type.
+
+    .. py:attribute:: reference_lat
+        :type: Union[int, float]
+
+        Reference latitude.
+
+    .. py:attribute:: reference_lon
+        :type: Union[int, float]
+
+        Reference longitude.
+
+    .. py:attribute:: true_lat1
+        :type: Union[int, float]
+
+        True latitude (1:1 scale).
+
+    .. py:attribute:: true_lat2
+        :type: Union[int, float]
+
+        True latitude (1:1 scale).
+
+    .. py:attribute:: stand_lon
+        :type: Union[int, float]
+
+        Standard longitude.
+    """
+
+    # generally refers to the spacing of the parent grid points along the latitude, unit: meter
+    resolution_x: int
+    # spacing of the parent grid points along the longitude, unit: meter
+    resolution_y: int
+    # generally refers to the number of the grid points along the latitude.
+    points_x: Union[list[int], tuple[int]]
+    # number of the grid points along the longitude.
+    points_y: Union[list[int], tuple[int]]
+    # corresponding index in the parent grid of the first point.
+    x_parent_index: Union[list[int], tuple[int]]
+    y_parent_index: Union[list[int], tuple[int]]
+    # domain number
+    domain_num: int
+    # ratio of the grid point spacing.
+    grid_spacing_ratio: Union[list[int], tuple[int]]
+    # projection type
+    projection_type: Literal["lambert", "polar", "mercator", "lat-lon"]
+    # reference point, true longitude and latitude
+    reference_lat: Union[int, float]
+    reference_lon: Union[int, float]
+    true_lat1: Union[int, float]
+    true_lat2: Union[int, float]
+    stand_lon: Union[int, float]
+
+
+__all__ = ["DomainSetting"]

wrfrun/model/utils.py

@@ -10,12 +10,8 @@ Utility functions used by models.
     clear_model_logs
 """
 
-from os import listdir
-from shutil import move
-
-from ..core import get_wrfrun_config
-from ..utils import check_path, logger
-from ..workspace.wrf import get_wrf_workspace_path
+from ..core import WRFRUN
+from .wrf.log import clear_wrf_logs
 
 
 def clear_model_logs():
@@ -23,22 +19,15 @@ def clear_model_logs():
     This function can automatically collect unsaved log files,
     and save them to the corresponding output directory of the ``Executable``.
     """
-    WRFRUNConfig = get_wrfrun_config()
-    work_status = WRFRUNConfig.WRFRUN_WORK_STATUS
-    work_path = WRFRUNConfig.parse_resource_uri(get_wrf_workspace_path("wrf"))
-
-    log_files = [x for x in listdir(work_path) if x.startswith("rsl.") or x.endswith(".log")]
-
-    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)
+    WRFRUNConfig = WRFRUN.config
 
-        for _file in log_files:
-            move(f"{work_path}/{_file}", f"{log_save_path}/{_file}")
+    func_map = {
+        "wrf": clear_wrf_logs
+    }
 
-        logger.warning(f"Unprocessed log files of {work_status} has been saved to {log_save_path}, check it")
+    for _model in func_map:
+        if _model in WRFRUNConfig["model"] and WRFRUNConfig["model"][_model]["use"]:
+            func_map[_model]()
 
 
 __all__ = ["clear_model_logs"]

wrfrun/model/wrf/__init__.py

@@ -8,34 +8,29 @@ Submodules
 **********
 
 ============================================ ==================================================================================
-:doc:`_metgrid </api/model.wrf._metgrid>`    Utility functions used by :class:`MetGrid <core.MetGrid>`.
-:doc:`_ndown </api/model.wrf._ndown>`        Utility functions used by :class:`NDown <core.NDown>`.
 :doc:`core </api/model.wrf.core>`            Core implementation of WRF model.
 :doc:`exec_wrap </api/model.wrf.exec_wrap>`  Function wrappers for ``Executable`` defined in :doc:`core </api/model.wrf.core>`.
 :doc:`geodata </api/model.wrf.geodata>`      Utility functions to read / write geographical static datas.
+:doc:`log </api/model.wrf.log>`              Functions to parse and clear WPS/WRF model logs.
 :doc:`namelist </api/model.wrf.namelist>`    Functions to process WPS / WRF namelist files.
 :doc:`plot </api/model.wrf.plot>`            Functions to create projection from namelist settings to plot simulation domain.
 :doc:`scheme </api/model.wrf.scheme>`        Scheme ``dataclass``.
+:doc:`utils </api/model.wrf.utils>`          Utility functions used by wrf model part.
 :doc:`vtable </api/model.wrf.vtable>`        Vtable files ``dataclass``.
 ============================================ ==================================================================================
 
-.. autosummary::
-    :toctree: generated/
-
-    prepare_namelist
-
 .. toctree::
     :maxdepth: 1
     :hidden:
 
-    _metgrid <model.wrf._metgrid>
-    _ndown <model.wrf._ndown>
     core <model.wrf.core>
     exec_wrap <model.wrf.exec_wrap>
     geodata <model.wrf.geodata>
+    log <model.wrf.log>
     namelist <model.wrf.namelist>
     plot <model.wrf.plot>
     scheme <model.wrf.scheme>
+    utils <model.wrf.utils>
     vtable <model.wrf.vtable>
 """