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.

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

[REVIEW]: DelaunayTriangulation.jl: A Julia package for Delaunay triangulations and Voronoi tessellations in the plane #7174

Closed
editorialbot opened this issue Sep 4, 2024 · 51 comments
Assignees
Labels
accepted Julia published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 7 (CSISM) Computer science, Information Science, and Mathematics

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Sep 4, 2024

Submitting author: @DanielVandH (Daniel VandenHeuvel)
Repository: https://github.com/JuliaGeometry/DelaunayTriangulation.jl
Branch with paper.md (empty if default branch): paper
Version: v1.4.2
Editor: @vissarion
Reviewers: @PieterjanRobbe, @mtsch
Archive: 10.5281/zenodo.13847646

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/9f806b9bc4dd2f31f5e7ca67b64448bd"><img src="https://joss.theoj.org/papers/9f806b9bc4dd2f31f5e7ca67b64448bd/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/9f806b9bc4dd2f31f5e7ca67b64448bd/status.svg)](https://joss.theoj.org/papers/9f806b9bc4dd2f31f5e7ca67b64448bd)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@PieterjanRobbe & @mtsch, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @vissarion know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Checklists

📝 Checklist for @PieterjanRobbe

📝 Checklist for @mtsch

@editorialbot
Copy link
Collaborator Author

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.45 s (619.8 files/s, 167654.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Julia                          187           5186          11288          41961
Markdown                        75           2053              0           9646
TOML                             6            705              2           3323
TeX                              1             25              0            246
YAML                             6              9             11            175
JSON                             1              0              0             22
-------------------------------------------------------------------------------
SUM:                           276           7978          11301          55373
-------------------------------------------------------------------------------

Commit count by author:

   534	DanielVandH
    49	Daniel VandenHeuvel
     3	dependabot[bot]
     2	Júlio Hoffimann
     1	CompatHelper Julia
     1	Simon
     1	himcraft

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 973

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

✅ License found: MIT License (Valid open source OSI approved license)

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1142/8685 is OK
- 10.1016/S0925-7721(98)00035-2 is OK
- 10.14288/1.0067778 is OK
- 10.1137/141000671 is OK
- 10.1016/S0168-874X(96)00054-6 is OK
- 10.1137/050643568 is OK
- 10.1016/S0070-2153(07)81013-1 is OK
- 10.1137/S0036144599352836 is OK
- 10.1007/s00285-024-02045-4 is OK
- 10.1007/BFb0014497 is OK
- 10.1109/WCICA.2008.4593771 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1002/nme.2579 is OK
- 10.1016/j.cej.2023.145776 is OK
- 10.21105/joss.03349 is OK
- 10.5281/zenodo.11178646 is OK
- 10.5281/zenodo.11176971 is OK
- 10.1017/CBO9780511606014 is OK
- 10.1088/1751-8121/ac4a1d is OK
- 10.1007/PL00009321 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Delaunay Mesh Generation
- No DOI given, and none found for title: Natural neighbor interpolation - critical assessme...
- No DOI given, and none found for title: ExactPredicates.jl: Fast and exact geometrical pre...
- No DOI given, and none found for title: AdaptivePredicates.jl: Port of Shewchuk’s robust p...
- No DOI given, and none found for title: MATLAB version: R2024a
- No DOI given, and none found for title: CGAL User and Reference Manual

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@PieterjanRobbe
Copy link

PieterjanRobbe commented Sep 4, 2024

Review checklist for @PieterjanRobbe

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/JuliaGeometry/DelaunayTriangulation.jl?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@DanielVandH) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@mtsch
Copy link

mtsch commented Sep 4, 2024

Review checklist for @mtsch

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/JuliaGeometry/DelaunayTriangulation.jl?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@DanielVandH) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@DanielVandH
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@DanielVandH
Copy link

DanielVandH commented Sep 10, 2024

I've made some changes in response to @PieterjanRobbe's comments over at JuliaGeometry/DelaunayTriangulation.jl#181, and made some other minor changes. The pdf has been regenerated, see above. To summarise:

  1. Since I just finished implementing weighted triangulations and power diagrams this weekend, I've mentioned them in the summary as a feature that the package supports.
  2. I changed the language of "The most feature-rich" in comparing my package to other software. I now just claim to support features that most of the other packages don't support, which I think should be appropriate. I also now mention that there are other Julia packages that support triangulations, and link to where I discuss that in my package's README since it would be a bit cluttered to also do a full comparison in the paper.
  3. The summary paragraphs have been reordered. I now mention the package first and then, in the second paragraph, define triangulations and tessellations.
  4. Since random power diagrams often look bad, I changed the README example to use a rng object for reproducibility. I also made the example use a bit less text width.

Thanks again to @PieterjanRobbe for the comments, I appreciate it.

@DanielVandH
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@DanielVandH
Copy link

I've made some changes in response to @mtsch's comments over at JuliaGeometry/DelaunayTriangulation.jl#189. The pdf has been regenerated, see above. To summarise:

  1. I've added a sentence at the end of the summary pointing the reader to the mathematical details section of DelaunayTriangulation.jl's document, allowing them to easily know where to find more information about these methods.
  2. To help make the mean exit time example clearer, I have mentioned some applications where it arises, mentioning diffusive transport, economics, and a specific example in finance. I also introduce the notation $T(x, y)$ prior to showing the equations describing the model, to avoid the need to have to read ahead and then look back up to the equations.

Thanks again @mtsch, I appreciate your feedback.

@DanielVandH
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@DanielVandH
Copy link

(Just fixed a minor reference issue)

@DanielVandH
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@vissarion
Copy link

@mtsch, @PieterjanRobbe thanks a lot for your efforts! It seems that your checklists are completed.

Are your finished with your reviews and recommend acceptance?

@vissarion
Copy link

@DanielVandH I opened an issue in the repository with some editing suggestions.

@PieterjanRobbe
Copy link

Looks good to me!

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@DanielVandH
Copy link

DanielVandH commented Sep 26, 2024

To address @vissarion's comments at JuliaGeometry/DelaunayTriangulation.jl#190, I've:

  • Clarified the difference between unconstrained and constrained Delaunay triangulations by defining them separately. The Delaunay criterion is also explicitly mentioned.
  • Mentioned the programming languages used in the other software mentioned. I've also now extended my README to include a more detailed comparison with other software packages, including this table

softwarecomparison

to give more detail. This isn't in the paper itself due to space reasons, but I do refer back to it.

  • Fixed some typos.

Thanks again for the feedback.

@mtsch
Copy link

mtsch commented Sep 26, 2024

@vissarion I'm finished with my review and I think this paper will make a great addition to JOSS! The package, its documentation, and paper are all top notch in my opinion.

@vissarion
Copy link

@DanielVandH thanks for addressing my comments.

In particular, the table of related software and the comparisons looks great! However I think it would be good to double-check the table data once more especially the licenses part (e.g. I think that CGAL has multiple open source licenses for several parts and the option for commercial, but in your case only the triangulations package should be considered). Although, I am not an expert in licensing so this is just an advice and can be done independently from the submission.

@vissarion
Copy link

Continuing on the review part when a submission is ready to be accepted, we ask that the authors issue a new tagged release of the software (if changed), and archive it (see this guide). Please do this and post the version number and archive DOI here.
Please make sure that the author names, affiliations as well as the title of the archive (e.g. zenodo) is exactly the same with the submission.

@DanielVandH
Copy link

Thanks for pointing out that issue with CGAL's licenses. Indeed there is also a triangulation package there with a GNU GPL license. I mention now that it has GPL/GNU GPL/Commerical licenses.

I've tagged a new version (v1.4.2) of the package. I already had a Zenodo setup at https://zenodo.org/records/13847646 which has been updated accordingly; the DOI is https://doi.org/10.5281/zenodo.13847646. Is that all correct?

@vissarion
Copy link

@editorialbot set 10.5281/zenodo.13847646 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.13847646

@vissarion
Copy link

@editorialbot set v1.4.2 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v1.4.2

@vissarion
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1142/8685 is OK
- 10.1016/S0925-7721(98)00035-2 is OK
- 10.14288/1.0067778 is OK
- 10.1137/141000671 is OK
- 10.1016/S0168-874X(96)00054-6 is OK
- 10.1137/050643568 is OK
- 10.1016/S0070-2153(07)81013-1 is OK
- 10.1137/S0036144599352836 is OK
- 10.1007/s00285-024-02045-4 is OK
- 10.1007/BFb0014497 is OK
- 10.1109/WCICA.2008.4593771 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1002/nme.2579 is OK
- 10.1016/j.cej.2023.145776 is OK
- 10.21105/joss.03349 is OK
- 10.5281/zenodo.11178646 is OK
- 10.5281/zenodo.11176971 is OK
- 10.1017/CBO9780511606014 is OK
- 10.1088/1751-8121/ac4a1d is OK
- 10.1007/PL00009321 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Delaunay Mesh Generation
- No DOI given, and none found for title: Natural neighbor interpolation - critical assessme...
- No DOI given, and none found for title: First passage times of diffusion processes and the...
- No DOI given, and none found for title: ExactPredicates.jl: Fast and exact geometrical pre...
- No DOI given, and none found for title: AdaptivePredicates.jl: Port of Shewchuk’s robust p...
- No DOI given, and none found for title: MATLAB version: R2024a
- No DOI given, and none found for title: CGAL User and Reference Manual

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/csism-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#5925, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Sep 27, 2024
@danielskatz
Copy link

👋 @DanielVandH - As the track editor, I'm now reviewing this for final publication. It looks very good, though I have one question. There's no acknowledgment section, so I want to check to make sure this is intentional and that you don't want to mention any funding or other acknowledgements. Is this correct?

@DanielVandH
Copy link

That's correct

@danielskatz
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

Doing it live! Attempting automated processing of paper acceptance...

@danielskatz
Copy link

I'll check on this, and close it if it's done, in about 30 minutes...

@editorialbot
Copy link
Collaborator Author

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

cff-version: "1.2.0"
authors:
- family-names: VandenHeuvel
  given-names: Daniel J.
  orcid: "https://orcid.org/0000-0001-6462-0135"
contact:
- family-names: VandenHeuvel
  given-names: Daniel J.
  orcid: "https://orcid.org/0000-0001-6462-0135"
doi: 10.5281/zenodo.13847646
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: VandenHeuvel
    given-names: Daniel J.
    orcid: "https://orcid.org/0000-0001-6462-0135"
  date-published: 2024-09-27
  doi: 10.21105/joss.07174
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7174
  title: "DelaunayTriangulation.jl: A Julia package for Delaunay
    triangulations and Voronoi tessellations in the plane"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07174"
  volume: 9
title: "DelaunayTriangulation.jl: A Julia package for Delaunay
  triangulations and Voronoi tessellations in the plane"

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.07174 joss-papers#5926
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.07174
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Sep 27, 2024
@danielskatz
Copy link

Congratulations to @DanielVandH (Daniel VandenHeuvel) on your publication!!

And thanks to @PieterjanRobbe and @mtsch for reviewing, and to @vissarion for editing!
JOSS depends on volunteers and couldn't be successful without you

@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07174/status.svg)](https://doi.org/10.21105/joss.07174)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.07174">
  <img src="https://joss.theoj.org/papers/10.21105/joss.07174/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.07174/status.svg
   :target: https://doi.org/10.21105/joss.07174

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

@mtsch
Copy link

mtsch commented Sep 27, 2024

Congratulations!

@DanielVandH
Copy link

Thanks all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Julia published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 7 (CSISM) Computer science, Information Science, and Mathematics
Projects
None yet
Development

No branches or pull requests

6 participants