Intel® MPI Library Developer Guide for Windows* OS

Download PDF
ID 768730
Date 6/24/2024
Public
Document Table of Contents
Document Table of Contents x
Intel® MPI Library Developer Guide for Windows* OS
Intel® MPI Library Developer Guide for Windows* OS x
Introduction Installation and Prerequisites Compiling and Linking Running Applications Debugging Applications Analysis and Tuning Troubleshooting Notices and Disclaimers
Introduction x
Introducing Intel® MPI Library Conventions and Symbols Related Information
Installation and Prerequisites x
Installation Prerequisite Steps User Authorization
Compiling and Linking x
Compiling an MPI Program Configuring a Microsoft Visual Studio* Project
Running Applications x
Running Intel® MPI Library in Containers Selecting a Library Configuration Running an MPI Program Running an MPI/OpenMP* Program MPMD Launch Mode Fabrics Control Job Schedulers Support Controlling Process Placement Java* MPI Applications Support
Running Intel® MPI Library in Containers x
Build a Singularity* Container for an MPI Application Run the Application with a Container
Fabrics Control x
Selecting Fabrics Libfabric* Support OFI* Providers Support
Debugging Applications x
Debugging Using -gtool for Debugging
Analysis and Tuning x
Displaying MPI Debug Information Tracing Applications MPI Tuning
Troubleshooting x
Error Message: Bad Termination Error Message: No such file or Directory Error Message: Permission Denied Error Message: Fatal Error Error Message: Bad File Descriptor Error Message: Too Many Open Files Problem: MPI Application Hangs Problem: Password Required Problem: Cannot Execute Binary File Problem: MPI limitation for Docker*
Intel® MPI Library Developer Guide for Windows* OS

Prerequisite Steps

Before you start using any of the Intel® MPI Library functionality, make sure to establish the proper environment settings:

  1. Set up the Intel MPI Library environment by running the setvars.bat file, which is found in your installation directory (by default, C:\Program Files (x86)\Intel\oneAPI\mpi\<version> ).

    NOTE:
    You must run setvars at the start of each  command-line session unless you are using Microsoft Visual Studio for Windows* (Visual Studio runs setvars automatically). See the Intel HPC Toolkit Get Started Guide for more details, including options for automatic setup of environment settings.
    NOTE:
    If you are using Intel MPI in a Unified Directory Layout, set the environment variables using the C:\Program Files (x86)\Intel\oneAPI\<toolkit-version-number>\oneapi_setvars.bat script instead. To understand more about the Unified Directory Layout, including how the environment is initialized and the advantages of using the layout, see Use the setvars and oneapi-vars Scripts with Windows*.

  2. To run an MPI application on a cluster, the Intel MPI Library needs to know names of all its nodes. Create a text file listing the cluster node names. The format of the file is one name per line, and the lines starting with # are ignored. To get the name of a node, use the hostname utility.

    A sample host file may look as follows: 

    > type hosts
# This line is ignored
clusternode1
clusternode2
clusternode3
clusternode4

NOTE:
When using Windows* Client Operating Systems, such as Windows* 10 and Windows* 11, for PowerShell remoting, make sure that users are added to the administrator group.
Intel MPI uses PowerShell bootstrap by default. It is available by default and does not require any extra steps. If you need more fine-grain setup information, refer to Microsoft PowerShell Setup Guide and read the following topics: about_Remote_Requirements (https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_requirements?view=powershell-7.4), Security Considerations for PowerShell Remoting using WinRM (https://learn.microsoft.com/en-us/powershell/scripting/security/remoting/winrm-security?view=powershell-7.4), and about_Remote_Troubleshooting (https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_troubleshooting?view=powershell-7.4). You can also consider domain-based authorization as an alternative to the default mechanism. However, this method requires additional configuration.

After completing these steps, you are ready to use the Intel MPI Library.

Parent topic: Installation and Prerequisites
Level Two Title