Add 1ka verification case

[lkadz]

(Ref. #12)

EDIT: @Lee01Atom, you had the issue number in the comments, so it did not show. I just fixed it.

[simopier]

Thank you for your contribution, @Lee01Atom!

The tests currently fail because your commit messages do not reference an existing issue:

##########################################################################
ERROR: Your patch does not contain a valid ticket reference! (i.e. #1234)
Merge branch 'devel' of https://github.com/Lee01Atom/TMAP8 into test
add  ver-1ka

ERROR: The following files do not contain a newline character before EOF:
	test/tests/ver-1ka/ver-1ka.i

Run the "delete_trailing_whitespace.sh" script in your $MOOSE_DIR/scripts directory.
##########################################################################

to solve it, follow the instructions from the "contributing to TMAP8" page :

Now enter a short description of the commit [...] At the bottom, you should add (Ref. #<ISSUE_NUMBER>)

Right now, you should be able to run: git commit --amend and update the commit message to add the issue number. In that case:

(Ref. #12)

[simopier]

@Lee01Atom, this is very quick first take looking at the main missing pieces, not a thorough review yet:

• you should also add a documentation page (.md) that describes the case. you can find examples in projects/TMAP8/doc/content/verification_and_validation/
• You should also add a test file that will run the test. You can find examples in the other V&V cases.
• as explained above, you need your commit message to list the issue number.

These requirements are (in part) what ensure that TMAP8 remains Nuclear Quality Assurance, level 1 compliant. It takes a bit of time to get used to this way of doing code development, but thorough documentation and rigorous testing are key to high software quality assurance. It helps build trust in TMAP8.

Please let me know if you have any questions.

[moosebuild]

Job Documentation, step Sync to remote on f3dc432 wanted to post the following:

View the site here

This comment will be updated on new commits.

[simopier]

Preliminary review with some comments and suggestions.

[simopier]

Add in-code comments

[simopier]

Look at other .py files for up to date practices:

• Automatic figure generation
• calculate RSMPE

[simopier]

Add test case to run the python script.
Example:

[ver-1a_comparison]
    type = RunCommand
    command = 'python3 comparison_ver-1a.py'
    requirement = 'The system shall be able to generate comparison plots between the analytical solution and simulated solution of verification case 1a, modeling species diffusion through a structure, originating from a depleting source enclosure.'
    required_python_packages = 'matplotlib numpy pandas os'
  []

[simopier]

We now use a different approach to ensure the figures are automatically generated by the documentation. Here is an example:

!media comparison_ver-1g.py
       image_name=ver-1g_comparison_equal_conc.png
       style=width:50%;margin-bottom:2%;margin-left:auto;margin-right:auto
       id=ver-1g_comparison_equal_conc
       caption=Comparison of concentration of AB as a function of time calculated through TMAP8 and analytically for the case when A and B have equal concentrations.

[simopier]

Cleaning this up was a challenge, so another PR was opened to replace this one. See #183.