[LPD][Dark ] Sort Dark runs by Gain

Description

Sorting dark runs for LPD detectors (LPD1M and LPDMini)

This MR addresses LPD part in this issue: https://git.xfel.eu/calibration/planning/-/issues/192

• raw_data_location_string() to unit the creation for RAW data location for CCVs.
• sort_dark_runs_by_gain() to sort dark runs for LPD based on the gain factors for the provided 3 runs.

How Has This Been Tested?

Relevant Documents (optional)

lpdmini_sort_dark_runs.pdf

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist:

• I added tests where appropriate.

Reviewers

@kluyvert @schmidtp

tests/test_lpdlib.py

+import pytest
+
+from cal_tools.lpdlib import sort_dark_runs_by_gain
+
+
+@pytest.mark.requires_gpfs
+def test_sort_dark_runs_by_gain():
+    # TODO: update used raw data to test data when available.
+    raw_folder = "/gpfs/exfel/exp/CALLAB/202130/p900203/raw"
+    ctrl_src = "FXE_DET_LPD1M-1/COMP/FEM_MDL_COMP"
+    runs = [9008, 9010, 9009]
+    sorted_runs = sort_dark_runs_by_gain(raw_folder, runs, ctrl_src)
+    assert sorted_runs == [9008, 9009, 9010]
+
+
+@pytest.mark.requires_gpfs
+def test_raise_sort_dark_runs_by_gain():
+    # TODO: update used raw data to test data when available.
+    raw_folder = "/gpfs/exfel/exp/CALLAB/202130/p900203/raw"
+    ctrl_src = "FXE_DET_LPD1M-1/COMP/FEM_MDL_COMP"
+    runs = [9008, 9009]
+    with pytest.raises(AssertionError) as err:
+        sort_dark_runs_by_gain(raw_folder, runs, ctrl_src)
+
+    runs = [9008, 9008, 9009]  # dynamicgain, dynamicgain, fixgain2
+    with pytest.raises(ValueError) as err:
+        sort_dark_runs_by_gain(raw_folder, runs, ctrl_src)