[PRE REVIEW]: votess: A multi-target, GPU-capable, parallel Voronoi tessellator

[editorialbot]

Submitting author: @samridh-dev (Samridh Dev Singh)
Repository: https://github.com/samridh-dev/votess.git
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: @Kevin-Mattheus-Moerman
Reviewers: @BrunoLevy, @DanielVandH, @pmocz
Managing EiC: Daniel S. Katz

Status

Status badge code:

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

Author instructions

Thanks for submitting your paper to JOSS @samridh-dev. Currently, there isn't a JOSS editor assigned to your paper.

@samridh-dev if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, 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]

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

✅ OK DOIs

- 10.1017/S1743921311000378 is OK
- 10.1145/3272127.3275092 is OK
- 10.1145/235815.235821 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: CGAL User and Reference Manual
- No DOI given, and none found for title: Geogram: a programming library of geometric algori...

❌ MISSING DOIs

- 10.2172/946741 may be a valid DOI for title: VORO++: A three-dimensional Voronoi cell library i...

❌ INVALID DOIs

- https://doi.org/10.1016/j.parco.2023.102995 is INVALID because of 'https://doi.org/' prefix

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.77 s (75.6 files/s, 409812.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C++                             25           1536            169         309445
Python                           3            136             56           1118
C/C++ Header                    14            200            170            525
Markdown                         2             80              0            282
CMake                            9             51             12            176
YAML                             2             20             42            117
TeX                              1              6              0             65
Bourne Shell                     2              5              2             54
-------------------------------------------------------------------------------
SUM:                            58           2034            451         311782
-------------------------------------------------------------------------------

Commit count by author:

   274	samridh-dev
     2	Samridh D. Singh

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 705

✅ The paper includes a Statement of need section

[editorialbot]

License info:

🟡 License found: GNU General Public License v3.0 (Check here for OSI approval)

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

DTCC Builder: A mesh generator for automatic, efficient, and robust mesh generation for large-scale city modeling and simulation
Submitting author: @anderslogg
Handling editor: @crvernon (Active)
Reviewers: @ifthompson, @ipadjen
Similarity score: 0.7248

Efficient Polyhedral Gravity Modeling in Modern C++ and Python
Submitting author: @schuhmaj
Handling editor: @dfm (Active)
Reviewers: @mikegrudic, @santisoler
Similarity score: 0.7121

VAST: the Void Analysis Software Toolkit
Submitting author: @kadglass
Handling editor: @dfm (Active)
Reviewers: @changhoonhahn, @lavaux
Similarity score: 0.7046

SiSyPHE: A Python package for the Simulation of Systems of interacting mean-field Particles with High Efficiency
Submitting author: @antoinediez
Handling editor: @pdebuyl (Active)
Reviewers: @lorenzo-rovigatti, @junghans
Similarity score: 0.6967

BoxKit: A Python library to manage analysis of block-structured simulation datasets
Submitting author: @akashdhruv
Handling editor: @kellyrowland (Active)
Reviewers: @rvg296, @Abinashbunty
Similarity score: 0.6966

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[danielskatz]

@samridh-dev - thanks for your submission. Our LOC counter shows 300k LOC of C++ in your repository. It seems likely that this is not all your code, but that you are including code from other packages. Can you help me understand what part of this is your code that we should be reviewing, and what is preexisting code that we would not review?

[samridh-dev]

Hi, Do not review the test cases since I believe that is auto generated and is probably why the code is around 300k. The main source code is around 30k instead,

…

________________________________ From: Daniel S. Katz ***@***.***> Sent: Friday, November 1, 2024 2:37 PM To: openjournals/joss-reviews ***@***.***> Cc: Singh, Samridh Dev (Sam) ***@***.***>; Mention ***@***.***> Subject: Re: [openjournals/joss-reviews] [PRE REVIEW]: votess: A multi-target, GPU-capable, parallel Voronoi tessellator (Issue #7419) Caution: External Email @samridh-dev<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_samridh-2Ddev&d=DwMFaQ&c=HUrdOLg_tCr0UMeDjWLBOM9lLDRpsndbROGxEKQRFzk&r=HWASZq6TcwVwkJpqA8x6LcNTa2Fa6N92aMe4xwgG2Pk&m=RR8jWEjt36nazbPfi_IG0ypnnRRueTk9Ny6Jy1ZbvwftxJHrlat4h-oDjfyVKbql&s=GhQZHdOT8UETA6Lxeh4MKu9-CLt0K80Dz8Pp_6ru1gM&e=> - thanks for your submission. Our LOC counter shows 300k LOC of C++ in your repository. It seems likely that this is not all your code, but that you are including code from other packages. Can you help me understand what part of this is your code that we should be reviewing, and what is preexisting code that we would not review? — Reply to this email directly, view it on GitHub<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_openjournals_joss-2Dreviews_issues_7419-23issuecomment-2D2452477088&d=DwMFaQ&c=HUrdOLg_tCr0UMeDjWLBOM9lLDRpsndbROGxEKQRFzk&r=HWASZq6TcwVwkJpqA8x6LcNTa2Fa6N92aMe4xwgG2Pk&m=RR8jWEjt36nazbPfi_IG0ypnnRRueTk9Ny6Jy1ZbvwftxJHrlat4h-oDjfyVKbql&s=QFaSsYCinn81DlOjemVKQ7exoIn7JhpKP5YnZrB-L2w&e=>, or unsubscribe<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_BASUXMH7T2AJJM3XILFCLW3Z6PJ53AVCNFSM6AAAAABRA2XNGCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJSGQ3TOMBYHA&d=DwMFaQ&c=HUrdOLg_tCr0UMeDjWLBOM9lLDRpsndbROGxEKQRFzk&r=HWASZq6TcwVwkJpqA8x6LcNTa2Fa6N92aMe4xwgG2Pk&m=RR8jWEjt36nazbPfi_IG0ypnnRRueTk9Ny6Jy1ZbvwftxJHrlat4h-oDjfyVKbql&s=Q87KAJ9nF0zxoaN14uosuES87GE7Cy6DU5_8y_Leygs&e=>. You are receiving this because you were mentioned.Message ID: ***@***.***> This email was sent from outside Grinnell College. Treat attachments and links with caution. If this message looks suspicious, use the report phish button.

[danielskatz]

Which part of the code (meaning which directories) should be counted and reviewed?

[samridh-dev]

Only the src/ and include/ directories should be reviewed.

…

________________________________ From: Daniel S. Katz ***@***.***> Sent: Friday, November 1, 2024 2:40 PM To: openjournals/joss-reviews ***@***.***> Cc: Singh, Samridh Dev (Sam) ***@***.***>; Mention ***@***.***> Subject: Re: [openjournals/joss-reviews] [PRE REVIEW]: votess: A multi-target, GPU-capable, parallel Voronoi tessellator (Issue #7419) Caution: External Email Which part of the code (meaning which directories) should be counted and reviewed? — Reply to this email directly, view it on GitHub<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_openjournals_joss-2Dreviews_issues_7419-23issuecomment-2D2452481438&d=DwMFaQ&c=HUrdOLg_tCr0UMeDjWLBOM9lLDRpsndbROGxEKQRFzk&r=HWASZq6TcwVwkJpqA8x6LcNTa2Fa6N92aMe4xwgG2Pk&m=-aaMhHOxo5yvCVoZ5UrQnXvK2aQNvHg-evuVsMfPlVR84AHQQ1hSQ2fRbDlYqI2N&s=Xyz1Hu-diNlcEwif1JwFuq2d77GSi_LiP2S1xdDGPn4&e=>, or unsubscribe<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_BASUXMCWGEMZDXWK5BLBUD3Z6PKK7AVCNFSM6AAAAABRA2XNGCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJSGQ4DCNBTHA&d=DwMFaQ&c=HUrdOLg_tCr0UMeDjWLBOM9lLDRpsndbROGxEKQRFzk&r=HWASZq6TcwVwkJpqA8x6LcNTa2Fa6N92aMe4xwgG2Pk&m=-aaMhHOxo5yvCVoZ5UrQnXvK2aQNvHg-evuVsMfPlVR84AHQQ1hSQ2fRbDlYqI2N&s=iKGYgY8TZi0IyTgGfmyrT586cI4uoFx0teG4ezPF3P4&e=>. You are receiving this because you were mentioned.Message ID: ***@***.***> This email was sent from outside Grinnell College. Treat attachments and links with caution. If this message looks suspicious, use the report phish button.

[danielskatz]

👋 @Kevin-Mattheus-Moerman - Would you be interested in editing (or reviewing) this submission?

[Kevin-Mattheus-Moerman]

Happy to do either but probably editing is best.

[danielskatz]

@Kevin-Mattheus-Moerman - sorry I missed your message before I left on vacation, but now that I am back, I will assign you as the editor - thanks in advance!!

[danielskatz]

@editorialbot assign @Kevin-Mattheus-Moerman as editor

[editorialbot]

Assigned! @Kevin-Mattheus-Moerman is now the editor

[Kevin-Mattheus-Moerman]

@BrunoLevy @lrineau @sloriot would you be interested in reviewing this submission for JOSS entitled: "votess: A multi-target, GPU-capable, parallel Voronoi tessellator"?.

JOSS reviews take place here on GitHub, and focus on the software as well a short paper.

If you are interested please let me know here. Thanks!

[Kevin-Mattheus-Moerman]

@samridh-dev Dear author, thanks for this submission. I am the AEiC on this track and here to help process the initial steps. Before we proceed, please can you have a look at the following points:

• Please study the above reference check ☝️ and see if you can address any of the reported potential DOI issues. You can add/amend DOI entries in your .bib file, and call @editorialbot check references here to check them again.
• Your project appears to lack contributing guidelines at the moment. Please work to add these and to mention/link to them in your README. You could for instance create a CONTRIBUTING.md file (see here for some examples: https://contributing.md/example/).
• Your README states "This library is part of my bachelor project, which was only made possible through the guidance of Dr. Chris Byrohl and Dr. Dylan Nelson from the Institute of Theoretical Astrophysics at Heidelberg University, and for that I owe my gratitude to them." It is not clear what "my" refers to. Perhaps spell out the person's name, and perhaps create an acknowledgment section and clarify/move things there.
• 3D Voronoi structures are inherently 3D geometry and therefore lend themselves well to visualization. If possible I would recommend adding some visualizations to illustrate the software capabilities. I would add these to the README/documentation and also the paper.

[Kevin-Mattheus-Moerman]

@samridh-dev 👋 can you work on the above please?

[Kevin-Mattheus-Moerman]

@samridh-dev 👋 can you work on the above please? It is important to respond in a timely manor.

[samridh-dev]

@Kevin-Mattheus-Moerman Apologies for the delay. I have addressed the above points, and I created a visualization showing what the program can do, and I am working on adding them to the paper and the README.md file. Please review it and let me know if it is sufficient.

[Kevin-Mattheus-Moerman]

@editorialbot generate pdf

[editorialbot]

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

[Kevin-Mattheus-Moerman]

@editorialbot check references

[editorialbot]

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

✅ OK DOIs

- 10.1017/S1743921311000378 is OK
- 10.1145/3272127.3275092 is OK
- 10.1145/235815.235821 is OK
- 10.2172/946741 is OK
- 10.1016/j.parco.2023.102995 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: CGAL User and Reference Manual
- No DOI given, and none found for title: Geogram: a programming library of geometric algori...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[Kevin-Mattheus-Moerman]

@samridh-dev thanks for working on those points. I see you added a bar-chart. Is there any visualizations of the Voronoi cells themselves? I would recommend adding this.

[sloriot]

I'm sorry I wasn't available for a full review but I can still give a few comments that you'll be free to take into account. It's kind of surprising to cite as reference CGAL 4.12 while the latest release if 6.0.1. Also I don't see any benchmark with the parallel CPU implementation of CGAL, at least for computing the dual Delaunay triangulation. I can run the benchmark myself if that helps, provided the author indicates how to run votess for a set of random points.

[Kevin-Mattheus-Moerman]

@editorialbot add @BrunoLevy as reviewer

[editorialbot]

@BrunoLevy added to the reviewers list!

[Kevin-Mattheus-Moerman]

@sloriot thanks for your response and comments. @samridh-dev can you repond to these?

[Kevin-Mattheus-Moerman]

@BrunoLevy I took the 👍 to mean you are happy to review this work so have added you just now. We will hopefully start the review shortly, once I have found some more reviewers.

[Kevin-Mattheus-Moerman]

@lrineau @DanielVandH @j-fu @cbyrohl @lgarrison would you be interested in reviewing this submission for JOSS entitled: "votess: A multi-target, GPU-capable, parallel Voronoi tessellator"?.

JOSS reviews take place here on GitHub, and focus on the software as well a short paper.

If you are interested please let me know here. Thanks!

[DanielVandH]

Hi @Kevin-Mattheus-Moerman, sure I'm happy to review.

[lgarrison]

Thanks for asking! Unfortunately I don't have the bandwidth to review right now, but if you're taking suggestions for possible other reviewers, I had an offline conversation with @pmocz who said he might be interested.

[Kevin-Mattheus-Moerman]

@editorialbot add @DanielVandH as reviewer

[editorialbot]

@DanielVandH added to the reviewers list!

[Kevin-Mattheus-Moerman]

@pmocz would you be interested in reviewing this submission for JOSS? See also ☝️

[pmocz]

@pmocz would you be interested in reviewing this submission for JOSS? See also ☝️

@Kevin-Mattheus-Moerman Happy to help out with this one!

[Kevin-Mattheus-Moerman]

@editorialbot add @pmocz as reviewer

[editorialbot]

@pmocz added to the reviewers list!

[Kevin-Mattheus-Moerman]

@editorialbot start review

[editorialbot]

OK, I've started the review over in #7741.