neams-th-coe / cardinal

High-Fidelity Multiphysics
https://cardinal.cels.anl.gov/
Other
84 stars 39 forks source link

Adding the KRUSTY tutorial to the Cardinal website #883

Open MendesMichael opened 2 months ago

MendesMichael commented 2 months ago

Please review the first version of the KRUSTY tutorial Coupling of OpenMC and MOOSE without Sockeye

aprilnovak commented 2 months ago

Thanks, Michael! I will take a closer look over the next few days -- but one initial comment is that the mesh files are too big to version control in Cardinal. They will slow down the git clone operation and, if we end up needing to change the files in the future, the git history doesn't "free" memory from old file versions, so the repo can get bloated.

I've moved your files here: https://anl.app.box.com/folder/263952628262

Can you please update the tutorial to instruct the reader that they need to download files from Box? There are other Cardinal tutorials which also follow this pattern.

aprilnovak commented 2 months ago

You'll also need to link the new markdown file you made from somewhere else inside Cardinal, in order for it to get rendered on the website. For instance, you'll probably want to add that link on the markdown file corresponding to this page: https://cardinal.cels.anl.gov/tutorials/openmc_solid.html

MendesMichael commented 2 months ago

Thank you! I've updated the tutorial and also linked the new markdown file into openmc_solid.md

aprilnovak commented 2 months ago

Have you tested if the documentation builds locally? You'll want to make sure that the rendered website looks good, format-wise.

cd cardinal/doc
./moosedocs.py build --serve

This will print out an HTML link which you can paste into a browser to look at a draft of the website. Give it a try, let me know if you run into any issues:

[I 240515 10:25:39 server:335] Serving on http://127.0.0.1:8000

You'll see something like this, copy that http... thing into a web browser.

MendesMichael commented 2 months ago

Have you tested if the documentation builds locally? You'll want to make sure that the rendered website looks good, format-wise.

cd cardinal/doc
./moosedocs.py build --serve

This will print out an HTML link which you can paste into a browser to look at a draft of the website. Give it a try, let me know if you run into any issues:

[I 240515 10:25:39 server:335] Serving on http://127.0.0.1:8000

You'll see something like this, copy that http... thing into a web browser.

Thanks, I did not knew about that. I just checked and I have some shortcut link errors and some figures that are too big. I will fix that now!

aprilnovak commented 2 months ago

I removed the WIP marker so that the test suite will run.

moosebuild commented 2 months ago

Job Documentation on 309797a 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 309797a wanted to post the following:

Coverage

Coverage did not change

Full coverage report

This comment will be updated on new commits.

moosebuild commented 2 months ago

Job Precheck on 364ba1a wanted to post the following:

Warning: This PR changes repo size by 31.65 MiB.

aprilnovak commented 2 months ago

For all images which were not generated by you/Mahmoud, please be sure to include a citation.