WRF-CMake adds CMake support to the latest version of the Advanced Research Weather Research and Forecasting model (here WRF, for short) with the intention of streamlining and simplifying its configuration and build process. In our view, the use of CMake provides model developers, code maintainers, and end-users with several advantages such as robust incremental rebuilds, flexible library dependency discovery, native tool-chains for Windows, macOS, and Linux with minimal external dependencies, thus increasing portability, and automatic generation of project files for different platforms.
WRF-CMake is designed to work alongside the current releases of WRF, therefore you can still compile your code using the legacy Makefiles included in WRF and WPS for any of the currently unsupported features.
- Configurations for special environments like supercomputers
- Linux with gcc/gfortran, Intel, and Cray compilers
- macOS with gcc/gfortran and Intel compilers
- Windows with MinGW-w64 and gcc/gfortran
- WRF-DA
- WRFPLUS
- WRF-Chem
- WRF-Hydro
- Promotion of Fortran's REAL to DOUBLE
- File and line number in wrf_error_fatal() messages
- WRF-NMM (discontinued -- see https://dtcenter.org/wrf-nmm/users/)
- Automatic moving nests (via
TERRAIN_AND_LANDUSE
environment variable)
The installation of WRF-CMake is straightforward thanks to the downloadable pre-built binaries for most Linux distributions (specifically RPM-based and Debian-based distribution-compatible), macOS, and Windows (see binary distribution below) -- most users wishing to run WRF on their system can simply download the pre-compiled binaries without the need of building from source. Alternately, to build WRF from source, please refer to the source distribution section below. HPC users, or users seeking to run WRF in the 'most optimal' configuration for their system, are advised to build WRF-CMake from source.
To download the latest pre-compiled binary releases, see below -- please note that these distributions are currently experimental, therefore please report any issues here.
- WRF-CMake (
serial
anddmpar
): https://github.com/WRF-CMake/wrf/releases. - WPS-CMake (
serial
anddmpar
): https://github.com/WRF-CMake/wps/releases.
If you want to launch WRF-CMake and WPS-CMake binary distributions built in dmpar
to run on multiple processes, you need to have MPI installed on your system.
- On Windows, download and install Microsoft MPI (
msmpisetup.exe
) from https://www.microsoft.com/en-us/download/details.aspx?id=56727. - On macOS you can get it through Homebrew using
brew install open-mpi
. Note: Binary distributions < 4.1 usempich
, in which case you need tobrew install mpich
and possibly uninstallopen-mpi
first. - On Linux, use your package manager to download mpich (version ≥ 3.0.4). E.g.
sudo apt install mpich
on Debian-based systems orsudo yum install mpich
on RPM-based system like CentOS.
To build WRF-CMake from source, see this page.
In our current GitHub set-up, we perform a series of compilation and regression tests at each commit using the WRF-CMake Automated Testing Suite on Windows, macOS, and Linux.
When you build WRF or WRF-CMake yourself then you have already done a compilation test. If you like to replicate the regression tests, then follow the steps on the "Running regression tests locally" page.
The following is a list of changes to be upsteamed:
dyn_em/module_big_step_utilities_em.F
: Fix non-standard line continuation character (\
instead of&
) leading to compile errors on Cray compilersexternal/io_grib1/MEL_grib1/{grib_enc.c,gribputgds.c,pack_spatial.c}
: Remove redundant header includes causing symbol conflicts in Windowsexternal/io_grib2/g2lib/{dec,enc}_png.c
: Changed type 'voidp' to 'png_voidp' to make it compatible with newer libpng versions. See: https://trac.macports.org/ticket/36470external/io_grib2/g2lib/enc_jpeg2000.c
: Removed redundantimage.inmem_=1;
to make it compatible with newer libjasper versions >= 1.900.25external/io_grib_share/open_file.c
,external/io_grib2/bacio-1.3/bacio.v1.3.c
,external/io_int/io_int_idx.c
,external/RSL_LITE/c_code.c
: Fixed file opening on Windows which is text-mode by default and has been changed to binary modeexternal/io_netcdf/wrf_io.F90
: Added alternativeXDEX(A,B,C)
macro for systems without M4external/RSL_LITE/c_code.c
: Fixed condition of preprocessing definition forminf
to be Windows compatiblephys/module_sf_clm.F
: Fixed missingIFPORT
module import needed for non-standard subroutineabort
when using Intel Fortranshare/landread.c
: Fixed header includes for Windows (io.h
instead ofunistd.h
)tools/gen_{interp,irr_diag}.c
: Fixed missing function aliasing for Windows forstrcasecmp
,rindex
,index
tools/gen_irr_diag.c
: Remove redundantsys/resource.h
header include which would be unavailable on Windowstools/registry.c
: Fixed incorrect Windows-conditional header include forstring.h
(needed in all cases, not just non-Windows)var/run/crtm_coeffs
: Removed broken absolute UNIX symlink as this causes trouble with git operations in Windows
General WRF copyright and license applies for any files part of the original WRF distribution -- see the README file for more details.
Additional files provided by WRF-CMake are licensed according to LICENSE_CMAKE.txt if the relevant file contains the following header at the beginning of the file, otherwise the general WRF copyright and license applies.
WRF-CMake (https://github.com/WRF-CMake/wrf).
Copyright <year> M. Riechert and D. Meyer. Licensed under the MIT License.