Setup Environment

After you are ssh'd into s3df and ssh'd into the psana computing pool, you will need to setup your environment for python, libraries like psana, etc:

source /sdf/group/lcls/ds/ana/sw/conda2/manage/bin/psconda.sh

Then you can execute the following to setup some project-specific things (must be ran in each new terminal session and from beamtime-calibration-suite folder):

source setup.sh

This script simplifies setting up the terminal environment and should be all most users will need to do

This script does the following: * appends your cloned location of this library to your PYTHONPATH, so scripts in /suite_scripts and other locations on your machine can find the library code * sets the library's output-root to the shared dir used for the current experiment * sets the config file to the currently used config.

The rest of the page has more detail on configuring the scripts.

Specifying Output Root

The environment variable OUTPUT_ROOT determines where the library will look for output folders.

Setting the variable to . (by doing 'export OUTPUT_ROOT=.') will have the library look for an output folder relative to the location of the current script being ran. ( . refers to current dir on linux)

For example, if the root is set to the default value /sdf/data/lcls/ds/rix/rixx1003721/results/scripts/, the library will look for an output dir ../scan in the location /sdf/data/lcls/ds/rix/rixx1003721/results/scripts/../scan

Then to set the output-directory you can use the -p <dir_name> cmdline arg

Point to Config File

Specify which config file for the library to use by setting the SUITE_CONFIG environment variable:

export SUITE_CONFIG="rixSuiteConfig.py"

(relative or full paths should work)

You can also set the config-file using the '-cf' or '--configFile' cmd-line arguments (note: if set, the environment variable will always override this cmd-line option)

If neither of the above are set, the suite will try to use a default file named suiteConfig.py

If no config file can be found and read, the library will fail-out early