wrfrun 0.1.7__py3-none-any.whl

wrfrun/res/namelist/namelist.input.wrf.template

@@ -0,0 +1,256 @@
+&time_control
+    run_days = 0
+    run_hours = 72
+    run_minutes = 0
+    run_seconds = 0
+    start_year = 2022, 2022, 2022
+    start_month = 5, 5, 5
+    start_day = 19, 19, 19
+    start_hour = 18, 18, 18
+    start_minute = 0, 0, 0
+    start_second = 0, 0, 0
+    end_year = 2022, 2022, 2022
+    end_month = 5, 5, 5
+    end_day = 22, 22, 22
+    end_hour = 18, 18, 18
+    end_minute = 0, 0, 0
+    end_second = 0, 0, 0
+    interval_seconds = 10800
+    input_from_file = .true., .true., .true.
+    fine_input_stream = 0, 0, 2
+    history_interval = 180, 180, 60
+    frames_per_outfile = 1000, 1000, 1000
+    history_outname = 'wrfout_d<domain>_<date>'
+    restart = .false.
+    restart_interval = 5000
+    override_restart_timers = .false.
+    io_form_history = 2
+    io_form_restart = 2
+    io_form_input = 2
+    io_form_boundary = 2
+    io_form_auxinput4 = 2
+    io_form_auxinput2 = 2
+    debug_level = 0
+    auxinput1_inname = './met_em.d<domain>.<date>'
+    auxinput4_inname = 'wrflowinp_d<domain>'
+    auxinput4_interval = 180, 180, 180
+    inputout_interval = 180
+    input_outname = 'wrfvar_d<domain>_<date>'
+    adjust_output_times = .true.
+/
+
+&domains
+    time_step = 120
+    time_step_fract_num = 0
+    time_step_fract_den = 1
+    max_dom = 2
+    time_step_dfi = 0
+    s_we = 1, 1, 1
+    e_we = 110, 151, 133
+    s_sn = 1, 1, 1
+    e_sn = 120, 181, 133
+    s_vert = 1, 1, 1
+    e_vert = 44, 44, 57
+    num_metgrid_levels = 38
+    num_metgrid_soil_levels = 3
+    p_top_requested = 5000
+    vert_refine_fact = 1
+    interp_theta = .false.
+    hypsometric_opt = 2
+    interp_type = 2
+    extrap_type = 2
+    t_extrap_type = 2
+    lowest_lev_from_sfc = .false.
+    force_sfc_in_vinterp = 1
+    use_surface = .true.
+    dx = 30000, 10000, 3333.333
+    dy = 30000, 10000, 3333.333
+    grid_id = 1, 2, 3
+    parent_id = 1, 1, 2
+    i_parent_start = 1, 35, 40
+    j_parent_start = 1, 34, 40
+    parent_grid_ratio = 1, 3, 3
+    parent_time_step_ratio = 1, 3, 4
+    feedback = 1
+    smooth_option = 2
+    nproc_x = -1
+    nproc_y = -1
+    numtiles = 6
+    use_adaptive_time_step = .false.
+    step_to_output_time = .true.
+    target_cfl = 1.1, 1.1, 1.1
+    max_step_increase_pct = 5, 51, 51
+    starting_time_step = 120, 40, 10
+    max_time_step = 240, 80, 20
+    min_time_step = 60, 20, 10
+    adaptation_domain = 1
+/
+
+&dfi_control
+    dfi_opt = 0
+    dfi_nfilter = 7
+    dfi_write_filtered_input = .true.
+    dfi_write_dfi_history = .false.
+    dfi_cutoff_seconds = 3600
+    dfi_time_dim = 9000
+    dfi_bckstop_year = 9991
+    dfi_bckstop_month = 9992
+    dfi_bckstop_day = 9993
+    dfi_bckstop_hour = 9994
+    dfi_bckstop_minute = 0
+    dfi_bckstop_second = 0
+    dfi_fwdstop_year = 8881
+    dfi_fwdstop_month = 8882
+    dfi_fwdstop_day = 8883
+    dfi_fwdstop_hour = 8884
+    dfi_fwdstop_minute = 30
+    dfi_fwdstop_second = 0
+/
+
+&physics
+    chem_opt = 0
+    mp_physics = 2, 2, 2
+    progn = 0, 0, 0
+    mp_zero_out = 2
+    mp_zero_out_thresh = 1e-08
+    do_radar_ref = 1
+    gsfcgce_hail = 0
+    gsfcgce_2ice = 0
+    no_mp_heating = 0
+    ra_lw_physics = 4, 4, 4
+    ra_sw_physics = 4, 4, 4
+    radt = 15, 15, 10
+    sf_sfclay_physics = 1, 1, 1
+    iz0tlnd = 1
+    sf_surface_physics = 2, 2, 2
+    sf_urban_physics = 1, 1, 1
+    bl_pbl_physics = 1, 1, 1
+    bl_mynn_tkeadvect = .true., .true., .true.
+    ysu_topdown_pblmix = 1
+    topo_wind = 1
+    bldt = 0, 0, 0
+    opt_thcnd = 2
+    grav_settling = 2, 2, 2
+    cu_physics = 1, 1, 0
+    ishallow = 0
+    cudt = 0, 0, 0
+    kfeta_trigger = 1
+    cu_rad_feedback = .true., .true., .true.
+    cugd_avedx = 1
+    isfflx = 1
+    ifsnow = 0
+    icloud = 3
+    surface_input_source = 1
+    num_land_cat = 21
+    num_soil_cat = 16
+    usemonalb = .true.
+    rdlai2d = .true.
+    sst_update = 1
+    num_soil_layers = 4
+    maxiens = 1
+    maxens = 3
+    maxens2 = 3
+    maxens3 = 16
+    ensdim = 144
+    slope_rad = 1
+    topo_shading = 1
+    shadlen = 25000.0
+    sf_ocean_physics = 0
+    oml_hml0 = 50
+    oml_gamma = 0.14
+    isftcflx = 0
+    fractional_seaice = 0
+/
+
+&fdda
+    obs_nudge_opt = 0, 0, 0
+    max_obs = 36000
+    fdda_start = 360.0, 360.0, 360.0
+    fdda_end = 99999.0, 99999.0, 99999.0
+    obs_nudge_wind = 1, 1, 1
+    obs_coef_wind = 0.0004, 0.0004, 0.0004
+    obs_nudge_temp = 1, 1, 1
+    obs_coef_temp = 0.0004, 0.0004, 0.0004
+    obs_nudge_mois = 1, 1, 1
+    obs_coef_mois = 2e-05, 2e-05, 2e-05
+    obs_rinxy = 240.0, 60.0, 180.0
+    obs_rinsig = 0.1
+    obs_twindo = 0.666667
+    obs_npfi = 10
+    obs_ionf = 2
+    obs_idynin = 0
+    obs_dtramp = 40.0
+    obs_ipf_errob = .true.
+    obs_ipf_nudob = .true.
+    obs_ipf_in4dob = .true.
+    grid_fdda = 0, 0
+    gfdda_inname = 'wrffdda_d<domain>'
+    gfdda_end_h = 72, 72
+    io_form_gfdda = 2
+    fgdt = 0, 0
+    if_no_pbl_nudging_uv = 0, 0
+    if_no_pbl_nudging_t = 1, 1
+    if_no_pbl_nudging_q = 1, 1
+    guv = 0.0004, 0.0004
+    gt = 0.0004, 0.0004
+    gq = 0.0004, 0.0004
+    if_ramping = 0
+    dtramp_min = 60
+/
+
+&dynamics
+    rk_ord = 3
+    w_damping = 1
+    diff_opt = 2
+    km_opt = 4
+    diff_6th_opt = 2, 2, 2
+    diff_6th_factor = 0.12, 0.12, 0.12
+    use_theta_m = 1
+    use_q_diabatic = 1
+    base_temp = 290.0
+    use_baseparam_fr_nml = .true.
+    damp_opt = 3
+    zdamp = 5000.0, 5000.0, 5000.0
+    dampcoef = 0.2, 0.2, 0.2
+    khdif = 0, 0, 0
+    kvdif = 0, 0, 0
+    non_hydrostatic = .true., .true., .true.
+    use_input_w = .true.
+    moist_adv_opt = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+    moist_adv_dfi_opt = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+    scalar_adv_opt = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+    chem_adv_opt = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+    tracer_adv_opt = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+    tke_adv_opt = 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+    gwd_opt = 0
+/
+
+&bdy_control
+    spec_bdy_width = 5
+    spec_zone = 1
+    relax_zone = 4
+    specified = .true., .false., .false.
+    nested = .false., .true., .true.
+    constant_bc = .false.
+    have_bcs_moist = .false.
+    have_bcs_scalar = .false.
+/
+
+&tc
+    insert_bogus_storm = .false.
+    remove_storm = .false.
+    num_storm = 1
+    latc_loc = 25.0
+    lonc_loc = 127.0
+    vmax_meters_per_second = 60.0
+    rmax = 60000.0
+    vmax_ratio = 0.85
+/
+
+&grib2
+/
+
+&namelist_quilt
+    nio_tasks_per_group = 0
+    nio_groups = 1
+/

wrfrun/res/namelist/namelist.wps.template

@@ -0,0 +1,44 @@
+&share
+    wrf_core = 'ARW'
+    max_dom = 2
+    start_date = '2022-05-19_15:00:00', '2022-05-19_15:00:00', '2022-05-19_15:00:00'
+    end_date = '2022-05-22_18:00:00', '2022-05-22_18:00:00', '2022-05-22_18:00:00'
+    interval_seconds = 10800
+    io_form_geogrid = 2
+/
+
+&geogrid
+    parent_id = 1, 1, 2
+    parent_grid_ratio = 1, 3, 3
+    i_parent_start = 1, 35, 40
+    j_parent_start = 1, 34, 40
+    e_we = 110, 151, 133
+    e_sn = 120, 181, 133
+    geog_data_res = '10m', '2m', '30s'
+    dx = 30000
+    dy = 30000
+    map_proj = 'lambert'
+    ref_lat = 36.0
+    ref_lon = 123.0
+    truelat1 = 20.0
+    truelat2 = 50.0
+    stand_lon = 123.0
+    geog_data_path = ''
+/
+
+&ungrib
+    out_format = 'WPS'
+    prefix = './outputs/FILE'
+/
+
+&metgrid
+    fg_name = './outputs/FILE'
+    process_only_bdy = 0
+    io_form_metgrid = 2
+    opt_output_from_metgrid_path = './'
+/
+
+&mod_levs
+    press_pa = 201300, 200100, 100000, 92500, 85000, 70000, 60000, 50000,
+               40000, 30000, 25000, 20000, 15000, 10000, 7000, 5000
+/

wrfrun/res/namelist/parame.in.template

@@ -0,0 +1,11 @@
+&control_param
+    da_file = './wrfvar_output'
+    wrf_bdy_file = './wrfbdy_d01'
+    wrf_input = './wrfinput_d01_bc'
+    domain_id = 1
+    debug = .true.
+    update_lateral_bdy = .true.
+    update_low_bdy = .false.
+    update_lsm = .false.
+    iswater = 16
+/

wrfrun/res/run.sh.template

@@ -0,0 +1,16 @@
+#!/bin/bash
+#PBS -q batch
+##PBS -q odasc
+#PBS -N py-wrfrun
+#PBS -o {STDOUT_LOG_PATH}
+#PBS -e {STDERR_LOG_PATH}
+#PBS -l nodes={NODE_NUM}:ppn={CORE_NUM}
+#PBS -l walltime=9999:00:00
+
+ulimit -s unlimited
+
+{ENV_SETTINGS}
+
+cd {WORK_PATH}
+
+{WORK_COMMAND}

wrfrun/run.py

@@ -0,0 +1,264 @@
+"""
+``wrfrun.run`` module.
+"""
+
+import sys
+import threading
+from os.path import abspath, dirname, exists
+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 .utils import call_subprocess, logger, logger_add_file_handler
+from .workspace import prepare_workspace
+
+
+def confirm_model_area():
+    """
+    Ask user to check domain area.
+
+    """
+    plot_domain_area()
+
+    if not in_pbs():
+        # ask user
+        logger.warning(f"Check the domain image, is it right?")
+        answer = input("Is it right? [y/N]: ")
+
+        answer = answer.lower()
+
+        if answer not in ["y", "yes"]:
+            logger.error(f"Change your domain setting and run again")
+            exit(1)
+
+
+class WRFRun:
+    """
+    ``WRFRun`` is a context class to use all functions in ``wrfrun`` package.
+    """
+    _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):
+        """
+        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 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:
+        """
+        if self._initialized:
+            return
+
+        # variables for running WRFRunServer
+        self._start_server = start_server
+        self._wrfrun_server: Union[WRFRunServer, None] = None
+        self._wrfrun_server_thread: Union[threading.Thread, None] = None
+        self._ip = ""
+        self._port = -1
+
+        self._pbs_mode = pbs_mode
+        self._init_workspace = init_workspace
+        self._prepare_wps_data = prepare_wps_data
+        self._wps_data_area = wps_data_area
+        self._entry_file_path = abspath(sys.argv[0])
+        self._entry_file_dir_path = dirname(self._entry_file_path)
+        self._replay_configs = None
+
+        # make sure we can read the config file, because sometimes the user may run the Python script in a different path.
+        abs_config_path = f"{self._entry_file_dir_path}/{config_file}"
+        WRFRUNConfig.load_wrfrun_config(abs_config_path)
+
+        self._record_output_path = None
+        self._record_include_data = False
+        self._WRFRUNReplay = ExecConfigRecorder
+
+        self._initialized = True
+
+    def __new__(cls, *args, **kwargs):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+
+        return cls._instance
+
+    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
+
+        # 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():
+            if self._init_workspace:
+                prepare_workspace()
+
+            # ask user before commit the task
+            confirm_model_area()
+
+            prepare_pbs_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:
+            if self._init_workspace:
+                prepare_workspace()
+
+            confirm_model_area()
+
+        # save a copy of config to the output path
+        WRFRUNConfig.save_wrfrun_config(f"{WRFRUNConfig.WRFRUN_OUTPUT_PATH}/config.toml")
+
+        # check if we need to start a server
+        if self._start_server:
+            # start server
+            self._start_wrfrun_server()
+
+        # change status
+        WRFRUNConfig.set_wrfrun_context(True)
+
+        logger_add_file_handler(WRFRUNConfig.get_log_path())
+
+        if self._prepare_wps_data:
+            if self._wps_data_area is None:
+                logger.error(f"If you want wrfrun preparing data, you need to give `wps_data_area`")
+                raise ValueError(f"If you want wrfrun preparing data, you need to give `wps_data_area`")
+            else:
+                prepare_wps_input_data(self._wps_data_area)
+
+        logger.info(r"Enter wrfrun context")
+
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        # stop thread if needed
+        if self._start_server:
+            stop_server(self._ip, self._port)     # type: ignore
+
+        if exc_type is None and WRFRUNConfig.IS_RECORDING:
+            self._WRFRUNReplay.export_replay_file()
+            self._WRFRUNReplay.clear_records()
+
+        # change status
+        WRFRUNConfig.set_wrfrun_context(False)
+
+        clear_model_logs()
+
+        logger.info(r"Exit wrfrun context")
+
+    def _start_wrfrun_server(self):
+        """
+        Start a WRFRunServer.
+        """
+        # read ip and port settings from config
+        socket_ip, socket_port = WRFRUNConfig.get_socket_server_config()
+
+        # get simulate settings
+        start_date = WRFRUNConfig.get_model_config("wrf")["time"]["start_date"]
+        end_date = WRFRUNConfig.get_model_config("wrf")["time"]["end_date"]
+
+        start_date = start_date[0] if isinstance(start_date, list) else start_date
+        end_date = end_date[0] if isinstance(end_date, list) else end_date
+
+        # calculate simulate seconds
+        time_delta = end_date - start_date
+        simulate_seconds = time_delta.days * 24 * 60 * 60 + time_delta.seconds
+
+        # init server
+        self._wrfrun_server = WRFRunServer(
+            start_date, simulate_seconds, (socket_ip, socket_port),
+            WRFRunServerHandler
+        )
+
+        # get ip and port from instance, because the port may change
+        self._ip, self._port = self._wrfrun_server.server_address
+
+        logger.info(f"Start socket server on {self._ip}:{self._port}")
+
+        # start server thread
+        self._wrfrun_server_thread = threading.Thread(
+            target=self._wrfrun_server.serve_forever
+        )
+        self._wrfrun_server_thread.daemon = True
+        self._wrfrun_server_thread.start()
+
+    def record_simulation(self, output_path: str, include_data=False):
+        """
+        Change settings, so wrfrun can record simulation and generate a replay file.
+
+        :param output_path: Output file path.
+        :type output_path: str
+        :param include_data: If includes data.
+        :type include_data: bool
+        :return:
+        :rtype:
+        """
+        self._record_output_path = output_path
+        self._record_include_data = include_data
+        self._WRFRUNReplay = self._WRFRUNReplay.reinit(save_path=output_path, include_data=include_data)
+
+    def replay_simulation(self, replay_file: str):
+        """
+        Replay the simulation without any changes.
+
+        :param replay_file:
+        :type replay_file:
+        :return:
+        :rtype:
+        """
+        WRFRUNConfig.check_wrfrun_context(True)
+
+        if self._replay_configs is not None:
+            del self._replay_configs
+
+        self._replay_configs = replay_config_generator(replay_file)
+
+        WRFRUNConfig.IS_IN_REPLAY = True
+
+        try:
+            for _, executable in self._replay_configs:
+                executable.replay()
+
+        except WRFRunBasicError:
+            logger.error("Failed to replay the simulation")
+
+        WRFRUNConfig.IS_IN_REPLAY = False
+
+    def replay_executables(self, replay_file: str):
+        """
+        Replay the simulation without any changes.
+
+        :param replay_file:
+        :type replay_file:
+        :return:
+        :rtype:
+        """
+        WRFRUNConfig.check_wrfrun_context(True)
+
+        if self._replay_configs is not None:
+            del self._replay_configs
+
+        self._replay_configs = replay_config_generator(replay_file)
+
+        WRFRUNConfig.IS_IN_REPLAY = True
+
+        for name, executable in self._replay_configs:
+            yield name, executable
+
+        WRFRUNConfig.IS_IN_REPLAY = False
+
+
+__all__ = ["WRFRun"]