Merge branch 'develop'

doc/conf.py

@@ -3,8 +3,6 @@
 This configuration only affects single-package Sphinx documentation builds.
 """
 
-import os
-
 import lsst.ts.imsim  # noqa
 from documenteer.conf.pipelinespkg import *  # noqa
 
@@ -15,13 +13,8 @@
 doxylink = {}
 
 
-# Support the sphinx extension of plantuml
-extensions.append("sphinxcontrib.plantuml")  # noqa
-
-# Put the path to plantuml.jar
-plantuml_path = (
-    os.path.expanduser("~/plantuml.jar")
-    if os.getenv("PATH_PLANTUML") is None
-    else os.getenv("PATH_PLANTUML")
-)
-plantuml = f"java -jar {plantuml_path}"
+# Support the sphinx extension of mermaid
+extensions = [
+    "sphinxcontrib.mermaid",
+    "sphinx_automodapi.automodapi",
+]

doc/developer-guide/developer-guide.rst

@@ -27,7 +27,7 @@ imsim
 
 This module contains the closed loop methods.
 
-.. uml:: ../uml/imsimClass.uml
+.. mermaid:: ../uml/imsimClass.mmd
     :caption: Class diagram of ts_imsim.
 
 * **ClosedLoopTask**: Run the imSim based closed loop for AOS.

doc/uml/imsimClass.uml → doc/uml/imsimClass.mmd

@@ -1,5 +1,5 @@
-@startuml
-package "ts_ofc" #DDDDDD {
+classDiagram
+namespace ts_ofc {
   class OFCCalculation
 }
 
@@ -10,4 +10,3 @@ CloseLoopTask o-- OpdMetrology
 CloseLoopTask *-- ObsMetadata
 ImsimCmpt *-- ObsMetadata
 ImsimCmpt o-- OpdMetrology
-@enduml

doc/versionHistory.rst

@@ -5,6 +5,23 @@
 ##################
 Version History
 ##################
+-------------
+1.5.5
+-------------
+
+* Move class diagrams to mermaid from plantUML.
+
+-------------
+1.5.4
+-------------
+
+* Fix default pointer names in _generate_images.
+
+-------------
+1.5.3
+-------------
+
+* Fix wfs test file source positions, column names, sky_file kwarg.
 
 -------------
 1.5.2

python/lsst/ts/imsim/closed_loop_task.py

@@ -616,9 +616,9 @@ def _generate_images(
             if cam_type == CamType.LsstCam:
                 default_pointer = "lsstCamDefaultPointer.yaml"
             elif cam_type == CamType.LsstFamCam:
-                default_pointer = "lsstFamCamDefaultPointer.yaml"
+                default_pointer = "lsstFamNoPertPointer.yaml"
             elif cam_type == CamType.ComCam:
-                default_pointer = "lsstComCamDefaultPointer.yaml"
+                default_pointer = "lsstComCamNoPertPointer.yaml"
             imsim_config_pointer_file = os.path.join(get_config_dir(), default_pointer)
 
         base_config_yaml = self.imsim_cmpt.assemble_config_yaml(
@@ -1423,7 +1423,8 @@ def set_img_parser(parser: ArgumentParser) -> ArgumentParser:
             help="""
                  Text file contains the star Id, ra, dec, and magnitude.
                  The default is to use the OPD field positions with boresight
-                 [ra, dec] = [0, 0].
+                 [ra, dec] = [0, 0]. The file header must include column names
+                 Id, Ra, Dec, Mag. For example, see tests/testData/sky/wfsStar.txt.
                  """,
         )
 

tests/testData/sky/wfsSglStar.txt

@@ -1,2 +1,2 @@
-# Id      Ra      Decl        Mag
+# Id      Ra      Dec        Mag
 0     1.196    1.176       17.0

tests/testData/sky/wfsStar.txt

@@ -1,9 +1,9 @@
-# Id      Ra      Decl        Mag
-0     1.216    1.176       15.0
-1     1.156    1.176       15.0
-2    -1.176    1.216       15.0
-3    -1.176    1.156       15.0
-4    -1.156   -1.176       15.0
-5    -1.216   -1.176       15.0
-6     1.176   -1.156       15.0
-7     1.176   -1.216       15.0
+# Id	 Ra		 Dec		 Mag
+0	 358.364396	 0.092143	 15.000000
+1	 358.280905	 0.190845	 15.000000
+2	 0.092143	 1.635604	 15.000000
+3	 0.190845	 1.719095	 15.000000
+4	 359.907857	 -1.635604	 15.000000
+5	 359.809155	 -1.719095	 15.000000
+6	 1.635604	 -0.092143	 15.000000
+7	 1.719095	 -0.190845	 15.000000

tests/test_sky_sim.py

@@ -54,8 +54,8 @@ def test_add_star_by_file(self):
 
         ra = self.sky_sim.ra
         dec = self.sky_sim.dec
-        self.assertEqual(ra[2], -1.176)
-        self.assertEqual(dec[2], 1.216)
+        self.assertEqual(ra[2], 0.092143)
+        self.assertEqual(dec[2], 1.635604)
 
         self.assertEqual(self.sky_sim.mag[2], 15.0)