diff --git a/README.md b/README.md index e55b012e..43dfd280 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Historically, NDSL was developed to port the FV3 dynamical core on the cubed-sph ## Quickstart -Currently, NDSL requires Python version `3.11.x`. All other dependencies installed during package installation. We recommend using virtual (or conda) environment. +Currently, NDSL requires Python version `3.11.x`, a GNU compiler and MPI installed. All other dependencies installed during package installation. We recommend using virtual (or conda) environment. ```shell # We have submodules for GT4Py and DaCe. Don't forget to pull them @@ -50,6 +50,19 @@ To run the GPU backends, you'll need: - Python package: - `cupy` (latest with proper driver support [see install notes](https://docs.cupy.dev/en/stable/install.html)) +A simple way to install MPI is using pre-built wheels, e.g. + +```shell +# See "quickstart" above how to setup a virtual environment +cd NDSL/ +source ./venv/bin/activate + +# Install MPI into your virtual environment +pip install openmpi +``` + +A note on the compiler: NDSL currently only works with the GNU compiler. Using `clang` will result in errors related to undefined OpenMP flags. For MacOS users, we know that `gcc` version 14 from homebrew works. + ### Installation options See [quickstart](#quickstart) above on how to pull and setup a virtual environment. The packages has a few options: