From da186d63ea39eb84747399f85e8006f7b95cbfa1 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Thu, 5 Sep 2024 17:47:57 +0200 Subject: [PATCH 1/2] add warning to FAQ about PYTHONPATH --- mkdocs/docs/HPC/FAQ.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/mkdocs/docs/HPC/FAQ.md b/mkdocs/docs/HPC/FAQ.md index f249887b60b..5773c00dde9 100644 --- a/mkdocs/docs/HPC/FAQ.md +++ b/mkdocs/docs/HPC/FAQ.md @@ -300,6 +300,11 @@ Note that it is still preferred to submit a software installation request, as the software installed by the HPC team will be optimized for the HPC environment. This can lead to dramatic performance improvements. +!!! warning + Don't install software using `pip install --user` or `pip install --target` with `$PYTHONPATH` + as this can lead to conflicts with the software installed by the HPC team. + If you need to install software in your home directory, use a [Python virtual environment](./setting_up_python_virtual_environments.md). + ### Is my connection compromised? Remote host identification has changed On Monday 25 April 2022, the login nodes received an update to RHEL8. From 4a186f5274cea8807e37ef61cb84478466e8b19d Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 10 Sep 2024 15:28:55 +0200 Subject: [PATCH 2/2] more info in warning --- mkdocs/docs/HPC/FAQ.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/mkdocs/docs/HPC/FAQ.md b/mkdocs/docs/HPC/FAQ.md index 5773c00dde9..f4f62b5cafc 100644 --- a/mkdocs/docs/HPC/FAQ.md +++ b/mkdocs/docs/HPC/FAQ.md @@ -300,10 +300,17 @@ Note that it is still preferred to submit a software installation request, as the software installed by the HPC team will be optimized for the HPC environment. This can lead to dramatic performance improvements. -!!! warning - Don't install software using `pip install --user` or `pip install --target` with `$PYTHONPATH` - as this can lead to conflicts with the software installed by the HPC team. - If you need to install software in your home directory, use a [Python virtual environment](./setting_up_python_virtual_environments.md). +!!! warning + Do not use `pip install --user` to install software, as this places packages + in `~/.local/lib/python*/site-packages`, potentially causing conflicts with software installed by the HPC team. + + Also, avoid using `pip install --prefix` or `pip install --target` with `$PYTHONPATH`, + since `$PYTHONPATH` is a global setting that affects all Python versions. + When `$PYTHONPATH` includes directories with packages from different Python versions, it can lead to conflicts. + + Instead, use a Python virtual environment for package installations in your home directory. + For guidance on setting up virtual environments, + refer to the [Python virtual environments setup guide](./setting_up_python_virtual_environments.md). ### Is my connection compromised? Remote host identification has changed