Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarifying default algorithm used for triangulate - Watson or Shewchuk? #6436

Closed
weiji14 opened this issue Mar 12, 2022 · 2 comments · Fixed by #6438
Closed

Clarifying default algorithm used for triangulate - Watson or Shewchuk? #6436

weiji14 opened this issue Mar 12, 2022 · 2 comments · Fixed by #6438
Labels
documentation Improve documentation

Comments

@weiji14
Copy link
Member

weiji14 commented Mar 12, 2022 •
edited
Loading

Description of the problem

Two things that popped up while trying to wrap triangulate in PyGMT, see GenericMappingTools/pygmt#731 (comment) for context:

  1. The documentation at https://github.com/GenericMappingTools/gmt/blame/6.3.0/doc/rst/source/triangulate.rst#L60-L61 says that the triangulation algorithm used can be determined using gmt triangulate -, but that only prints the short help docs. @meghanrjones found that it should be gmt get GMT_TRIANGULATE instead
  2. Just want to confirm that the Watson [1982] algorithm is indeed the default, and not the newer Shewchuk [1996] algorithm? The conda-forge gmt package seems to be using Shewchuk [1996], but I don't see any special flag set in the build recipe at https://github.com/conda-forge/gmt-feedstock/blob/def03480bc8c569e58d94359f8a835016f292883/recipe/build.sh#L1-L51. This may have licensing implications, since the Shewchuk [1996] algorithm is not for commercial use according to https://github.com/GenericMappingTools/gmt/blob/6.3.0/src/TRIANGLE.HOWTO.

System information

  • Operating system: Linux
  • GMT version (gmt --version): 6.3.0
@weiji14 weiji14 added the documentation Improve documentation label Mar 12, 2022
@weiji14 weiji14 changed the title Clarifying algorithm used for triangulate - Watson or Shewchuk? Clarifying default algorithm used for triangulate - Watson or Shewchuk? Mar 12, 2022
@weiji14 weiji14 mentioned this issue Mar 12, 2022
Merged
10 tasks
@PaulWessel
Copy link
Member

I think it has to be on the user to switch away from Shewchuck if they are using GMT commercially. We should not cripple GMT with Watson just in case. I think Shewhuck is the default - at least that is what it says when I look at GMT_TRIANGULATE.

@weiji14
Copy link
Member Author

weiji14 commented Mar 12, 2022

Ok, so just need to reword the documentation to say that Shewchuk is the default. I'll open up a PR for this.

@weiji14 weiji14 mentioned this issue Mar 12, 2022
Merged
4 tasks
@maxrjones maxrjones added this to the 6.4.0 milestone Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improve documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document default Delaunay Triangulation algorithm as Shewchuk weiji14/gmt
3 participants
@maxrjones @weiji14 @PaulWessel