Skip to content

Update readme with MPI / compiler recommendataions #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
romanc merged 3 commits into from
Aug 7, 2025
Merged

Update readme with MPI / compiler recommendataions #191

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69190e5
Update readme with MPI / compiler recommendataions
romanc Aug 5, 2025
c6e1806
specify compiler version for macos users
romanc Aug 7, 2025
ba6a2e7
Update README.md
romanc Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down