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

installation doc modifications

parent 3b56d545
No related branches found
No related tags found
1 merge request!94instructions to install using anaconda
...@@ -30,57 +30,47 @@ parameter when executing `xfel-calibrate`. ...@@ -30,57 +30,47 @@ parameter when executing `xfel-calibrate`.
.. _SLURM: https://slurm.schedmd.com .. _SLURM: https://slurm.schedmd.com
.. _PyDetLib: https://in.xfel.eu/readthedocs/docs/pydetlib/en/latest/ .. _PyDetLib: https://in.xfel.eu/readthedocs/docs/pydetlib/en/latest/
Installing using Karabo Installing using Anaconda
----------------------- ---------------------------
If you are installing into a Karabo environment make sure it is enabled First you need to load the anaconda/3 environment through::
by sourcing the activate file in the Karabo path::
source karabo/activate 1. module load anaconda/3
For other python enviroments, this step can be skipped. The package for the offline
calibration can be obtained from the git repository::
git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git If installing into other python enviroments, this step can be skipped.
You can then install all prerequisites and this tool chain by running:: Then the package for the offline calibration can be obtained from the git repository::
pip install -r requirements.txt . 2. git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
in pycalibration's root directory.
After installation, you should adjust the :ref:`configuration` and settings in the folder
xfel-calibrate to match your environment.
The tool-chain is then available via the:: Home directory
++++++++++++++
xfel-calibrate You can then install all requirements of this tool chain in your home directory by running::
command.
Installing using Anaconda/3 in home directory 3. pip install -r requirements.txt . --user
---------------------------------------------
If you are installing into anaconda environment make sure it is enabled in pycalibration's root directory.
by sourcing the activate file::
module load anaconda/3 After installation, you should make sure that the home directory is in the PATH environment variable::
For other python enviroments, this step can be skipped. The package for the offline 4. PATH=/home/<username>/.local/bin:$PATH
calibration can be obtained from the git repository::
git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git Preferred directory
+++++++++++++++++++
You can then install all requirements of this tool chain in your home directory by running:: Alternatively, you can install all requirements in a directory of your preference by::
pip install -r requirements.txt . --user 3. mkdir /gpfs/exfel/data/scratch/<username>/<directory-name>
pip install --target=/gpfs/exfel/data/scratch/<username>/<directory-name> -r requirements.txt .
in pycalibration's root directory. and it is important to make sure that installed requirements is in the PATH environment::
After installation, you should make sure the home directory is in the PATH environment variable::
4. PATH=/gpfs/exfel/data/scratch/<username>/<directory-name>/bin:$PATH
PATH=~/.local/bin:$PATH
and adjust the :ref:`configuration` and settings in the folder After this make sure to adjust the :ref:`configuration` and settings in the xfel-calibrate
xfel-calibrate to match your environment. folder to match your environment.
The tool-chain is then available via the:: The tool-chain is then available via the::
...@@ -88,38 +78,18 @@ The tool-chain is then available via the:: ...@@ -88,38 +78,18 @@ The tool-chain is then available via the::
command. command.
Installing using Anaconda/3 in preferred directory
--------------------------------------------------
If you are installing into anaconda environment make sure it is enabled
by sourcing the activate file::
module load anaconda/3 Install into karabo
+++++++++++++++++++
For other python enviroments, this step can be skipped. The package for the offline If required, one can install into karabo environment. The difference would be to
calibration can be obtained from the git repository:: first source activate the karabo envrionment::
git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git 1. source karabo/activate
You can then install all requirements of this tool chain in your preferred directory by running::
pip install --target=~/myscratch/directory -r requirements.txt .
in pycalibration's root directory.
After installation, you should make sure the your preferred directory is in the PATH environment variable::
PATH=~/myscratch/directory/bin:$PATH
and adjust the :ref:`configuration` and settings in the folder
xfel-calibrate to match your environment.
The tool-chain is then available via the::
xfel-calibrate
command.
then after cloning the offline calibration package from git, the requirements can be installed through::
3. pip install -r requirements.txt .
Development Installation Development Installation
------------------------ ------------------------
...@@ -129,7 +99,6 @@ first install the dependencies as above, but then install the tool-chain ...@@ -129,7 +99,6 @@ first install the dependencies as above, but then install the tool-chain
separately in development mode:: separately in development mode::
pip install -e . pip install -e .
Installation of New Notebooks Installation of New Notebooks
......
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