Initial implementation for Linux/macOS/Windows

Author: dalcinl

.github/workflows/ci.yml

@@ -0,0 +1,86 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        mpi:
+          - mpich
+          - openmpi
+          - msmpi
+        os:
+          - ubuntu-20.04
+          - ubuntu-18.04
+          - macos-10.15
+          - windows-2019
+        exclude:
+          - os: ubuntu-20.04
+            mpi: msmpi
+          - os: ubuntu-18.04
+            mpi: msmpi
+          - os: macos-10.15
+            mpi: msmpi
+          - os: windows-2019
+            mpi: mpich
+          - os: windows-2019
+            mpi: openmpi
+
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup MPI
+      uses: ./
+      with:
+        mpi: ${{ matrix.mpi }}
+
+    - name: Show MPI info
+      run:  mpichversion
+      if:   ${{ matrix.mpi == 'mpich' }}
+
+    - name: Show MPI info
+      run:  ompi_info
+      if:   ${{ matrix.mpi == 'openmpi' }}
+
+    - name: Show MPI info
+      run: |
+        Write-Host MSMPI_BIN=$Env:MSMPI_BIN
+        Write-Host MSMPI_INC=$Env:MSMPI_INC
+        Write-Host MSMPI_LIB32=$Env:MSMPI_LIB32
+        Write-Host MSMPI_LIB64=$Env:MSMPI_LIB64
+      if:   ${{ matrix.mpi == 'msmpi' }}
+
+    - name: Show MPI compilers
+      run: |
+        command -v mpicc
+        mpicc -show
+        command -v mpicxx
+        mpicxx -show
+        command -v mpifort
+        mpifort -show
+      if: ${{ runner.os != 'Windows' }}
+
+    - name: Help MPI executor
+      run: |
+        command -v mpiexec
+        mpiexec --help
+      if: ${{ runner.os != 'Windows' }}
+
+    - name: Help MPI executor
+      run: |
+        mpiexec /help2
+        mpiexec /help3
+      if: ${{ runner.os == 'Windows' }}

README.md

@@ -1,2 +1,44 @@
 # setup-mpi
-Set up your GitHub Actions workflow to use 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@v2
+  - 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' ]
+    name: ${{ matrix.mpi }} example
+    steps:
+      - name: Checkout
+      - uses: actions/checkout@v2
+      - 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/) and [Open MPI](https://www.open-mpi.org/) (`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).

action.yml

@@ -0,0 +1,19 @@
+---
+name: 'Setup MPI'
+description: 'Set up a specific MPI implementation.'
+author: 'Lisandro Dalcin'
+inputs:
+  mpi:
+    description: "MPI implementation name."
+    required: false
+    default: '' # Linux/macOS: 'mpich', Windows: 'msmpi'
+outputs:
+  mpi:
+    description: "The installed MPI implementation name."
+    value: ${{ steps.setup-mpi.outputs.mpi }}
+runs:
+  using: 'composite'
+  steps:
+    - id: setup-mpi
+      run: ${GITHUB_ACTION_PATH}/setup-mpi.sh ${{ inputs.mpi }}
+      shell: bash

setup-mpi.sh

@@ -0,0 +1,63 @@
+#!/bin/bash
+set -eu
+
+MPI=$(echo "${1:-}" | tr '[:upper:]' '[:lower:]')
+
+case $(uname) in
+
+    Linux)
+        MPI="${MPI:-mpich}"
+        echo "Installing $MPI with apt"
+        case $MPI in
+            mpich)
+                sudo apt install -y -q mpich libmpich-dev
+                ;;
+            openmpi)
+                sudo apt install -y -q openmpi-bin libopenmpi-dev
+                ;;
+            *)
+                echo "Unknown MPI implementation:" $MPI
+                exit 1
+                ;;
+        esac
+        ;;
+
+    Darwin)
+        MPI="${MPI:-mpich}"
+        echo "Installing $MPI with brew"
+        case $MPI in
+            mpich)
+                brew install mpich
+                ;;
+            openmpi)
+                brew install openmpi
+                ;;
+            *)
+                echo "Unknown MPI implementation:" $MPI
+                exit 1
+                ;;
+        esac
+        ;;
+
+    Windows* | MINGW* | MSYS*)
+        MPI="${MPI:-msmpi}"
+        echo "Installing $MPI"
+        case $MPI in
+            msmpi)
+                sdir=$(dirname "${BASH_SOURCE[0]}")
+                pwsh "${sdir}\\setup-${MPI}.ps1"
+                ;;
+            *)
+                echo "Unknown MPI implementation:" $MPI
+                exit 1
+                ;;
+        esac
+        ;;
+
+    *)
+        echo "Unknown OS kernel:" $(uname)
+        exit 1
+        ;;
+esac
+
+echo "::set-output name=mpi::${MPI}"

setup-msmpi.ps1

@@ -0,0 +1,33 @@
+$ErrorActionPreference = "Stop"
+
+$rooturl = "https://github.com/microsoft/Microsoft-MPI/releases/download"
+$version = "10.1.1"
+$baseurl = "$rooturl/v$version"
+
+$tempdir    = $Env:RUNNER_TEMP
+$msmpisdk   = Join-Path $tempdir msmpisdk.msi
+$msmpisetup = Join-Path $tempdir msmpisetup.exe
+
+Write-Host "Downloading Microsoft MPI $version"
+Invoke-WebRequest "$baseurl/msmpisdk.msi"   -OutFile $msmpisdk
+Invoke-WebRequest "$baseurl/msmpisetup.exe" -OutFile $msmpisetup
+
+Write-Host "Installing Microsoft MPI $version"
+Start-Process msiexec.exe -ArgumentList "/quiet /passive /qn /i $msmpisdk" -Wait
+Start-Process $msmpisetup -ArgumentList "-unattend" -Wait
+
+if ($Env:GITHUB_ENV) {
+  Write-Host 'Adding environment variables to $GITHUB_ENV'
+  $envlist = @("MSMPI_BIN", "MSMPI_INC", "MSMPI_LIB32", "MSMPI_LIB64")
+  foreach ($name in $envlist) {
+    $value = [Environment]::GetEnvironmentVariable($name, "Machine")
+    Write-Host "$name=$value"
+    Add-Content $Env:GITHUB_ENV "$name=$value"
+  }
+}
+
+if ($Env:GITHUB_PATH) {
+  Write-Host 'Adding $MSMPI_BIN to $GITHUB_PATH'
+  $MSMPI_BIN = [Environment]::GetEnvironmentVariable("MSMPI_BIN", "Machine")
+  Add-Content $Env:GITHUB_PATH $MSMPI_BIN
+}