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

wrfrun/plot/wps.py

@@ -1,3 +1,16 @@
+"""
+wrfrun.plot.wps
+###############
+
+Functions to plot outputs of ``geogrid.exe``.
+
+.. autosummary::
+    :toctree: generated/
+
+    get_cmap_ticks
+    draw_geogrid
+"""
+
 from typing import Tuple
 
 from cartopy import crs
@@ -6,80 +19,83 @@ from matplotlib.collections import QuadMesh
 from matplotlib.colors import ListedColormap
 from matplotlib.figure import Figure
 from netCDF4 import Dataset  # type: ignore
-from wrf import getvar, latlon_coords, get_cartopy, to_np
 from xarray import DataArray
 
-from wrfrun.utils import logger
+from wrfrun.log 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: 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_CMAP = ListedColormap(
+    (
+        [0, 0.4, 0],  # 1: Evergreen Needleleaf Forest
+        [0, 0.4, 0.2],  # 2: Evergreen Broadleaf Forest
+        [0.2, 0.8, 0.2],  # 3: Deciduous Needleleaf Forest
+        [0.2, 0.8, 0.4],  # 4: Deciduous Broadleaf Forest
+        [0.2, 0.6, 0.2],  # 5: Mixed Forests
+        [0.3, 0.7, 0],  # 6: Closed Shrublands
+        [0.82, 0.41, 0.12],  # 7: Open Shurblands
+        [0.74, 0.71, 0.41],  # 8: Woody Savannas
+        [1, 0.84, 0.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
+        [0.7, 0.9, 0.3],  # 14: Cropland/Natual Vegation Mosaic
+        [1, 1, 1],  # 15: Snow and Ice
+        [0.914, 0.914, 0.7],  # 16: Barren or Sparsely Vegetated
+        [0.5, 0.7, 1],  # 17: Water (like oceans)
+        [0.86, 0.08, 0.23],  # 18: Wooded Tundra
+        [0.97, 0.5, 0.31],  # 19: Mixed Tundra
+        [0.91, 0.59, 0.48],  # 20: Barren Tundra
+        [0, 0, 0.88],  # 21: Lake
+    )
+)
 
 LANDUSE_LABELS = [
-    'Evergreen Needleleaf Forest',
-    'Evergreen Broadleaf Forest',
-    'Deciduous Needleleaf Forest',
-    'Deciduous Broadleaf Forest',
-    'Mixed Forests',
-    'Closed Shrublands',
-    'Open Shrublands',
-    'Woody Savannas',
-    'Savannas',
-    'Grasslands',
-    'Permanent Wetlands',
-    'Croplands',
-    'Urban and Built-Up',
-    'Cropland/Natural Vegetation Mosaic',
-    'Snow and Ice',
-    'Barren or Sparsely Vegetated',
-    'Water',
-    'Wooded Tundra',
-    'Mixed Tundra',
-    'Barren Tundra',
-    'Lake',
+    "Evergreen Needleleaf Forest",
+    "Evergreen Broadleaf Forest",
+    "Deciduous Needleleaf Forest",
+    "Deciduous Broadleaf Forest",
+    "Mixed Forests",
+    "Closed Shrublands",
+    "Open Shrublands",
+    "Woody Savannas",
+    "Savannas",
+    "Grasslands",
+    "Permanent Wetlands",
+    "Croplands",
+    "Urban and Built-Up",
+    "Cropland/Natural Vegetation Mosaic",
+    "Snow and Ice",
+    "Barren or Sparsely Vegetated",
+    "Water",
+    "Wooded Tundra",
+    "Mixed Tundra",
+    "Barren Tundra",
+    "Lake",
 ]
 
 
 # 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_CMAP = ListedColormap(
+    (
+        [0, 0.4, 0],  # 1: Sand
+        [0, 0.4, 0.2],  # 2: Loamy Sand
+        [0.2, 0.8, 0.2],  # 3: Sandy Loam
+        [0.2, 0.8, 0.4],  # 4: Silt Loam
+        [0.2, 0.6, 0.2],  # 5: Silt
+        [0.3, 0.7, 0],  # 6: Loam
+        [0.82, 0.41, 0.12],  # 7: Sandy Clay Loam
+        [0.74, 0.71, 0.41],  # 8: Silty Clay Loam
+        [1, 0.84, 0.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
+        [0.7, 0.9, 0.3],  # 14: Water
+        [1, 1, 1],  # 15: Bedrock
+        [0.914, 0.914, 0.7],  # 16: Other
+    )
+)
 
 SOILTYPE_LABELS = [
     "Sand",
@@ -97,7 +113,7 @@ SOILTYPE_LABELS = [
     "Organic Material",
     "Water",
     "Bedrock",
-    "Other"
+    "Other",
 ]
 
 
@@ -159,15 +175,24 @@ def draw_geogrid(data_path: str, field: str, fig: Figure, nrow: int, ncol: int,
     :return: (GeoAxes, QuadMesh)
     :rtype: tuple
     """
+    # lazy import
+    try:
+        from wrf import get_cartopy, getvar, latlon_coords, to_np
+
+    except ImportError:
+        logger.error("Currently `wrf-python` isn't list as `wrfrun` dependency.")
+        logger.error("You need to install `wrf-python` package to use this feature.")
+        exit(1)
+
     # take out data
-    data: DataArray = getvar(Dataset(data_path), field)     # type: ignore
+    data: DataArray = getvar(Dataset(data_path), field)  # type: ignore
 
     # soiltype data is different from landuse data
     if field in ["SOILCTOP", "SOILCBOT"]:
-        data = data.argmax(dim="soil_cat", keep_attrs=True)     # type: ignore
+        data = data.argmax(dim="soil_cat", keep_attrs=True)  # type: ignore
         # get data attrs
         data_attrs = data.attrs
-        data = data + 1     # type: ignore
+        data = data + 1  # type: ignore
         data.attrs = data_attrs
 
     # get latitude and longitude
@@ -183,14 +208,12 @@ def draw_geogrid(data_path: str, field: str, fig: Figure, nrow: int, ncol: int,
     cmap, labels, ticks = get_cmap_ticks(field)
 
     # convert data to numpy
-    data, lats, lons = to_np(data), to_np(lats), to_np(lons)    # type: ignore
+    data, lats, lons = to_np(data), to_np(lats), to_np(lons)  # type: ignore
 
     # plot
-    im = ax.pcolormesh(
-        lons, lats, data, vmin=1, vmax=len(labels) + 1, cmap=cmap, transform=crs.PlateCarree()
-    )
+    im = ax.pcolormesh(lons, lats, data, vmin=1, vmax=len(labels) + 1, cmap=cmap, transform=crs.PlateCarree())
 
-    return ax, im   # type: ignore
+    return ax, im  # type: ignore
 
 
 __all__ = ["draw_geogrid", "get_cmap_ticks"]

wrfrun/res/__init__.py

@@ -1,7 +1,90 @@
-from os.path import abspath, dirname
+"""
+wrfrun.res
+##########
+
+This module contains resources used by other wrfrun modules.
+
+A ``__init__.py`` file will be generated by ``generate_init.py`` when building the package.
+
+The main resource directory and each subdirectory has a ``name_map.json`` file,
+which maps real name of files or directories to a simpler name.
+``generate_init.py`` reads these JSON and generates variable names based on the name inside it.
+
+For example, assume we have a directory which structure is like:
+
+.. code-block::
+
+    res
+     |
+     |---extension
+     |      |
+     |      |---plotgrids.ncl
+     |      ----name_map.json
+     |
+     |---job_scheduler
+     |      |
+     |      |---pbs.template
+     |      ----name_map.json
+     |
+     |---config.yaml.template
+     ----name_map.json
+
+And the content of each ``name_map.json`` is:
+
+.. code-block:: json
+    :caption: name_map.json
+
+    {
+        "extension": {
+            "name": "EXT",
+            "type": "dir",
+        },
+        "job_scheduler": {
+            "name": "JOBSYS",
+            "type": "dir",
+        },
+        "config.yaml.template": {
+            "name": "CONFIG_TEMPLATE",
+            "type": "file",
+        }
+    }
 
-from wrfrun.core import set_register_func, WRFRunConfig
+.. code-block:: json
+    :caption: name_map.json
+
+    {
+        "plotgrids.ncl": {
+            "name": "PLOT_DOMAIN_NCL",
+            "type": "file",
+        }
+    }
+
+.. code-block:: json
+    :caption: name_map.json
+
+    {
+        "pbs.template": {
+            "name": "PBS_TEMPLATE",
+            "type": "file",
+        }
+    }
+
+Then, the generated variable names in ``__init__.py`` are:
+
+.. code-block:: python
+    :caption: __init__.py
+
+    EXT_PLOT_DOMAIN_NCL = "..."
+    JOBSYS_PBS_TEMPLATE = "..."
+    CONFIG_TEMPLATE = "..."
+"""
+
+# This file is generated by scripts `wrfrun/res/generate_init.py`.
+# Don't change this file directly.
+
+from os.path import abspath, dirname
 
+from wrfrun.core import WRFRUN, WRFRunConfig
 
 RES_PATH = abspath(dirname(__file__))
 
@@ -10,7 +93,7 @@ def _register_res_uri(wrfrun_config: WRFRunConfig):
     wrfrun_config.register_resource_uri(wrfrun_config.WRFRUN_RESOURCE_PATH, RES_PATH)
 
 
-set_register_func(_register_res_uri)
+WRFRUN.set_config_register_func(_register_res_uri)
 
 
 RUN_SH_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/run.template.sh"
@@ -25,13 +108,28 @@ 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"
+CONFIG_PALM_TOML_TEMPLATE = ":WRFRUN_RESOURCE_PATH:/config/palm.template.toml"
 
 
 def _set_config_template_path(wrfrun_config: WRFRunConfig):
     wrfrun_config.set_config_template_path(CONFIG_MAIN_TOML_TEMPLATE)
 
 
-set_register_func(_set_config_template_path)
+WRFRUN.set_config_register_func(_set_config_template_path)
 
 
-__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"]
+__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",
+    "CONFIG_PALM_TOML_TEMPLATE",
+]

wrfrun/res/config/config.template.toml

@@ -55,3 +55,11 @@ use = false
 # You can give both absolute and relative path.
 # The relative path is resolved based on this configuration file.
 include = "./configs/wrf.toml"
+
+[model.palm]
+# If you want to use PALM 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/palm.toml"

wrfrun/res/config/palm.template.toml

@@ -0,0 +1,23 @@
+# Config for PALM model.
+# PALM model path.
+palm_path = "/path/to/your/PALM/folder"
+
+# Place data here.
+data_dir_path = "/path/to/your/data/folder"
+
+# Set PALM config identifier here.
+# If you want to use a config identifier you never used before,
+# make sure palm can build successfully.
+config_identifier = "wrfrun"
+
+# PALM config file.
+# If empty, use the default config from PALM.
+# You can get a file from PALM_INSTALL_DIR/.palm.config.default
+config_file_path = ""
+
+# You can provide topography file here.
+topography_file = '/path/to/your/topography/file'
+
+# You need to give your namelist file,
+# cause wrfrun hasn't supported more options in toml config file yet.
+user_namelist = '/path/to/your/namelist/file'