svalinn / DAGMC

Direct Accelerated Geometry Monte Carlo Toolkit
https://svalinn.github.io/DAGMC
Other
96 stars 63 forks source link

Fix documentation typos #852

Closed aprilnovak closed 1 year ago

aprilnovak commented 1 year ago

Closes #851

gonuke commented 1 year ago

thanks for this careful reading @aprilnovak - I've asked @pshriwise and/or @shimwell to take a look at the OpenMC specific parts since they are more expert than me

gonuke commented 1 year ago

(of course, if you are using them in practice in ways consistent with these updates, then that's a good sign)

aprilnovak commented 1 year ago

I'm new to DagMC, but from the OpenMC inputs I've been running, there does not seem to be any restriction on needing dagmc.h5m (versus some other *.h5m file), and the dagmc parameter in the settings.xml doesn't exist.

shimwell commented 1 year ago

Thanks for all these fixes, sorry there were so many mistakes and out of data API suggestions

Much appreciated

pshriwise commented 1 year ago

Thanks for these updates @aprilnovak! I'd like to link to a concrete example of how these can be used. We have a notebook for the NEA course, but it isn't open (yet) unfortunately.

The next best thing for now may be the PR that allows DAGMC geometries to be used as universes in OpenMC: https://github.com/openmc-dev/openmc/pull/1825

Update:

We do have this openly available notebook, though it doesn't demonstrate the universe capability fully: https://github.com/openmc-dev/openmc-notebooks/blob/main/cad-based-geometry.ipynb

shimwell commented 1 year ago

As this PR doesn't change the code and the CI passes I think we can go ahead and merge this one in straight away