arfc / msr-neutronics

To hold development code, milestones, and developments for msr neutronics.
BSD 3-Clause "New" or "Revised" License
7 stars 9 forks source link

Readme clarity #63

Open gwenchee opened 2 years ago

gwenchee commented 2 years ago

msr-neutronics/msr-flows/msbr_compare/readme.md feels unclear to me. It says: These scripts are designed to generate a Serpent2 input deck, run the deck, and then generate plots. Currently, the MSBR is analyzed with SaltProc and then compared with different approximations using Serpent2's built-in reprocessing functionality.

Do you mean that these scripts generate serpent 2 input files with Serpent2's built-in reprocessing functionality? Then compared with saltproc results?

nitpick: you should stay consistent with dir naming in terms of capitalizing the first letter and using _ vs -.