Merge pull request #27070 from GiudGiud/PR_sqa_python

Add missing SQA doco for python packages

python/chigger/tests/adapt/tests

@@ -1,8 +1,11 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [adapt_steps]
     type = ImageDiff
     command = adapt.py
     imagediff = 'adapt_0.png adapt_4.png adapt_9.png'
     display_required = true
+    requirement = 'The system shall be able to load results of simulations with mesh h-adaptivity and output them to images.'
   []
 []

python/chigger/tests/annotations/tests

@@ -1,9 +1,12 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [image]
     # Test displaying an image
     type = ImageDiff
     command = image_annotation.py
     imagediff = 'image_annotation.png'
+    requirement = 'The system shall be able to display an image without an annotation.'
 
     display_required = true
   []
@@ -13,6 +16,7 @@
     type = ImageDiff
     command = logo_annotation.py
     imagediff = 'logo_annotation.png'
+    requirement = 'The system shall be able to display an image with a logo annotation on it.'
 
     display_required = true
   []
@@ -22,6 +26,7 @@
     type = ImageDiff
     command = text_annotation.py
     imagediff = 'text_annotation.png'
+    requirement = 'The system shall be able to display an image with a text annotation on it.'
 
     display_required = true
   []
@@ -31,6 +36,7 @@
     type = ImageDiff
     command = time_annotation.py
     imagediff = 'time_annotation.png'
+    requirement = 'The system shall be able to display an image with the time annotated on it.'
 
     display_required = true
   []
@@ -40,6 +46,7 @@
     type = ImageDiff
     command = time_annotation_change.py
     imagediff = 'time_annotation_change_0.png time_annotation_change_9.png'
+    requirement = 'The system shall be able to display an image with the time elapsed annotated on it.'
 
     display_required = true
   []

python/chigger/tests/background/tests

@@ -1,14 +1,18 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [solid]
     type = ImageDiff
     command = background.py
     imagediff = background.png
     display_required = true
+    requirement = "The system shall be able to display a solid background."
   []
   [gradient]
     type = ImageDiff
     command = gradient.py
     imagediff = gradient.png
     display_required = true
+    requirement = "The system shall be able to display a color gradient background."
   []
 []

python/chigger/tests/chigger/tests

@@ -1,7 +1,10 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [command_line]
     type = PythonUnitTest
     input = test_chigger.py
     display_required = true
+    requirement = "The system shall be able to execute the chigger command, display ExodusII file information and convert images to movies."
   []
 []

python/chigger/tests/clipping/tests

@@ -1,50 +1,59 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [plane]
     type = ImageDiff
     command = clip.py
     imagediff = 'clip.png'
     display_required = true
+    requirement = "The system shall be able to clip the display of simulation results with the default plane (normal to X axis)."
   []
 
   [plane_elem_var]
     type = ImageDiff
     command = clip_elem.py
     imagediff = 'clip_elem.png'
     display_required = true
+    requirement = "The system shall be able to clip the display of an auxiliary variable in the simulation results with the default plane (normal to X axis)."
   []
 
   [clip_z]
     type = ImageDiff
     command = clip_z.py
     imagediff = 'clip_z.png'
     display_required = true
+    requirement = "The system shall be able to clip the display of simulation results with a plane normal to the Z-axis."
   []
 
   [dual]
     type = ImageDiff
     command = dual.py
     imagediff = dual.png
     display_required = true
+    requirement = "The system shall be able to clip the display of simulation results with two different planes."
   []
 
   [box]
     type = ImageDiff
     command = box_clip.py
     imagediff = 'box_clip.png'
     display_required = true
+    requirement = "The system shall be able to clip the display of simulation results with planes forming a box."
   []
 
   [dynamic]
     type = ImageDiff
     command = clip_change.py
     imagediff = 'clip_change0.png clip_change1.png clip_change2.png'
     display_required = true
+    requirement = "The system shall be able to clip the display of simulation results by moving a clipping plane on every time step."
   []
 
   [multiple]
     type = ImageDiff
     command = multiple_clips.py
     imagediff = 'multiple_clips.png'
     display_required = true
+    requirement = "The system shall be able to display multiple simulations results clipped by different planes."
   []
 []

python/chigger/tests/color/tests

@@ -1,8 +1,11 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [test]
     type = ImageDiff
     command = color.py
     imagediff = color.png
     display_required = true
+    requirement = 'The system shall be able to specify an RGB color to display the mesh with.'
   []
 []

python/chigger/tests/colorbar/tests

@@ -5,95 +5,95 @@
     type = ImageDiff
     command = colorbar.py
     imagediff = 'colorbar.png'
-    requirement = "Chigger shall include a colorbar object that can be oriented vertically."
+    requirement = "The system shall include a colorbar object that can be oriented vertically."
     display_required = true
   []
 
   [standalone_horiz]
     type = ImageDiff
     command = colorbar_horiz.py
     imagediff = 'colorbar_horiz.png'
-    requirement = "Chigger shall include a colorbar object that can be oriented horizontally."
+    requirement = "The system shall include a colorbar object that can be oriented horizontally."
     display_required = true
   []
 
   [exdous_default]
     type = ImageDiff
     command = exodus_colorbar.py
     imagediff = 'exodus_colorbar.png'
-    requirement = "Chigger shall include a colorbar object that captures range and colormap data from an Exodus result."
+    requirement = "The system shall include a colorbar object that captures range and colormap data from an Exodus result."
     display_required = true
   []
 
   [left]
     type = ImageDiff
     command = colorbar_left.py
     imagediff = 'colorbar_left.png'
-    requirement = "The chigger colorbar shall support placing the tick marks on the left-side of a vertical oriented colorbar."
+    requirement = "The The system colorbar shall support placing the tick marks on the left-side of a vertical oriented colorbar."
     display_required = true
   []
 
   [top]
     type = ImageDiff
     command = colorbar_top.py
     imagediff = 'colorbar_top.png'
-    requirement = "The chigger colorbar shall support placing the tick marks on the top of a horizontal oriented colorbar."
+    requirement = "The The system colorbar shall support placing the tick marks on the top of a horizontal oriented colorbar."
     display_required = true
   []
 
   [bottom]
     type = ImageDiff
     command = colorbar_bottom.py
     imagediff = 'colorbar_bottom.png'
-    requirement = "The chigger colorbar shall support placing the tick marks on the bottom of a horizontal oriented colorbar."
+    requirement = "The The system colorbar shall support placing the tick marks on the bottom of a horizontal oriented colorbar."
     display_required = true
   []
 
   [common]
     type = ImageDiff
     command = common_colorbar.py
     imagediff = 'common_colorbar.png'
-    requirement = "Chigger shall include a colorbar object oriented vertically that captures range and colormap data from two Exodus results."
+    requirement = "The system shall include a colorbar object oriented vertically that captures range and colormap data from two Exodus results."
     display_required = true
   []
 
   [common_horiz]
     type = ImageDiff
     command = common_colorbar_horiz.py
     imagediff = 'common_colorbar_horiz.png'
-    requirement = "Chigger shall include a colorbar object oriented horizontally that captures range and colormap data from two Exodus results."
+    requirement = "The system shall include a colorbar object oriented horizontally that captures range and colormap data from two Exodus results."
     display_required = true
   []
 
   [dual]
     type = ImageDiff
     command = dual_colorbar.py
     imagediff = 'dual_colorbar.png'
-    requirement = "Chigger shall support vertical colorbars associated with Exodus results within a viewport."
+    requirement = "The system shall support vertical colorbars associated with Exodus results within a viewport."
     display_required = true
   []
 
   [dual_horiz]
     type = ImageDiff
     command = dual_colorbar_horiz.py
     imagediff = 'dual_colorbar_horiz.png'
-    requirement = "Chigger shall support horizontal colorbars associated with Exodus results within a viewport."
+    requirement = "The system shall support horizontal colorbars associated with Exodus results within a viewport."
     display_required = true
   []
 
   [font]
     type = ImageDiff
     command = colorbar_font.py
     imagediff = 'colorbar_font.png'
-    requirement = "The chigger colorbar shall support the ability to change the font size of the tick labels."
+    requirement = "The The system colorbar shall support the ability to change the font size of the tick labels."
     display_required = true
   []
 
   [zero_range]
     type = ImageDiff
     command = zero_range.py
     imagediff = 'zero_range.png'
-    requirement = "The chigger colorbar shall handle range values that do not differ in value."
+    requirement = "The The system colorbar shall handle range values that do not differ in value."
     display_required = true
   []
 
@@ -102,7 +102,7 @@
     command = precision_with_wrong_notation.py
     expect_out = "When using 'precision' option, 'notation' option has to be set to either 'scientific' or 'fixed'"
     match_literal = true
-    requirement = "The chigger colorbar shall error when the 'notation' and 'precision' settings are incongruent."
+    requirement = "The The system colorbar shall error when the 'notation' and 'precision' settings are incongruent."
     display_required = true
   []
 []

python/chigger/tests/colormap/tests

@@ -1,10 +1,13 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [matplotlib]
     # Tests that matplotlib colormaps are loaded
     type = ImageDiff
     command = colormap.py
     imagediff = colormap.png
     display_required = true
+    requirement = "The system shall be able to draw a colormap from simulation results."
   []
 
   [number]
@@ -13,26 +16,30 @@
     command = colormap_number.py
     imagediff = colormap_number.png
     display_required = true
+    requirement = "The system shall be able to draw a colormap with a user-specified number of colors from simulation results."
   []
 
   [reverse_matplotlib]
     type = ImageDiff
     command = reverse.py
     imagediff = reverse.png
     display_required = true
+    requirement = "The system shall be able to draw a colormap with inverted colors from simulation results."
   []
 
   [reverse_xml]
     type = ImageDiff
     command = reverse_xml.py
     imagediff = reverse_xml.png
     display_required = true
+    requirement = "The system shall be able to draw a colormap with inverted colors and a 'shock' color scheme from simulation results."
   []
 
   [reverse_default]
     type = ImageDiff
     command = reverse_default.py
     imagediff = reverse_default.png
     display_required = true
+    requirement = "The system shall be able to draw a colormap with inverted colors and the default color scheme from simulation results."
   []
 []

python/chigger/tests/contours/tests

@@ -1,11 +1,14 @@
 [Tests]
+  issues = '#8661'
+  design = 'chigger/index.md'
   [default]
     # Test contour object with default settings
     type = ImageDiff
     command = default.py
     imagediff = 'default.png'
     allowed_linux = 0.97
     display_required = true
+    requirement = "The system shall be able to create contour plots with the default settings."
   []
 
   [blocks]
@@ -14,13 +17,15 @@
     command = block.py
     imagediff = 'block.png'
     display_required = true
+    requirement = "The system shall be able to create contour plots with block-restricted contours."
   []
 
   [block_elem]
     type = RunException
     command = block_elem.py
     expect_err = "ContourFilter currently only works with nodal variables."
     display_required = true
+    requirement = "The system shall error if contouring plots are requested for plotting nodal variables."
   []
 
   [levels]
@@ -29,6 +34,7 @@
     command = levels.py
     imagediff = 'levels.png'
     display_required = true
+    requirement = "The system shall be able to create contour plots with user-specified contour levels."
   []
 
   [combo]
@@ -37,6 +43,7 @@
     command = combo.py
     imagediff = 'combo.png'
     display_required = true
+    requirement = "The system shall be able to create plots that feature both a volume plot and a contour plot."
   []
 
   [inline]
@@ -45,12 +52,14 @@
     imagediff = 'inline.png'
     allowed_linux = 0.97
     display_required = true
+    requirement = "The system shall be able to create contour plots without the colorbar."
   []
 
   [inline_clip]
     type = ImageDiff
     command = inline_clip.py
     imagediff = 'inline_clip.png'
     display_required = true
+    requirement = "The system shall be able to create contour plots clipped using a plane."
   []
 []