Monochromator grating enums are known to be incorrect, so modify to use integers for the time being. Also modify config to support custom sequences.

Author: Patrick Ingraham

python/lsst/ts/externalscripts/auxtel/latiss_take_flats.py

@@ -102,8 +102,13 @@ def get_schema(cls):
     latiss_grating:
         type: string
         default: 'empty_1'
-    sequences:
-        type: string
+    sequence:
+        description: Yaml string with all required data.
+        anyOf:
+            - type: string
+            - type: "null"
+        default: null
+
     s3instance:
         type: string
         default: 'cp'
@@ -131,7 +136,12 @@ async def configure(self, config):
 
         self.config = config
         self.s3instance = config.s3instance
-        self.sequence = config.sequences
+
+        self.log.debug(f"in config, {self.sequence=}")
+
+        if config.sequence is not None:
+            self.log.debug("Loading custom configuration")
+            self.sequence = yaml.safe_load(config.sequence)
 
     async def handle_checkpoint(self, checkpoint_active, checkpoint_message):
 
@@ -162,15 +172,16 @@ def get_flat_sequence(self, latiss_filter: str, latiss_grating: str):
 
         """
         self.log.debug(
-            f"Running get_flat_sequence with {latiss_filter=} and {latiss_grating=}"
+            f"Running get_flat_sequence with the default for {latiss_filter=} and {latiss_grating=}"
         )
 
         # Check that the LATISS filter/grating combination is valid
         if latiss_filter == "SDSSr_65mm" and latiss_grating == "empty_1":
             # Returns a dictionary of sequences
             step1 = {
-                "wavelength": 580,
-                "grating": 1,  # enums.ATMonochromator.Grating.RED,  --> Enums are wrong!
+                "wavelength": 580.0,
+                # enums.ATMonochromator.Grating.RED,  --> Enums are wrong!
+                "grating": 1,
                 "spec_res": 7,
                 "exit_slit_width": 4.5,
                 "entrance_slit_width": 4.5,
@@ -182,7 +193,7 @@ def get_flat_sequence(self, latiss_filter: str, latiss_grating: str):
                 "em_n_exp": 1,
             }
             step2 = {
-                "wavelength": 620,
+                "wavelength": 620.0,
                 "grating": 1,  # enums.ATMonochromator.Grating.RED,
                 "spec_res": 8,
                 "exit_slit_width": 4.5,
@@ -202,6 +213,7 @@ def get_flat_sequence(self, latiss_filter: str, latiss_grating: str):
                 "do not have an established flat sequence. Exiting."
             )
 
+        self.log.debug(f"returning sequence of: {sequence}")
         return sequence
 
     def get_atmonochromator_setup(self, wavelength: float, spec_res: float):
@@ -234,7 +246,7 @@ def get_atmonochromator_setup(self, wavelength: float, spec_res: float):
     async def setup_atmonochromator_axes(
         self,
         wavelength: float,
-        grating: str,
+        grating: int,
         entrance_slit_width: float,
         exit_slit_width: float,
     ):
@@ -398,7 +410,9 @@ async def arun(self, checkpoint_active=False, simulation_mode: bool = 0):
         await self.setup_electrometer()
 
         # Get sequences for the given setup if not defined explicitly
+        self.log.debug(f"In arun, and {self.sequence=}")
         if self.sequence is None:
+            self.log.debug("No sequence defined, grabbing default")
             self.sequence = self.get_flat_sequence(
                 self.config.latiss_filter, self.config.latiss_grating
             )
@@ -414,8 +428,11 @@ async def arun(self, checkpoint_active=False, simulation_mode: bool = 0):
             )
 
             # will be replaced by setup_atmonochromator in the future?
+            self.log.debug(f"{self.step=}")
             self.log.debug(
-                f'Inputs to monochromator setup are: {self.step["wavelength"]=}, {self.step["grating"]=}, {self.step["exit_slit_width"]=}, {self.step["entrance_slit_width"]}'
+                f'Inputs to monochromator setup are: {self.step["wavelength"]=},'
+                f'{self.step["grating"]=}, {self.step["exit_slit_width"]=},'
+                f'{self.step["entrance_slit_width"]=}'
             )
             await self.setup_atmonochromator_axes(
                 self.step["wavelength"],
@@ -433,11 +450,13 @@ async def arun(self, checkpoint_active=False, simulation_mode: bool = 0):
                 task1 = asyncio.create_task(
                     self.latiss.take_flats(
                         self.step["exp_time"],
-                        nflats=1,
+                        n_flats=1,
                         group_id=self.group_id,
                         program="AT_flats",
-                        # reason=f"flats_{self.config.latiss_filter}_{self.config.latiss_grating}",
-                        # note=f"sequence_lfa_key={self.s3_key_name}",
+                        reason=(
+                            f"flats_{self.config.latiss_filter}_{self.config.latiss_grating}"
+                        ),
+                        note=("atmono charact."),
                     )
                 )
 

tests/auxtel/test_latiss_take_flats.py

@@ -26,10 +26,12 @@
 import random
 import unittest
 import shutil
+import yaml
 
 import pytest
 from lsst.ts import externalscripts, standardscripts
 from lsst.ts.externalscripts.auxtel import LatissTakeFlats
+from lsst.utils import getPackageDir
 
 random.seed(47)  # for set_random_lsst_dds_partition_prefix
 
@@ -61,7 +63,9 @@ async def basic_make_script(self, index):
         self.script.setup_electrometer = unittest.mock.AsyncMock()
 
         # Mock setup of atmonochromator
-        self.script.setup_atmonochromator_axes = unittest.mock.AsyncMock()
+        self.script.setup_atmonochromator_axes = unittest.mock.AsyncMock(
+            side_effect=self.setup_atmonochromator_axes_callback
+        )
 
         # mock fiber spectrograph exposures
         self.script.take_fs_exposures = unittest.mock.AsyncMock(
@@ -90,6 +94,26 @@ async def basic_make_script(self, index):
         # Return a single element tuple
         return (self.script,)
 
+    async def setup_atmonochromator_axes_callback(
+        self,
+        wavelength: float,
+        grating: str,
+        entrance_slit_width: float,
+        exit_slit_width: float,
+    ):
+        """
+        Mocks the monochromator setup.
+        """
+
+        # Check that all inputs are the correct type.
+
+        assert type(wavelength) == float
+        assert type(grating) == int
+        assert type(entrance_slit_width) == float
+        assert type(exit_slit_width) == float
+
+        return
+
     async def take_fs_exposures_callback(self, expTime, n):
         """
         Mocks the taking of fiber spectrograph images
@@ -147,6 +171,27 @@ async def test_configure(self):
                 latiss_grating=latiss_grating,
             )
 
+        async with self.make_script():
+            # Try more complex parameters
+            latiss_filter = "SDSSr_65mm"
+            latiss_grating = "empty_1"
+            # load a complex sequence defined as yaml
+            test_sequence_path = os.path.join(
+                getPackageDir("ts_externalscripts"),
+                "tests",
+                "data",
+                "auxtel",
+                "test_sequence1.yaml",
+            )
+            with open(test_sequence_path, "r") as file:
+                sequence = yaml.safe_load(file)
+
+            await self.configure_script(
+                latiss_filter=latiss_filter,
+                latiss_grating=latiss_grating,
+                sequence=sequence,
+            )
+
     async def test_invalid_sequence(self):
         # invalid filters, script should configure and hardware will get
         # setup but fail.
@@ -167,10 +212,10 @@ async def test_invalid_sequence(self):
                 await self.script.arun()
 
     async def test_sequence(self):
-        # valid sequence
+        # valid sequence, using the default
 
         async with self.make_script():
-            # Try configure with invalid sequence data. This should fail
+            # Try configure with invalid sequence data.
             latiss_filter = "SDSSr_65mm"
             latiss_grating = "empty_1"
 
@@ -181,6 +226,34 @@ async def test_sequence(self):
             # indication simulation for s3 bucket.
             await self.script.arun(simulation_mode=1)
 
+    async def test_sequence_custom(self):
+        # valid sequence, using a custom input
+
+        async with self.make_script():
+            # Try configure with complex sequence data.
+            latiss_filter = "SDSSr_65mm"
+            latiss_grating = "empty_1"
+            # load a complex sequence defined as yaml
+            test_sequence_path = os.path.join(
+                getPackageDir("ts_externalscripts"),
+                "tests",
+                "data",
+                "auxtel",
+                "test_sequence1.yaml",
+            )
+
+            with open(test_sequence_path, "r") as file:
+                sequence = yaml.safe_load(file)
+
+            await self.configure_script(
+                latiss_filter=latiss_filter,
+                latiss_grating=latiss_grating,
+                sequence=sequence,
+            )
+
+            # indication of simulation for s3 bucket.
+            await self.script.arun(simulation_mode=1)
+
     async def test_executable(self):
         scripts_dir = externalscripts.get_scripts_dir()
         script_path = scripts_dir / "auxtel" / "latiss_take_flats.py"

tests/data/auxtel/test_sequence1.yaml

@@ -0,0 +1,17 @@
+"- em_exp_time: 5\n  em_n_exp: 1\n  entrance_slit_width: 4.5\n  exit_slit_width: 4.5\n\
+  \  exp_time: 3\n  fs_exp_time: 5\n  fs_n_exp: 1\n  grating: 1\n  n_exp: 5\n  spec_res:\
+  \ -1\n  wavelength: 550.0\n- em_exp_time: 5\n  em_n_exp: 1\n  entrance_slit_width:\
+  \ 4.5\n  exit_slit_width: 4.5\n  exp_time: 3\n  fs_exp_time: 5\n  fs_n_exp: 1\n\
+  \  grating: 1\n  n_exp: 5\n  spec_res: -1\n  wavelength: 570.0\n- em_exp_time: 5\n\
+  \  em_n_exp: 1\n  entrance_slit_width: 4.5\n  exit_slit_width: 4.5\n  exp_time:\
+  \ 3\n  fs_exp_time: 5\n  fs_n_exp: 1\n  grating: 1\n  n_exp: 5\n  spec_res: -1\n\
+  \  wavelength: 590.0\n- em_exp_time: 5\n  em_n_exp: 1\n  entrance_slit_width: 4.5\n\
+  \  exit_slit_width: 4.5\n  exp_time: 3\n  fs_exp_time: 5\n  fs_n_exp: 1\n  grating:\
+  \ 1\n  n_exp: 5\n  spec_res: -1\n  wavelength: 610.0\n- em_exp_time: 5\n  em_n_exp:\
+  \ 1\n  entrance_slit_width: 4.5\n  exit_slit_width: 4.5\n  exp_time: 3\n  fs_exp_time:\
+  \ 5\n  fs_n_exp: 1\n  grating: 1\n  n_exp: 5\n  spec_res: -1\n  wavelength: 630.0\n\
+  - em_exp_time: 5\n  em_n_exp: 1\n  entrance_slit_width: 4.5\n  exit_slit_width:\
+  \ 4.5\n  exp_time: 3\n  fs_exp_time: 5\n  fs_n_exp: 1\n  grating: 1\n  n_exp: 5\n\
+  \  spec_res: -1\n  wavelength: 650.0\n- em_exp_time: 5\n  em_n_exp: 1\n  entrance_slit_width:\
+  \ 4.5\n  exit_slit_width: 4.5\n  exp_time: 3\n  fs_exp_time: 5\n  fs_n_exp: 1\n\
+  \  grating: 1\n  n_exp: 5\n  spec_res: -1\n  wavelength: 670.0\n"