Intel® MPI Library Developer Guide for Windows* OS

ID 768730
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

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

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