Beamtime calibration suite

This repository contains scripts ran during (or in-between) beamtimes to support calibrating LCLS detectors.

Some more general info can be found on the team's confluence page

File organization:

TEST!!!!

The following describes what and where things are:

  • /calibrationSuite: The library code lives here, and the functions are able to be imported into other scripts as such:
from calibrationSuite.basicSuiteScript import BasicSuiteScript
from calibrationSuite import ancillaryMethods
import calibrationSuite.fitFunctions as fitFunctions
...

(documentation on the library functionality is still to come, but example usage is seen by scripts in the suite_scripts folder)

  • /suite_scripts: scripts that use the calibrationSuite library code (these can be called 'high-level scripts')
  • /config_files: files that set values used by the calibrationSuite, which config-file to use is specified by env variable $SUITE_CONFIG
  • /standalone_scripts: scripts that do not use the calibrationSuite library code (also 'high-level scripts')
  • /tests: tests files, can be ran with 'pytest .' from the root project directory or from the tests directory.
  • /data: example data-files used for running the scripts

Important branches:

  • development: contains the newest 'good' code, usually has new changes and bug fixes. This is also the default branch for the repo
  • main: stable code that's used during beamtimes. The code from each beamtime (including the changes made during) is tagged
  • beamtime_<month>_<day>_<year>: branch we will checkout and push to during a specific beamtime. The date should be the first day of the beamtime.