Microsoft-MPI/README.md

Microsoft MPI

Microsoft MPI (MS-MPI) is a Microsoft implementation of the Message Passing Interface standard for developing and running parallel applications on the Windows platform.

MS-MPI offers several benefits:

• Ease of porting existing code that uses MPICH.
• Security based on Active Directory Domain Services.
• High performance on the Windows operating system.
• Binary compatibility across different types of interconnectivity options.

Version of MPI standard

MS-MPI is MPI 2.2 compliant with the exception of Fortran bindings errata around attributes interop between C and Fortran. MS-MPI implements a subset of features from MPI 3.1 standard:

• Non-blocking collectives,
• RMA,
• MPI shared memory,
• New datatypes,
• Large counts,
• Matched probe.

For the full list of APIs please see Microsoft MPI Reference.

MS-MPI downloads

The following are current downloads for MS-MPI:

• MS-MPI v10.1.2 (new!) - see Release notes
• The MS-MPI SDK is also available on Nuget.

Earlier versions of MS-MPI are available from the Microsoft Download Center.

Community resources

• Windows HPC MPI Forum
• Contact the MS-MPI Team

Microsoft high performance computing resources

• Featured tutorial: How to compile and run a simple MS-MPI program
• Featured guide: Set up a Windows RDMA cluster with HPC Pack and A8 and A9 instances to run MPI applications
• Microsoft High Performance Computing for Developers
• Microsoft HPC Pack (Windows HPC Server) Technical Library
• Azure HPC Scenarios

Building

Prerequisites

• Visial Studio 2017

  Please make sure to select the following workloads during installation:

  • .NET desktop development (required for CBT/Nuget packages)
  • Desktop development with C++

• Windows SDK

• Windows WDK

• GFortran

  • Update GFORTRAN_BIN in Derectory.Build.props to the install location of GFortran

• Perl

Based on the installed VS/SDK/WDK versions, update VCToolsVersion and WindowsTargetPlatformVersion in Directory.Build.props

Note that the build system uses CommonBuildToolSet(CBT). You may need to unblock CBT.core.dll (under .build/CBT) depending on your security configurations. Please refer to CBT documentation for additional details.

Build

To build, open a Native Tools Command Prompt for Visual Studio and run msbuild from root folder.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.