Newer
Older
###########
SCS ToolBox
###########
Kernel
######
The SCS ToolBox is design to work in the exfel_anaconda3 environement. This can
be selected on the online cluster by:
`module load exfel exfel_anaconda3`
before launching the jupyter-notebook or on max-jhub by selecting the 'xfel'
kernel instead of the 'Python 3' anaconda environement maintained by DESY.
Installation
############
As long as the ToolBox is not yet added to the exfel_anaconda3 environment it needs to be installed locally.
Activate environment mentioned above and check installation of scs_toolbox:
.. code:: bash
pip show toolbox_scs
If the toolbox has been installed in your home directory previously, everything is set up. Otherwise it needs to be installed (only once). In that case enter the following command in the directory where the *setup.py* script is located:
.. code:: bash
pip install --user .
If you intend to develop code in the toolbox use the -e flag for installation. This creates a symbolic link to the source code you are working on.
.. code:: bash
pip install --user -e .
Documentation
#############
Online documentation can be found at `ReadTheDocs <https://rtd.xfel.eu/docs/scs-toolbox/en/latest/>`_.