Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Installing Amazon ParallelCluster

Amazon ParallelCluster is distributed as a Python package and is installed using pip, the Python package manager. For more information on installing Python packages, see Installing packages in the Python Packaging User Guide.

You can find the version number of the most recent CLI on the releases page on GitHub.

In this guide, the command examples assume that you have Python v3 installed. The pip command examples use the pip3 version.

Installing Amazon ParallelCluster in a virtual environment (recommended)

We recommend that you install Amazon ParallelCluster in a virtual environment. If you encounter issues when you attempt to install Amazon ParallelCluster with pip3, you can install Amazon ParallelCluster in a virtual environment to isolate the tool and its dependencies. Or you can use a different version of Python than you normally do.

Installing Amazon ParallelCluster in a non-virtual environment using pip

The primary distribution method for Amazon ParallelCluster on Linux, Windows, and macOS is pip, which is a package manager for Python. It provides a way to install, upgrade, and remove Python packages and their dependencies.

Current Amazon ParallelCluster Version

Amazon ParallelCluster is updated regularly. To determine whether you have the latest version, see the releases page on GitHub.

If you already have pip and a supported version of Python, you can install Amazon ParallelCluster by using the following command. If you have Python version 3+ installed, we recommend that you use the pip3 command.

$ pip3 install "aws-parallelcluster<3.0" --upgrade --user

Steps to take after installation

After you install Amazon ParallelCluster, you might need to add the executable file path to your PATH variable. For platform-specific instructions, see the following topics:

You can verify that Amazon ParallelCluster installed correctly by running pcluster version.

$ pcluster version
2.11.9

Amazon ParallelCluster is updated regularly. To update to the latest version of Amazon ParallelCluster, run the installation command again. For details about the latest version of Amazon ParallelCluster, see the Amazon ParallelCluster release notes.

$ pip3 install "aws-parallelcluster<3.0" --upgrade --user

To uninstall Amazon ParallelCluster, use pip uninstall.

$ pip3 uninstall "aws-parallelcluster<3.0"

If you don't have Python and pip, use the procedure for your environment.

Detailed instructions for each environment