[REVIEW]: DiffeRT2d: A Differentiable Ray Tracing Python Framework for Radio Propagation

[editorialbot]

Submitting author: !--author-handle-->@jeertmans<!--end-author-handle-- (Jérome Eertmans) Repository: https://github.com/jeertmans/DiffeRT2d Branch with paper.md (empty if default branch): Version: v0.3.4 Editor: !--editor-->@danielskatz<!--end-editor-- Reviewers: @idoby, @roth-jakob Archive: 10.5281/zenodo.12600658

Status

Status badge code:

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

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

@idoby & @roth-jakob, 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 @danielskatz 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 @idoby

📝 Checklist for @roth-jakob

[jeertmans]

The title and authors of the Zenodo deposit should be the same as those of the paper. You can change these manually without making a new deposit by editing the metadata.

Done!

[danielskatz]

@editorialbot set 10.5281/zenodo.12600658 as archive

[editorialbot]

Done! archive is now 10.5281/zenodo.12600658

[danielskatz]

@editorialbot set v0.3.4 as version

[editorialbot]

Done! version is now v0.3.4

[danielskatz]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

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

OK DOIs

- 10.23919/EuCAP60739.2024.10501570 is OK
- 10.1109/TAP.2014.2323961 is OK
- 10.1109/ACCESS.2015.2453991 is OK
- 10.23919/EuCAP57121.2023.10132934 is OK
- 10.1371/journal.pone.0260060 is OK

MISSING DOIs

- No DOI given, and none found for title: Adam: A Method for Stochastic Optimization
- No DOI given, and none found for title: The DeepMind JAX Ecosystem
- No DOI given, and none found for title: JAX: composable transformations of Python+NumPy pr...
- No DOI given, and none found for title: jaxtyping: type annotations and runtime checking f...
- No DOI given, and none found for title: Equinox: neural networks in JAX via callable PyTre...
- No DOI given, and none found for title: Learning to Sample Ray Paths for Faster Point-to-P...
- No DOI given, and none found for title: Advanced Radio Channel Simulator
- 10.1109/gcwkshps58843.2023.10465179 may be a valid DOI for title: Sionna RT: Differentiable Ray Tracing for Radio Pr...
- No DOI given, and none found for title: TensorFlow: Large-Scale Machine Learning on Hetero...

INVALID DOIs

- None

[editorialbot]

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

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5556, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

[danielskatz]

@jeertmans - it looks like there's a valid DOI missing from your bib file, and in fact, you're citing a preprint rather than the later published article. Can you change the entry for sionnart to this?

@INPROCEEDINGS{sionnart,
  author={Hoydis, Jakob and Aoudia, Faycal Ait and Cammerer, Sebastian and Nimier-David, Merlin and Binder, Nikolaus and Marcus, Guillermo and Keller, Alexander},
  booktitle={2023 IEEE Globecom Workshops ({GC W}kshps)}, 
  title={Sionna {RT}: Differentiable Ray Tracing for Radio Propagation Modeling}, 
  year={2023},
  pages={317--321},
  doi={10.1109/GCWkshps58843.2023.10465179},
}

You don't need to update the zenodo deposit, as we don't really require the paper source to be there at all - we archive the pdf and XML versions that we create.

[danielskatz]

@jeertmans - also, in the caption for Figure 3, please change see [@eertmans2024eucap] for all details to see @eertmans2024eucap for all details

[jeertmans]

@jeertmans - also, in the caption for Figure 3, please change see [@eertmans2024eucap] for all details to see @eertmans2024eucap for all details

Yep just caught this also by reading the final proof, I did update it and fixed a small thing too.

@jeertmans - it looks like there's a valid DOI missing from your bib file, and in fact, you're citing a preprint rather than the later published article. Can you change the entry for sionnart to this?

@INPROCEEDINGS{sionnart,
  author={Hoydis, Jakob and Aoudia, Faycal Ait and Cammerer, Sebastian and Nimier-David, Merlin and Binder, Nikolaus and Marcus, Guillermo and Keller, Alexander},
  booktitle={2023 IEEE Globecom Workshops ({GC W}kshps)}, 
  title={Sionna {RT}: Differentiable Ray Tracing for Radio Propagation Modeling}, 
  year={2023},
  pages={317--321},
  doi={10.1109/GCWkshps58843.2023.10465179},
}

You don't need to update the zenodo deposit, as we don't really require the paper source to be there at all - we archive the pdf and XML versions that we create.

I didn't know about that, nice catch!

[jeertmans]

@editorialbot generate pdf

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[danielskatz]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

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

OK DOIs

- 10.23919/EuCAP60739.2024.10501570 is OK
- 10.1109/TAP.2014.2323961 is OK
- 10.1109/ACCESS.2015.2453991 is OK
- 10.23919/EuCAP57121.2023.10132934 is OK
- 10.1371/journal.pone.0260060 is OK
- 10.1109/GCWkshps58843.2023.10465179 is OK

MISSING DOIs

- No DOI given, and none found for title: Adam: A Method for Stochastic Optimization
- No DOI given, and none found for title: The DeepMind JAX Ecosystem
- No DOI given, and none found for title: JAX: composable transformations of Python+NumPy pr...
- No DOI given, and none found for title: jaxtyping: type annotations and runtime checking f...
- No DOI given, and none found for title: Equinox: neural networks in JAX via callable PyTre...
- No DOI given, and none found for title: Learning to Sample Ray Paths for Faster Point-to-P...
- No DOI given, and none found for title: Advanced Radio Channel Simulator
- No DOI given, and none found for title: TensorFlow: Large-Scale Machine Learning on Hetero...

INVALID DOIs

- None

[editorialbot]

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

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5557, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

[jeertmans]

Looks good to me now :-)

[danielskatz]

@editorialbot accept

[editorialbot]

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

[editorialbot]

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: Eertmans given-names: Jérome orcid: "https://orcid.org/0000-0002-5579-5360" - family-names: Oestges given-names: Claude orcid: "https://orcid.org/0000-0002-0902-4565" - family-names: Jacques given-names: Laurent orcid: "https://orcid.org/0000-0002-6261-0328" doi: 10.5281/zenodo.12600658 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Eertmans given-names: Jérome orcid: "https://orcid.org/0000-0002-5579-5360" - family-names: Oestges given-names: Claude orcid: "https://orcid.org/0000-0002-0902-4565" - family-names: Jacques given-names: Laurent orcid: "https://orcid.org/0000-0002-6261-0328" date-published: 2024-06-30 doi: 10.21105/joss.06915 issn: 2475-9066 issue: 98 journal: Journal of Open Source Software publisher: name: Open Journals start: 6915 title: "DiffeRT2d: A Differentiable Ray Tracing Python Framework for Radio Propagation" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06915" volume: 9 title: "DiffeRT2d: A Differentiable Ray Tracing Python Framework for Radio Propagation" ```

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]

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

[editorialbot]

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

Here's what you must now do:

0. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/5558
1. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06915
2. If everything looks good, then close this review issue.
3. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

[danielskatz]

Congratulations to @jeertmans (Jérome Eertmans) and co-authors on your publication!!

And thanks to @idoby and @roth-jakob for a quick and successful review process! JOSS depends on volunteers, and wouldn't be possible without efforts like yours

[editorialbot]

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

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.06915/status.svg)](https://doi.org/10.21105/joss.06915)

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

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

This is how it will look in your documentation:

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:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://reviewers.joss.theoj.org/join
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

[jeertmans]

Thanks @danielskatz, @idoby and @roth-jakob for your time on this review, and especially for the reactivity! I really appreciate your help and comments :)