This runbook explains how to set up, run, and plot the Atlanta WRF example case using uv.
uv sync --group dev
uv run python setup_atlanta_sim.py
uv run python run_atlanta_sim.py --skip-wps --clean
uv run python plot_atlanta_results.pyGallery output:
C:\Users\<you>\Documents\gis4wrf\projects\atlanta_test\plots_all_fields\index.html
Case Summary
- Domain center: Atlanta, GA (
33.749,-84.388) - Horizontal resolution:
30 km - Grid size:
40 x 40 - Simulation period:
2024-01-15 00:00:00to2024-01-16 00:00:00(UTC) - Static data preset:
geog_data_res = 'lowres'
Prerequisites
- Windows with Python 3.9+ (this repo uses
uv) uvinstalled- Enough free disk space for WRF/WPS distributions, geog data, and outputs
- For multi-CPU runs: Microsoft MPI (
mpiexec)
1) Setup Files and Data
Create Atlanta case files:
uv run python setup_atlanta_sim.pyCreates/updates:
C:\Users\<you>\Documents\gis4wrf\dist\wrfC:\Users\<you>\Documents\gis4wrf\dist\wpsC:\Users\<you>\Documents\gis4wrf\datasets\geogC:\Users\<you>\Documents\gis4wrf\projects\atlanta_test\run_wps\namelist.wpsC:\Users\<you>\Documents\gis4wrf\projects\atlanta_test\run_wrf\namelist.input
Optional MPI-enabled binaries (dmpar):
uv run python setup_atlanta_sim.py --build dmpar --force-download2) Meteorological Inputs (GRIB / FILE_*)
If you run full WPS (geogrid/ungrib/metgrid), you need meteorological input files.
The runner accepts:
- GRIB links/files in
run_wpsasGRIBFILE.* - Ungrib output already in
run_wpsasFILE_*
If GRIB files are in a folder, pass it with --grib-dir; the script creates GRIBFILE.* links.
3) Run the Simulation
Serial run:
uv run python run_atlanta_sim.pyRe-run only WRF (skip WPS):
uv run python run_atlanta_sim.py --skip-wps --cleanMPI multi-CPU run (requires dmpar binaries):
uv run python run_atlanta_sim.py --nproc 8Notes:
--nproc > 1requires MPI anddmparWRF/WPS binaries.- If
serialbinaries are installed, use--nproc 1.
4) Plot All Fields
uv run python plot_atlanta_results.pyOutputs:
...\plots_all_fields\index.html...\plots_all_fields\maps\*.png...\plots_all_fields\series\*.png
By default, map plots include a basic Atlanta landmark background overlay. This includes metro city dots + labels and an approximate Metro Atlanta boundary outline. Disable it with:
uv run python plot_atlanta_results.py --no-landmarks5) Verify Success
WPS success markers:
run_wps\geogrid.logcontainsSuccessful completion of program geogrid.exerun_wps\ungrib.logcontainsSuccessful completion of program ungrib.exerun_wps\metgrid.logcontainsSuccessful completion of program metgrid.exe
WRF success markers:
run_wrf\real.stdout.logcontainsSUCCESS COMPLETE REAL_EM INITrun_wrf\wrf.stdout.logcontainsSUCCESS COMPLETE WRF
Expected outputs:
run_wrf\wrfout_d01_2024-01-15_00_00_00...run_wrf\wrfout_d01_2024-01-16_00_00_00
Command Reference
Setup options:
uv run python setup_atlanta_sim.py --helpRun options:
uv run python run_atlanta_sim.py --helpPlot options:
uv run python plot_atlanta_results.py --help