neams-th-coe / cardinal

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

Add openmc-plotter to tutorials #974

Open aprilnovak opened 1 month ago

aprilnovak commented 1 month ago

Reason

There's so many awesome features in the openmc-plotter, especially with the upcoming mesh overlay capability.

Design

pshriwise commented 1 month ago

I wonder if adding some optional dependencies to the OpenMC Python package itself makes sense, similar to

pip install .[test]

for the test dependencies, we could include a vis option that will install the vtk Python module along with the plotter utility and its dependencies.

pip install .[test,vis]

Then it's just a matter of including those optional Python dependencies for the plotter. It's not quite what that packaging capability is intended for, but it might simplify things for users in this case. It's not hard to do it using standard methods I suppose.