HOHQMesh icon indicating copy to clipboard operation
HOHQMesh copied to clipboard

Fix description of the gridded bathymetry data format in docs

Open andrewwinters5000 opened this issue 1 year ago • 3 comments

The discussion of the bathymetry data format was transposed, which this PR corrects. Also, it is possible to use a BOTTOM_TOPOGRAPHY block and sizer to create a 2D mesh as well. One just needs to remove the EXTRUSION block from the control file. The docs should be updated appropriately to highlight that this feature works in 2D as well.

andrewwinters5000 avatar Apr 16 '25 07:04 andrewwinters5000

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 75.87%. Comparing base (cd90cf0) to head (839530e). Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #134   +/-   ##
=======================================
  Coverage   75.87%   75.87%           
=======================================
  Files          68       68           
  Lines       10585    10585           
  Branches        2        2           
=======================================
  Hits         8031     8031           
  Misses       2554     2554           
Flag Coverage Δ
unittests 75.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Apr 16 '25 07:04 codecov[bot]

The docs should be updated appropriately to highlight that this feature works in 2D as well.

Do you want to do this here as well?

ranocha avatar Apr 16 '25 10:04 ranocha

The docs should be updated appropriately to highlight that this feature works in 2D as well.

Do you want to do this here as well?

Yes, I want to do that in this PR as well. I just want to touch base with David for the best place to make the modifications.

andrewwinters5000 avatar Apr 16 '25 11:04 andrewwinters5000

Yeah, I think so. I can modify the parts about using the topography for 2D sizing, and I'll leave it to Andrew to fix the parts on the data format.

DavidAKopriva avatar Apr 16 '25 17:04 DavidAKopriva

I added text to the section on topography that say it can be used to size a 2D mesh. At this point things seemed unwieldy, since it's described on the 3D meshing page. I guess it should be moved to the model page since that's where it is defined. In the meantime, I added a tl;dr section to the top of the introduction, index, and Readme pages entitled "What you can do with HOHQMesh" that has links to different sections. I need to figure out how to link to a section of a page, since appending #xxxx to the page doesn't seem to work from outside the page. I also need to figure out how to include a file so that the tl;dr is only in one place. Anyway, I kind of like having this addition, and comments are solicited.

DavidAKopriva avatar Apr 16 '25 22:04 DavidAKopriva

OK, then why don't we have this merged. It doesn't change the code any, so it can remain at its current version, right?

DavidAKopriva avatar Apr 23 '25 17:04 DavidAKopriva

Yes, this only changed the docs. So, nothing needs to be done with versioning.

andrewwinters5000 avatar Apr 23 '25 17:04 andrewwinters5000