Skip to content

xrdPlanner

Summary

Source: https://github.com/LennardKrause/xrdPlanner

License: GPL v3

Path: /software/jupyter/.conda/envs/xrdPlanner-2.4.0/

Documentation: https://github.com/LennardKrause/xrdPlanner

Python package for wakes and impedances handling.

Using xrdPlanner

xrdPlanner is installed as a mamba environment. Setup:

@max-wgse002:~$ module load maxwell xrdPlanner

 Module loaded for xrdPlanner 2.4.0
   - env: XRDPLANNER=~/xrdplanner 
   - cmd: xrdPlanner

The settings-folder in ~/xrdplanner is initially empty. You can populate the folder by copying over the beamline-json from the installation:

cp -r $XRDPLROOT/settings/ $XRDPLANNER/

xrdPlanner comes with editors for detectors and settings. It starts the editor with xdg-open, but the xdg-mime for json-files is firefox by default, which is not very helpful. To define a custom editor use xdg-mime:

xdg-mime default gvim.desktop 'application/json'   # or emacs.desktop, nedit.desktop, code.desktop ...