idaholab / TMAP8

Tritium Migration Analysis Program, Version 8
https://mooseframework.inl.gov/TMAP8/
GNU Lesser General Public License v2.1
15 stars 21 forks source link

Update documentation to generate result figures automatically #174

Closed lin-yang-ly closed 2 months ago

lin-yang-ly commented 2 months ago

The python scripts and documentations of V&V cases are updated to generate figures automatically on documentation.

(Refs #168)

lin-yang-ly commented 2 months ago

The PR is ready for review! @simopier Could you add @chaibhave as a reviewer? Thank you!

moosebuild commented 2 months ago

Job Documentation on 437c3c2 wanted to post the following:

View the site here

This comment will be updated on new commits.

moosebuild commented 2 months ago

Job Coverage on 437c3c2 wanted to post the following:

Coverage

Coverage did not change

Full coverage report

This comment will be updated on new commits.

simopier commented 2 months ago

You are getting the following errors in Apptainer:


ver-1g.ver-1g_comparison: Working Directory: /tmp/tmap8test.WvHFXB/tests/tmap8/tests/tests/ver-1g
ver-1g.ver-1g_comparison: Running command: python3 comparison_ver-1g.py
ver-1g.ver-1g_comparison: Traceback (most recent call last):
ver-1g.ver-1g_comparison:   File "/tmp/tmap8test.WvHFXB/tests/tmap8/tests/tests/ver-1g/comparison_ver-1g.py", line 20, in <module>
ver-1g.ver-1g_comparison:     tmap_sol = pd.read_csv(os.path.join(git.Repo('.',search_parent_directories=True).working_tree_dir, "test/tests/ver-1g/gold/diff_conc_TMAP4_out.csv"))
ver-1g.ver-1g_comparison:   File "/opt/miniforge3/envs/moose/lib/python3.10/site-packages/git/repo/base.py", line 289, in __init__
ver-1g.ver-1g_comparison:     raise InvalidGitRepositoryError(epath)
ver-1g.ver-1g_comparison: git.exc.InvalidGitRepositoryError: /tmp/tmap8test.WvHFXB/tests/tmap8/tests/tests/ver-1g
ver-1g.ver-1g_comparison: 
ver-1g.ver-1g_comparison: ################################################################################
ver-1g.ver-1g_comparison: Tester failed, reason: CODE 1
ver-1g.ver-1g_comparison: 
[1.146s]     FAIL ver-1g.ver-1g_comparison FAILED (CODE 1) [previous results: CODE 1]

Final Test Results:
--------------------------------------------------------------------------------------------------------------
[0.840s]       OK ver-1fa.ver-1fa [re-running]
[1.376s]       OK ver-1fd.ver-1fd [re-running]
[0.000s]       OK ver-1fd.ver-1fd_csv [re-running]
[2.590s]       OK ver-1gc.ver-1gc [re-running]
[3.067s]       OK ver-1ja.ver-1ja_csvdiff [re-running]
[0.000s]       OK ver-1gc.ver-1gc_csv [re-running]
[3.652s]       OK ver-1ha.ver-1ha_csv [re-running]
[3.780s]       OK ver-1fc.ver-1fc [re-running]
[3.801s]       OK ver-1g.binary_reaction_equal_concentrations [re-running]
[0.000s]       OK ver-1fc.ver-1fc_csvdiff_transient [re-running]
[0.000s]       OK ver-1fc.ver-1fc_csvdiff_steady_state [re-running]
[2.716s]       OK ver-1g.binary_reaction_diff_concentrations_TMAP4 [re-running]
[9.566s]       OK ver-1c.ver-1c [re-running]
[0.000s]       OK ver-1c.ver-1c_csvdiff [re-running]
[3.198s]       OK ver-1g.binary_reaction_diff_concentrations_TMAP7 [re-running]
[1.450s]     FAIL ver-1fa.ver-1fa_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.082s]     FAIL ver-1fd.ver-1fd_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.168s]     FAIL ver-1ja.ver-1ja_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.335s]     FAIL ver-1gc.ver-1gc_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.237s]     FAIL ver-1ha.ver-1ha_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.124s]     FAIL ver-1fc.ver-1fc_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.078s]     FAIL ver-1c.ver-1c_comparison FAILED (CODE 1) [previous results: CODE 1]
[1.146s]     FAIL ver-1g.ver-1g_comparison FAILED (CODE 1) [previous results: CODE 1]
simopier commented 2 months ago

You need to list an issue number in one of your commit message:

##########################################################################
ERROR: Your patch does not contain a valid ticket reference! (i.e. #1234)
Merge branch 'doc_auto_figures' of https://github.com/lin-yang-ly/TMAP8 into test
ver1b_typos
Solve issue in test env and remove figures in documentation
Update documentation to generate figrues automatically - update V&V documentations - update V&V python script - update images
##########################################################################
moosebuild commented 2 months ago

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

View the site here

This comment will be updated on new commits.

moosebuild commented 2 months ago

Job Coverage, step Generate coverage on 8db116d wanted to post the following:

Coverage

Coverage did not change

Full coverage report

This comment will be updated on new commits.

lin-yang-ly commented 2 months ago

Awesome work on cleaning up the latest problems you were running into.

As I described in one of the comments: now that we only use the gold files, the .csv file are always available to the python file to plot them, so no need to add the prereq and heavy flags. So please remove them on all the comparison RunCommand tests (I made suggestions, please make sure I didn't miss any).

Thanks for your comments, @simopier ! All the "heavy" and "prereq" flags in RunCommand are removed. The PR is good to move forward!