https://github.com/mpi4py/setup-mpi
Set up your GitHub Actions workflow to use MPI
https://github.com/mpi4py/setup-mpi
action actions github-actions mpi mpi-applications mpi-libraries
Last synced: 4 months ago
JSON representation
Set up your GitHub Actions workflow to use MPI
- Host: GitHub
- URL: https://github.com/mpi4py/setup-mpi
- Owner: mpi4py
- License: mit
- Created: 2021-04-08T17:38:16.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-11-14T18:10:15.000Z (7 months ago)
- Last Synced: 2025-11-22T08:24:25.338Z (7 months ago)
- Topics: action, actions, github-actions, mpi, mpi-applications, mpi-libraries
- Language: Shell
- Size: 44.9 KB
- Stars: 37
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-mpi
Set up your GitHub Actions workflow to use [MPI](https://www.mpi-forum.org/).
# Usage
See [action.yml](action.yml)
Basic:
```yaml
steps:
- uses: actions/checkout@v4
- uses: mpi4py/setup-mpi@v1
- run: mpicc helloworld.c -o helloworld
- run: mpiexec -n 2 ./helloworld
```
Matrix Testing:
```yaml
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
mpi: [ 'mpich', 'openmpi', 'intelmpi']
name: ${{ matrix.mpi }} example
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup MPI
uses: mpi4py/setup-mpi@v1
with:
mpi: ${{ matrix.mpi }}
- run: mpicc helloworld.c -o helloworld
- run: mpiexec -n 2 ./helloworld
```
# Available MPI implementations
* Linux:
[MPICH](https://www.mpich.org/),
[Open MPI](https://www.open-mpi.org/), and
[Intel MPI](https://software.intel.com/intel-mpi-library) (`apt` install).
* macOS:
[MPICH](https://www.mpich.org/) and
[Open MPI](https://www.open-mpi.org/) (`brew` install).
* Windows:
[Microsoft MPI](https://docs.microsoft.com/en-us/message-passing-interface/microsoft-mpi) and
[Intel MPI](https://software.intel.com/intel-mpi-library).