Update get_box_mesh.py

[aakankshbhat]

Updated get_box_mesh function

Questions for the review:

• Is the scope and purpose of the PR clear?
  • The PR should have a description.
  • The PR should have a guide if needed (e.g., an ordering).
• Is every top-level method and class documented? Are things that should be documented actually so?
• Is the interface understandable? (I.e. can someone figure out what stuff does?) Is it well-defined?
• Does the implementation do what the docstring claims?
• Is everything that is implemented covered by tests?
• Do you see any immediate risks or performance disadvantages with the design? Example: what do interface normals attach to?

[majosm]

Thanks! This looks like a good start. I added a couple of minor suggestions. The next steps should probably be to: 1) put this into an existing mirgecom module (I think mirgecom/simutil.py would be a good spot), and 2) update the examples and tests to import get_box_mesh from the module, rather than defining it locally in each one.

[majosm]

Looks good! Just added a few suggestions. Once those are addressed and the CI errors are fixed up, it should be ready to merge.

[tulioricci]

Hi @aakankshbhat , before you commit any changes, load the mirgecom environment and run "flake8 *.py" and "pydocstyle *.py" so you can catch any errors with flake8 or docs without having to go through CI. That will make your life easier. You can also run the examples to make sure there are no issues before committing and pushing.

[MTCam]

Hi @aakankshbhat , before you commit any changes, load the mirgecom environment and run "flake8 *.py" and "pydocstyle *.py" so you can catch any errors with flake8 or docs without having to go through CI. That will make your life easier. You can also run the examples to make sure there are no issues before committing and pushing.

Actually, if you save this bit of code as pre-commit in mirgecom/.git/hooks, then it will basically do what Tulio suggests above, and make sure everything is up-to-snuff at commit time automatically. It can get annoying every time, but can disable it on a case-by-case basis by specifying the -n option when committing if you don't want to run the hooks.

https://gist.github.com/MTCam/c9b7b58bdcd0cc72c1501b537cf3bb66

[majosm]

Looks good to me!