Skip to content

Commit

Permalink
Address Casey's review
Browse files Browse the repository at this point in the history
better English
use "the system shall" consistently
fix some requirements that were missing text

Co-authored-by: Casey Icenhour <[email protected]>
  • Loading branch information
GiudGiud and cticenhour committed Apr 17, 2024
1 parent 18e5616 commit 4157e1a
Show file tree
Hide file tree
Showing 31 changed files with 58 additions and 67 deletions.
2 changes: 1 addition & 1 deletion python/chigger/tests/color/tests
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
command = color.py
imagediff = color.png
display_required = true
requirement = 'The system shall be able to specify a RGB color to display the mesh with.'
requirement = 'The system shall be able to specify an RGB color to display the mesh with.'
[]
[]
26 changes: 13 additions & 13 deletions python/chigger/tests/colorbar/tests
Original file line number Diff line number Diff line change
Expand Up @@ -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
[]

Expand All @@ -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
[]
[]
2 changes: 1 addition & 1 deletion python/chigger/tests/geometric/line_source/tests
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
command = line_source_data_tube.py
imagediff = 'line_source_data_tube.png'
display_required = true
requirement = "The system shall be able to plot lines as a thicc tube with data represented with colors along the line."
requirement = "The system shall be able to plot lines as a thick tube with data represented with colors along the line."
[]
[]
4 changes: 2 additions & 2 deletions python/chigger/tests/global_data/tests
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
command = plot_global_data.py
imagediff = 'plot_global_data.png'
display_required = true
requirement = "The system shall be able to draw line plots from field data."
requirement = "The system shall be able to draw line plots from global data."
[]

[plot_current_global_data]
Expand All @@ -31,6 +31,6 @@
imagediff = 'plot_current_global_data_0.png plot_current_global_data_4.png plot_current_global_data_9.png'
allowed_linux = 0.95
display_required = true
requirement = "The system shall be able to draw line plots from field data at various time steos."
requirement = "The system shall be able to draw line plots from global data at various time steps."
[]
[]
4 changes: 2 additions & 2 deletions python/chigger/tests/graphs/tests
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
allowed_darwin = 0.94
allowed_linux = 0.96
display_required = true
requirement = 'The system shall be able two series XY data in a graph with different Y axis.'
requirement = 'The system shall be able to plot two series XY data in a graph with different Y axis.'
[]
[dualx]
type = ImageDiff
Expand All @@ -17,6 +17,6 @@
allowed_linux = 0.96
allowed_darwin = 0.94
display_required = true
requirement = 'The system shall be able two series XY data in a graph with different X axis.'
requirement = 'The system shall be able to plot two series XY data in a graph with different X axis.'
[]
[]
18 changes: 9 additions & 9 deletions python/chigger/tests/line/tests
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
imagediff = 'line.png'
allowed_linux = 0.97
allowed_darwin = 0.94
requirement = 'Chigger shall provide a line plot widget'
requirement = 'The system shall provide a line plot widget'
display_required = true
[]

Expand All @@ -17,7 +17,7 @@
imagediff = 'single_point.png'
allowed_linux = 0.97
allowed_darwin = 0.94
requirement = 'Chigger shall provide a scatter plot widget'
requirement = 'The system shall provide a scatter plot widget'
display_required = true
[]

Expand All @@ -26,7 +26,7 @@
command = empty.py
imagediff = 'empty.png'
allowed_linux = 0.935
requirement = 'An empty graph shall be a valid chigger widget'
requirement = 'The system shall allow an empty graph to be a valid widget'
display_required = true
[]

Expand All @@ -35,7 +35,7 @@
command = color.py
imagediff = 'color.png'
allowed_linux = 0.94
requirement = 'Chigger shall provide the capability to assign colors to curves in a graph'
requirement = 'The system shall provide the capability to assign colors to curves in a graph'
display_required = true
[]

Expand All @@ -45,7 +45,7 @@
imagediff = 'legend.png'
allowed_linux = 0.94
allowed_darwin = 0.96
requirement = 'Chigger shall provide an optional legend widget for curves in a graph'
requirement = 'The system shall provide an optional legend widget for curves in a graph'
display_required = true
[]

Expand All @@ -55,7 +55,7 @@
imagediff = 'legend_viewport.png'
allowed_linux = 0.94
allowed_darwin = 0.96
requirement = 'Chigger shall scale the legend position relative to the graph viewport'
requirement = 'The system shall scale the legend position relative to the graph viewport'
display_required = true
[]

Expand All @@ -64,7 +64,7 @@
command = update.py
imagediff = 'update_0.png update_1.png update_2.png update_3.png update_4.png update_5.png'
allowed_linux = 0.93
requirement = 'Chigger shall provide a capability for incremental curves updates in a graph'
requirement = 'The system shall provide a capability for incremental curves updates in a graph'
display_required = true
[]

Expand All @@ -74,7 +74,7 @@
imagediff = 'secondary_initial.png secondary_0.png secondary_1.png secondary_2.png secondary_3.png'
allowed_linux = 0.97
allowed_darwin = 0.95
requirement = 'Chigger shall provide a capability for multiple curves and secondary axis in a graph'
requirement = 'The system shall provide a capability for multiple curves and secondary axis in a graph'
display_required = true
[]

Expand All @@ -84,7 +84,7 @@
imagediff = 'tracer_1.png tracer_3.png tracer_5.png'
allowed_darwin = 0.97
allowed_linux = 0.96
requirement = 'Chigger shall provide a tracer line indicator capability'
requirement = 'The system shall provide a tracer line indicator capability'
display_required = true
[]
[]
6 changes: 3 additions & 3 deletions python/chigger/tests/line_sample/tests
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
imagediff = 'line_sample_default.png'
allowed = 0.94
display_required = true
requirement = 'The system shall be able to sample field data in simulation results and plot it in a XY plot with default parameters.'
requirement = 'The system shall be able to sample field data in simulation results and plot it in an XY plot with default parameters.'
[]

[line_sample]
Expand All @@ -17,7 +17,7 @@
expect_out = '0.049\d*\s0.400' # Test the the sampled values are present
allowed = 0.92
display_required = true
requirement = 'The system shall be able to sample field data in simulation results and plot it in a XY plot.'
requirement = 'The system shall be able to sample field data in simulation results and plot it in an XY plot.'
[]

[line_sample_elem]
Expand All @@ -26,7 +26,7 @@
imagediff = 'line_sample_elem.png'
allowed = 0.96
display_required = true
requirement = 'The system shall be able to sample elemental field data in simulation results and plot it in a XY plot.'
requirement = 'The system shall be able to sample elemental field data in simulation results and plot it in an XY plot.'
[]

[line_sample_error]
Expand Down
2 changes: 1 addition & 1 deletion python/chigger/tests/multiapps/tests
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
command = multiapp.py
imagediff = 'multiapp.png'
display_required = true
requirement = 'The system shall be able to plot multiple multiapps results in the same plot.'
requirement = 'The system shall be able to plot multiple MultiApp results in the same plot.'
[]
[]
8 changes: 4 additions & 4 deletions python/chigger/tests/range/tests
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,31 @@
allowed_linux = 0.97
allowed_darwin = 0.97
display_required = true
requirement = "The system shall be able to plot colormaps and specifying the minimum value in the colormap."
requirement = "The system shall be able to plot colormaps and allow specification of the minimum value in the colormap."
[]

[max]
type = ImageDiff
command = max.py
imagediff = 'max_0.png max_1.png'
display_required = true
requirement = "The system shall be able to plot colormaps and specifying the maximum value in the colormap."
requirement = "The system shall be able to plot colormaps and allow specification of the maximum value in the colormap."
[]

[minmax]
type = ImageDiff
command = minmax.py
imagediff = 'minmax_0.png minmax_1.png'
display_required = true
requirement = "The system shall be able to plot colormaps and specifying the minimum and the maximum value in the colormap."
requirement = "The system shall be able to plot colormaps and allow specification of the minimum and the maximum value in the colormap."
[]

[range]
type = ImageDiff
command = range.py
imagediff = 'range_0.png range_1.png'
display_required = true
requirement = "The system shall be able to plot colormaps and specifying the minimum and the maximum value in the colormap for multiple time steps."
requirement = "The system shall be able to plot colormaps and allow specification of the minimum and the maximum value in the colormap for multiple time steps."
[]

[auto]
Expand Down
2 changes: 1 addition & 1 deletion python/chigger/tests/rotational_extrusion/tests
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
imagediff = rotational_extrusion.png
design = 'chigger/index.md'
issues = '#12128'
requirement = "Chigger shall include the ability to rotate and extrude a 2D ExodusII result."
requirement = "The system shall include the ability to rotate and extrude a 2D ExodusII result."
display_required = true
[]
[]
9 changes: 0 additions & 9 deletions python/chigger/tests/speed/speed.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,12 @@
if os.getenv('MOOSE_DIR') == None:
mooseutils.mooseError("MOOSE_DIR must be set in this script")

# filename = os.path.join(os.getenv('MOOSE_DIR'), 'modules', 'phase_field', 'examples', 'grain_growth', 'grain_growth_2D_graintracker_out.e')
filename = os.path.join(os.getenv('MOOSE_DIR'), 'modules', 'phase_field', 'test', 'tests', 'grain_growth', 'gold', 'test_out.e-s005')
variables = ['bnds']
blocks = ['0']
N = 10
#filename = os.path.join(os.getenv('MOOSE_DIR'), '..', 'relap-7', 'pkl_1loop_out_displaced.e')
#variables = ['alpha_liquid']
#block = ['Pipe20']
#N =1
reader = chigger.exodus.ExodusReader(filename, timestep=0)

#reader.update()
#print reader.getVariableInformation()
#print reader.getBlockInformation()

def read_all_times(prefix=''):
start_time = time.time()
for i in range(N):
Expand Down
2 changes: 1 addition & 1 deletion python/chigger/tests/viewports/tests
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
command = viewports.py
imagediff = 'viewports.png'
display_required = true
requirement = 'The system shall be able to specify the coordinates of a view port in the results.'
requirement = 'The system shall be able allow the user to specify the coordinates of a view port in the results.'
[]
[]
2 changes: 1 addition & 1 deletion python/chigger/tests/writers/tests
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
input = writers.py
buffer = True
display_required = true
requirement = 'The system shall be able to write plot with various formats, and error if an unsupported format is requested.'
requirement = 'The system shall be able to write a plot with various formats, and error if an unsupported format is requested.'
[]
[]
4 changes: 2 additions & 2 deletions python/parameters/test/tests
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
[Parameter]
type = PythonUnitTest
input = test_Parameter.py
requirement = "The system shall be able to define parameters in Python, similar to individual MooseObject parameters in C++, with numerous similar capabilities, including a name, a type, allowed and default values, descriptions, required and private status."
requirement = "The system shall be able to define parameters and associated metadata in Python that allows for type-checking, restrictions, defaults, verification, and documentation."
[]
[InputParameters]
type = PythonUnitTest
input = test_InputParameters.py
requirement = "The system shall be able to define groups of parameters to Python objects, similar to the parameters of a MooseObject in C++, with numerous similar capabilities, including parameter errors, the ability to retrieve parameters, to set defaults, and others."
requirement = "The system shall have a warehouse and capability to manage groups of parameters in Python objects, including parameter errors and the ability to retrieve and set parameters, to set defaults, and to validate parameters."
[]
[]
2 changes: 1 addition & 1 deletion python/peacock/tests/base/tests
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
type = RunApp
command = test_PeacockCollapsibleWidget.py
display_required = true
requirement = 'The system shall have a graphical user interface which supports collapside widgets.'
requirement = 'The system shall have a graphical user interface which supports collapsible widgets.'
[]
[]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
type = PythonUnitTest
input = test_ConsoleOutputViewerPlugin.py
display_required = true
requirement = "The system shall include a graphical interface that display scrollable and auto-scrollable console output."
requirement = "The system shall include a graphical interface that displays scrollable and auto-scrollable console output."
[]
[]
Loading

0 comments on commit 4157e1a

Please sign in to comment.