Install Amazon ParallelCluster in a virtual environment (recommended)
We recommend that you install Amazon ParallelCluster in a virtual environment to avoid requirement version conflicts with other
pip
packages.
Prerequisites
-
Amazon ParallelCluster requires Python 3.7 or later. If you don't already have it installed, download a compatible version
for your platform at python.org .
To install Amazon ParallelCluster in a virtual environment
-
If
virtualenv
isn't installed, installvirtualenv
usingpip3
. Ifpython3 -m virtualenv help
displays help information, go to step 2.$
python3 -m pip install --upgrade pip
$
python3 -m pip install --user --upgrade virtualenv
Run
exit
to leave the current terminal window and open a new terminal window to pick up changes to the environment. -
Create a virtual environment and name it.
$
python3 -m virtualenv
~/apc-ve
Alternatively, you can use the
-p
option to specify a specific version of Python.$
python3 -m virtualenv -p $(which python3)
~/apc-ve
-
Activate your new virtual environment.
$
source
~/apc-ve
/bin/activate -
Install Amazon ParallelCluster into your virtual environment.
(apc-ve)~$
python3 -m pip install --upgrade "aws-parallelcluster"
-
Install Node Version Manager and the latest Long-Term Support (LTS) Node.js version. Amazon Cloud Development Kit (Amazon CDK) (Amazon CDK) requires Node.js for CloudFormation for template generation.
Note
If your Node.js installation isn't working on your platform, you can install an LTS version prior to the latest LTS version. For more information, see the Node.js release schedule
and the Amazon CDK prerequisites. Example Node.js installation command:
$
nvm install --lts=Hydrogen
$
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
$
chmod ug+x ~/.nvm/nvm.sh
$
source ~/.nvm/nvm.sh
$
nvm install --lts
$
node --version
-
Verify that Amazon ParallelCluster is installed correctly.
$
pcluster version
{ "version": "3.7.0" }
You can use the deactivate
command to exit the virtual environment. Each time you start a session, you must reactivate the environment.
To upgrade to the latest version of Amazon ParallelCluster, run the installation command again.
(apc-ve)~$
python3 -m pip install --upgrade "aws-parallelcluster"