Skip to content
Snippets Groups Projects

instructions to install using anaconda

Merged Karim Ahmed requested to merge doc/anaconda_installation into master

@haufs @karnem

This MR consists of:

  1. Instructions on how to install in an anaconda environment.
  2. three new packages in the requirements. (2 for Jupyter [to make sure they are updated] and sphinx)
  3. the sphinx theme instead of the old alabaster theme
Edited by Karim Ahmed

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
74
75 pip install -r requirements.txt . --user
76
77 in pycalibration's root directory.
78 After installation, you should make sure the home directory is in the PATH environment variable::
79
80 PATH=~/.local/bin:$PATH
81
82 and adjust the :ref:`configuration` and settings in the folder
83 xfel-calibrate to match your environment.
84
85 The tool-chain is then available via the::
86
87 xfel-calibrate
88
89 command.
  • Karim Ahmed
  • 106 pip install --target=~/myscratch/directory -r requirements.txt .
    107
    108 in pycalibration's root directory.
    109 After installation, you should make sure the your preferred directory is in the PATH environment variable::
    110
    111 PATH=~/myscratch/directory/bin:$PATH
    112
    113 and adjust the :ref:`configuration` and settings in the folder
    114 xfel-calibrate to match your environment.
    115
    116 The tool-chain is then available via the::
    117
    118 xfel-calibrate
    119
    120 command.
    121
    • I would keep both: local and preferred directory. We can keep preferred directory as alternative installation.

      But the way, is this instruction complete.

      • Does pip work with relative path like ~/myscratsh/directory.
      • Will be this directory created or it should exists.
      • Does PATH variable helps python to find extra packages?
    • Please register or sign in to reply
  • Karim Ahmed changed the description

    changed the description

  • In the Tutorial section in pycalibration documentation, it is mentioned that one needs to install karabao 2.2.4. Does this serves a specific purpose or does this need to be removed?

    Screenshot_from_2019-07-12_13-15-21

    Edited by Karim Ahmed
  • 57 57
    58 58 command.
    59 59
    60 Installing using Anaconda/3 in home directory
    61 ---------------------------------------------
    62
    63 If you are installing into anaconda environment make sure it is enabled
    64 by sourcing the activate file::
  • I think python environment available in karabo 2.2.4 is not fully compatible with pycalibration, which requires more up-to-date versions of packages.

  • The async syntax requires python 3.6 minimum, which is not available in Karabo 2.2 I think. We do not need to maintain Karabo-backward compatibility for pycalibrate though. It should be compatible to the anaconda/3 environments on Maxwell and the online clusters.

  • To specifically answer your question about Karabo: the main way of installation should in the future be anaconda/3. But it will be good to maintain a short and as generic as possible instruction for installing into the Karabo environment.

  • Karim Ahmed added 1 commit

    added 1 commit

    • fe96b9cf - installation doc modifications

    Compare with previous version

  • Karim Ahmed added 1 commit

    added 1 commit

    • e1b0df11 - requirements instead of prerequists

    Compare with previous version

  • Karim Ahmed
  • 42 calibration can be obtained from the git repository::
    38 1. module load anaconda/3
    43 39
    44 git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
    40 If installing into other python enviroments, this step can be skipped.
    45 41
    46 You can then install all prerequisites and this tool chain by running::
    42 Then the package for the offline calibration can be obtained from the git repository::
    47 43
    48 pip install -r requirements.txt .
    49
    50 in th emain directoy pycalibration.
    51 After installation, you should adjust the :ref:`configuration` and settings in the folder
    52 xfel-calibrate to match your environment.
    44 2. git clone https://git.xfel.eu/gitlab/detectors/pycalibration.git
    45
  • Karim Ahmed
  • 57 78
    58 79 command.
    59 80
    81
    82 Install into karabo
    83 +++++++++++++++++++
    84
    85 If required, one can install into karabo environment. The difference would be to
    86 first source activate the karabo envrionment::
    87
    88 1. source karabo/activate
    89
    90 then after cloning the offline calibration package from git, the requirements can be installed through::
    91
    92 3. pip install -r requirements.txt .
    93
  • Karim Ahmed unmarked as a Work In Progress

    unmarked as a Work In Progress

  • Karim Ahmed changed the description

    changed the description

  • Karim Ahmed marked as a Work In Progress

    marked as a Work In Progress

  • Mikhail Karnevskiy
  • Mikhail Karnevskiy
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading