Merge branch 'develop'

Jenkinsfile

@@ -35,8 +35,6 @@ pipeline {
         XML_REPORT = "jenkinsReport/report.xml"
         // Module name used in the pytest coverage analysis
         MODULE_NAME = "lsst.ts.wep"
-        // PlantUML url
-        PLANTUML_URL = "https://github.com/plantuml/plantuml/releases/download/v1.2021.13/plantuml-1.2021.13.jar"
         // Authority to publish the document online
         user_ci = credentials('lsst-io')
         LTD_USERNAME = "${user_ci_USR}"
@@ -117,8 +115,6 @@ pipeline {
                 def RESULT = sh returnStatus: true, script: """
                   source ${env.LSST_STACK}/loadLSST.bash
 
-                  curl -L ${env.PLANTUML_URL} -o plantuml.jar
-
                   pip install sphinxcontrib-plantuml
 
                   cd ts_wep

doc/conf.py

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

doc/developer-guide/developer-guide.rst

@@ -44,7 +44,7 @@ wep
 
 This module is a high-level module to use other modules.
 
-.. uml:: ../uml/wepClass.uml
+.. mermaid:: ../uml/wepClass.mmd
     :caption: Class diagram of wep
 
 * **Instrument**: Class that defines the geometry, mask model, Batoid model, etc. for different telescopes.
@@ -58,7 +58,7 @@ This module is a high-level module to use other modules.
 wep.centroid
 -------------
 
-.. uml:: ../uml/centroidClass.uml
+.. mermaid:: ../uml/centroidClass.mmd
     :caption: Class diagram of wep.centroid
 
 This module finds the centroids of donuts.
@@ -74,7 +74,7 @@ This module finds the centroids of donuts.
 wep.estimation
 -------------
 
-.. uml:: ../uml/estimationClass.uml
+.. mermaid:: ../uml/estimationClass.mmd
     :caption: Class diagram of wep.estimation
 
 This module estimates the wavefront error.
@@ -91,7 +91,7 @@ wep.deblend
 
 This module does the image deblending.
 
-.. uml:: ../uml/deblendClass.uml
+.. mermaid:: ../uml/deblendClass.mmd
     :caption: Class diagram of wep.deblend
 
 * **DeblendDonutFactory**: Factory for creating the deblend donut object to deblend the bright star donut from neighboring stars.
@@ -106,7 +106,7 @@ wep.task
 
 This module has the tasks to run WEP as a pipeline with Gen 3 LSST DM middleware.
 
-.. uml:: ../uml/taskClass.uml
+.. mermaid:: ../uml/taskClass.mmd
     :caption: Class diagram of wep.task
 
 * **GenerateDonutDirectDetectTaskConnections**: Connections setup for GenerateDonutDirectDetectTask to run in a pipeline with Gen 3 middleware.

doc/uml/centroidClass.uml → doc/uml/centroidClass.mmd

@@ -1,9 +1,9 @@
-@startuml
+classDiagram
+
 CentroidDefault <|-- CentroidRandomWalk
 CentroidDefault <|-- CentroidOtsu
 CentroidDefault <|-- CentroidConvolveTemplate
 CentroidFindFactory ..> CentroidRandomWalk
 CentroidFindFactory ..> CentroidOtsu
 CentroidFindFactory ..> CentroidConvolveTemplate
 CentroidConvolveTemplate *-- CentroidRandomWalk
-@enduml

doc/uml/deblendClass.uml → doc/uml/deblendClass.mmd

@@ -1,6 +1,7 @@
-@startuml
-class nelderMeadModify << (F,orchid) >>
+classDiagram
+
+class nelderMeadModify
+<<function>> nelderMeadModify
 DeblendDefault <|-- DeblendAdapt
 DeblendDonutFactory ..> DeblendAdapt
 DeblendAdapt ..> nelderMeadModify
-@enduml

doc/uml/estimationClass.uml → doc/uml/estimationClass.mmd

@@ -1,5 +1,5 @@
-@startuml
+classDiagram
+
 WfAlgorithm <|-- TieAlgorithm
 WfAlgorithmFactory ..> TieAlgorithm
 WfEstimator *-- WfAlgorithmFactory
-@enduml

doc/uml/taskClass.uml → doc/uml/taskClass.mmd

@@ -1,4 +1,5 @@
-@startuml
+classDiagram
+
 class RefCatalogInterface
 CombineZernikesBaseTask <|-- CombineZernikesMeanTask
 CombineZernikesBaseTask <|-- CombineZernikesSigmaClipTask
@@ -45,4 +46,3 @@ GenerateDonutFromRefitWcsTask *-- GenerateDonutFromRefitWcsTaskConfig
 GenerateDonutCatalogWcsTask <|-- GenerateDonutFromRefitWcsTask
 ExposurePairer *-- ExposurePairerConfig
 TablePairer *-- TablePairerConfig
-@enduml

doc/uml/wepClass.uml → doc/uml/wepClass.mmd

@@ -1,8 +1,8 @@
-@startuml
+classDiagram
+
 class DonutImageCheck
 class DonutDetector
 class Instrument
 class Image
 ImageMapper *-- Instrument
 ImageMapper *-- Image
-@enduml

doc/versionHistory.rst

@@ -6,6 +6,14 @@
 Version History
 ##################
 
+.. _lsst.ts.wep-9.5.6:
+
+-------------
+9.5.6
+-------------
+
+* Move class diagrams to mermaid from plantUML.
+
 .. _lsst.ts.wep-9.5.5:
 
 -------------