Skip to content
Snippets Groups Projects
Commit b7206669 authored by Karim Ahmed's avatar Karim Ahmed
Browse files

fix: as pyenv 3.11.9 is available update MR accordingly

parent 39437439
No related branches found
No related tags found
1 merge request!1044Documentation: update installation for using python 3.11.9
...@@ -25,24 +25,19 @@ Installation using python virtual environment - recommended ...@@ -25,24 +25,19 @@ Installation using python virtual environment - recommended
=========================================================== ===========================================================
`pycalibration` uses the same version of Python as Karabo, which in June 2021 `pycalibration` uses the same version of Python as Karabo, which in June 2021
updated to use Python 3.8. Currently the default python installation on Maxwell updated to use Python 3.11. Currently the default python installation on Maxwell
is still Python 3.6.8, so Python 3.8 needs to be loaded from a different is still Python 3.9, so Python 3.11 needs to be loaded from a different
location. location.
One option is to use the Maxwell Spack installation, running `module load Therefore `pyenv` is used, we provide a pyenv installation at
maxwell` will activate the test Spack instance from DESY, then you can use
`module load python-3.8.6-gcc-10.2.0-622qtxd` to Python 3.8. Note that this Spack
instance is currently a trial phase and may not be stable.
Another option is to use `pyenv`, we provide a pyenv installation at
`/gpfs/exfel/sw/calsoft/.pyenv` which we use to manage different versions of `/gpfs/exfel/sw/calsoft/.pyenv` which we use to manage different versions of
python. This can be activated with ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate`` python. This can be activated with ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate``
A quick setup would be: A quick setup would be:
1. ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate`` 1. ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate``
2. ``git clone --branch 3.14.4 ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration`` - clone the offline calibration package from EuXFEL GitLab 2. ``git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration`` - clone the offline calibration package from EuXFEL GitLab
3. ``pyenv shell 3.8.18`` - load required version of python 3. ``pyenv shell 3.11.9`` - load required version of python
4. ``python3 -m venv .venv`` - create the virtual environment 4. ``python3 -m venv .venv`` - create the virtual environment
5. ``source .venv/bin/activate`` - activate the virtual environment 5. ``source .venv/bin/activate`` - activate the virtual environment
6. ``python3 -m pip install --upgrade pip`` - upgrade version of pip 6. ``python3 -m pip install --upgrade pip`` - upgrade version of pip
...@@ -54,9 +49,8 @@ Copy/paste script: ...@@ -54,9 +49,8 @@ Copy/paste script:
source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate
git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git
git checkout 3.14.4 # Use this version for compatibility with Python 3.8.18
cd pycalibration cd pycalibration
pyenv shell 3.8.18 pyenv shell 3.11.9
python3 -m venv .venv python3 -m venv .venv
source .venv/bin/activate source .venv/bin/activate
python3 -m pip install --upgrade pip python3 -m pip install --upgrade pip
...@@ -73,8 +67,8 @@ will downgrade/upgrade your local packages, which may cause major issues and may ...@@ -73,8 +67,8 @@ will downgrade/upgrade your local packages, which may cause major issues and may
installation method instead. installation method instead.
1. ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate`` 1. ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate``
2. ``git --branch 3.14.4 clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration`` - clone the offline calibration package from EuXFEL GitLab 2. ``git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration`` - clone the offline calibration package from EuXFEL GitLab
3. ``pyenv shell 3.8.18`` - load required version of python 3. ``pyenv shell 3.11.9`` - load required version of python
4. ``pip install .`` - install the pycalibration package (add ``-e`` flag for editable development installation) 4. ``pip install .`` - install the pycalibration package (add ``-e`` flag for editable development installation)
5. ``export PATH=$HOME/.local/bin:$PATH`` - make sure that the home directory is in the PATH environment variable 5. ``export PATH=$HOME/.local/bin:$PATH`` - make sure that the home directory is in the PATH environment variable
...@@ -84,8 +78,7 @@ Copy/paste script: ...@@ -84,8 +78,7 @@ Copy/paste script:
source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate
git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git
git checkout 3.14.4 # Use this version for compatibility with Python 3.8.18 pyenv shell 3.11.9
pyenv shell 3.8.18
cd pycalibration cd pycalibration
pip install --user . # `-e` flag for editable install, e.g. `pip install -e .` pip install --user . # `-e` flag for editable install, e.g. `pip install -e .`
export PATH=$HOME/.local/bin:$PATH export PATH=$HOME/.local/bin:$PATH
......
...@@ -11,27 +11,21 @@ to do this. ...@@ -11,27 +11,21 @@ to do this.
## Installation using python virtual environment - recommended ## Installation using python virtual environment - recommended
`pycalibration` uses Python 3.8. Currently, the default `pycalibration` uses the same version of Python as Karabo, which in June 2021
python installation on Maxwell is still Python 3.6.8, so Python 3.8 updated to use Python 3.11. Currently the default python installation on Maxwell
needs to be loaded from a different location. is still Python 3.9, so Python 3.11 needs to be loaded from a different
location.
One option is to use the Maxwell Spack installation, running `module Therefore `pyenv` is used, we provide a pyenv installation at
load maxwell` will activate the test Spack instance from `/gpfs/exfel/sw/calsoft/.pyenv` which we use to manage different versions of
DESY, then you can use `module load python. This can be activated with ``source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate``
python-3.8.6-gcc-10.2.0-622qtxd` to Python 3.8. Note that
this Spack instance is currently a trial phase and may not be stable.
Another option is to use `pyenv`, we provide a pyenv
installation at `/gpfs/exfel/sw/calsoft/.pyenv` which we use
to manage different versions of python. This can be activated with
`source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate`
A quick setup would be: A quick setup would be:
1. `source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate` 1. `source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate`
2. `git clone --branch 3.14.4 ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration` - 2. `git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration` -
clone the offline calibration package from EuXFEL GitLab clone the offline calibration package from EuXFEL GitLab
3. `pyenv shell 3.8.18` - load required version of python 3. `pyenv shell 3.11.9` - load required version of python
4. `python3 -m venv .venv` - create the virtual environment 4. `python3 -m venv .venv` - create the virtual environment
5. `source .venv/bin/activate` - activate the virtual environment 5. `source .venv/bin/activate` - activate the virtual environment
6. `python3 -m pip install --upgrade pip` - upgrade version of pip 6. `python3 -m pip install --upgrade pip` - upgrade version of pip
...@@ -43,9 +37,8 @@ Copy/paste script: ...@@ -43,9 +37,8 @@ Copy/paste script:
```bash ```bash
source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate source /gpfs/exfel/sw/calsoft/.pyenv/bin/activate
git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git
git checkout 3.14.4 # Use this version for compatibility with Python 3.8.18
cd pycalibration cd pycalibration
pyenv shell 3.8.18 pyenv shell 3.11.9
python3 -m venv .venv python3 -m venv .venv
source .venv/bin/activate source .venv/bin/activate
python3 -m pip install --upgrade pip python3 -m pip install --upgrade pip
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment