diff --git a/README.rst b/README.rst index e0217e1f0369da794295b60e73bc44c02ba8a68f..40f61d1322e7001cba95dffc5a10505a45535287 100644 --- a/README.rst +++ b/README.rst @@ -60,6 +60,10 @@ Copy/paste script: source .venv/bin/activate python3 -m pip install --upgrade pip python3 -m pip install . # `-e` flag for editable install, e.g. `pip install -e .` +<<<<<<< HEAD +======= + python3 -m pip install "git+ssh://git@git.xfel.eu:10022/karaboDevices/pyDetLib.git#egg=XFELDetectorAnalysis&subdirectory=lib/" +>>>>>>> Update readme to reflect new setup method Installation into user home directory @@ -67,6 +71,7 @@ Installation into user home directory This is not recommended as `pycalibration` has pinned dependencies for stability, if you install it directly into you users home environment then it +<<<<<<< HEAD will downgrade/upgrade your local packages, which may cause major issues and may **break your local environment**, it is highly recommended to use the venv installation method instead. @@ -76,6 +81,16 @@ installation method instead. 3. ``pyenv shell 3.8.11`` - load required version of python 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 +======= +will down/upgrade your local packages, which may cause major issues and may +**break your local environment**, it is highly recommended to use the venv +installation method instead. + +1. ``git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git && cd pycalibration`` - clone the offline calibration package from EuXFEL GitLab +2. ``module load anaconda/3`` - load the anaconda/3 environment. If installing into other python environments, this step can be skipped +3. ``pip install .`` - install the pycalibration package (add ``-e`` flag for editable development installation) +4. ``export PATH=$HOME/.local/bin:$PATH`` - make sure that the home directory is in the PATH environment variable +>>>>>>> Update readme to reflect new setup method Copy/paste script: @@ -85,6 +100,10 @@ Copy/paste script: git clone ssh://git@git.xfel.eu:10022/detectors/pycalibration.git pyenv shell 3.8.11 cd pycalibration +<<<<<<< HEAD +======= + module load anaconda/3 +>>>>>>> Update readme to reflect new setup method pip install --user . # `-e` flag for editable install, e.g. `pip install -e .` export PATH=$HOME/.local/bin:$PATH