[PRE REVIEW]: r3f: Rotation of 3-dimensional Reference Frames

[editorialbot]

Submitting author: @davidwoodburn (David Woodburn)
Repository: https://gitlab.com/davidwoodburn/r3f
Branch with paper.md (empty if default branch): main
Version: 2.0.9
Editor: @jbytecode
Reviewers: @pariterre, @vyasr
Managing EiC: Daniel S. Katz

Status

Status badge code:

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

Author instructions

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

@davidwoodburn 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]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.03 s (263.5 files/s, 158079.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                           3            737           1790           1409
Markdown                         3             42              0            155
TeX                              1              0              0             67
-------------------------------------------------------------------------------
SUM:                             7            779           1790           1631
-------------------------------------------------------------------------------

Commit count by author:

    41	David Woodburn

[editorialbot]

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

✅ OK DOIs

- 10.21105/joss.00580 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: r3f
- No DOI given, and none found for title: linear_transforms
- No DOI given, and none found for title: gps-frames
- No DOI given, and none found for title: rotations
- No DOI given, and none found for title: gtFrame
- No DOI given, and none found for title: PyGeodesy

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 375

🔴 Failed to discover a Statement of need section in paper

[editorialbot]

License info:

🟡 License found: Other (Check here for OSI approval)

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PyMap3D: 3-D coordinate conversions for terrestrial and geospace environments
Submitting author: @scivision
Handling editor: @lheagy (Retired)
Reviewers: @hugoledoux
Similarity score: 0.6967

rowan: A Python package for working with quaternions
Submitting author: @vyasr
Handling editor: @labarba (Retired)
Reviewers: @pdebuyl, @CorySimon
Similarity score: 0.6647

Manif: A micro Lie theory library for state estimation in robotics applications
Submitting author: @artivis
Handling editor: @poulson (Retired)
Reviewers: @jordigh, @drvinceknight, @alex-konovalov
Similarity score: 0.6316

ezc3d: An easy C3D file I/O cross-platform solution for C++, Python and MATLAB
Submitting author: @pariterre
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @melund, @BKillen05, @modenaxe
Similarity score: 0.6285

adrt: approximate discrete Radon transform for Python
Submitting author: @karlotness
Handling editor: @diehlpk (Active)
Reviewers: @zhangjy-ge, @fruzsinaagocs
Similarity score: 0.6161

⚠️ 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]

@davidwoodburn - thanks for your submission.

Note that JOSS requires a section title "Statement of Need" in your paper, as shown in the example paper. In this case, for a general audience, you could talk a little about navigation algorithms and research into them.

Please feel free to make changes to your .md file, then use the command @editorialbot generate pdf to make a new PDF. editorialbot commands need to be the first entry in a new comment.

[danielskatz]

I also don't see any references to other (non-software) work in this field, which might also go into the Statement of Need section.

[danielskatz]

Please ping me when you've made changes - I'll pause this for now.

[davidwoodburn]

Sorry for the delay. I was focused on another paper.

• I've added a Statement of need section and reworked the Summary.
• I've added two citations to non-software work in this field.

[davidwoodburn]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PyMap3D: 3-D coordinate conversions for terrestrial and geospace environments
Submitting author: @scivision
Handling editor: @lheagy (Retired)
Reviewers: @hugoledoux
Similarity score: 0.7112

rowan: A Python package for working with quaternions
Submitting author: @vyasr
Handling editor: @labarba (Retired)
Reviewers: @pdebuyl, @CorySimon
Similarity score: 0.6733

Manif: A micro Lie theory library for state estimation in robotics applications
Submitting author: @artivis
Handling editor: @poulson (Retired)
Reviewers: @jordigh, @drvinceknight, @alex-konovalov
Similarity score: 0.6665

ezc3d: An easy C3D file I/O cross-platform solution for C++, Python and MATLAB
Submitting author: @pariterre
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @melund, @BKillen05, @modenaxe
Similarity score: 0.6654

CoreRobotics: An object-oriented C++ library with cross-language wrappers for cross-platform robot control
Submitting author: @CoreRobotics
Handling editor: @danielskatz (Active)
Reviewers: @bmagyar @amjaeger17
Similarity score: 0.6528

⚠️ 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.

[davidwoodburn]

@danielskatz I think I'm ready for the next step in your review.

[danielskatz]

@editorialbot check references

[editorialbot]

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

✅ OK DOIs

- 10.21105/joss.00580 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Strapdown Inertial Navigation Technology
- No DOI given, and none found for title: Principles of GNSS, Inertial, and Multisensor Inte...
- No DOI given, and none found for title: linear_transforms
- No DOI given, and none found for title: gps-frames
- No DOI given, and none found for title: rotations
- No DOI given, and none found for title: gtFrame
- No DOI given, and none found for title: PyGeodesy

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[danielskatz]

Thanks @davidwoodburn - this looks still quite short, but probably ok. Perhaps you could add a short example of a use of the library? Also, do you want/need an acknowledgments sections to mention any funding or other support you have received?

[davidwoodburn]

As for the acknowledgements, I did all the work myself as part of my day job. Should I give acknowledgment to my employer? I'm not sure how that works. As for examples, does the test_r3f.py file suffice? That has several examples of the code being used. Or, are you saying I should add something directly into the paper?

[danielskatz]

I did mean to say something in the text like

An example of where this library could be used is to ...
In order to do this, the user would call the following code

Re the acknowledgements part, in your situation, you don't need to have such a section unless you want to explicitly recognize your employer's contribution. It's up to you.

[davidwoodburn]

@editorialbot generate pdf

Okay, I've added an example to the paper.

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

PyMap3D: 3-D coordinate conversions for terrestrial and geospace environments
Submitting author: @scivision
Handling editor: @lheagy (Retired)
Reviewers: @hugoledoux
Similarity score: 0.7208

rowan: A Python package for working with quaternions
Submitting author: @vyasr
Handling editor: @labarba (Retired)
Reviewers: @pdebuyl, @CorySimon
Similarity score: 0.6797

ezc3d: An easy C3D file I/O cross-platform solution for C++, Python and MATLAB
Submitting author: @pariterre
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @melund, @BKillen05, @modenaxe
Similarity score: 0.6619

Manif: A micro Lie theory library for state estimation in robotics applications
Submitting author: @artivis
Handling editor: @poulson (Retired)
Reviewers: @jordigh, @drvinceknight, @alex-konovalov
Similarity score: 0.6596

SimuPy Flight Vehicle Toolkit
Submitting author: @ixjlyons
Handling editor: @prashjha (Active)
Reviewers: @athulpg007, @aliaksei135
Similarity score: 0.6531

⚠️ 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]

Thanks @davidwoodburn - I'll next look for an editor

[danielskatz]

👋 @jbytecode - Would you be willing to edit this submission?

[danielskatz]

@editorialbot invite @jbytecode as editor

[editorialbot]

Invitation to edit this submission sent!

[jbytecode]

@editorialbot assign me as editor

@danielskatz - sure, gladly!

[editorialbot]

Assigned! @jbytecode is now the editor

[jbytecode]

👋👋👋 Dear @scivision , @vyasr 👋👋👋

Would you be willing to assist in reviewing this submission for JOSS (Journal of Open Source Software)?

JOSS publishes articles about open source research software. The submission I'd like you to review is titled:

r3f: Rotation of 3-dimensional Reference Frames

You can find more information at the top of this Github issue (#7315).

The review process at JOSS is unique: it takes place in a GitHub issue, is open, and author-reviewer-editor conversations are encouraged. If you have any questions please let me know.

This is the pre-review issue. After setting at least 2 reviewers we will start the review process in a separate thread. In that thread, there will be around 20 check items for each single reviewer.

Thank you in advance!

[davidwoodburn]

@danielskatz is the ball in my court?

[danielskatz]

@davidwoodburn - at this point, the editor (@jbytecode) is seeking reviewers. Once he gets at least 2, he will start the review, and the reviewers will then start providing comments and feedback. You don't have anything to do until then.

[jbytecode]

@davidwoodburn - I am the handling editor for this submission. As our track editor @danielskatz pointed out, I am now working on finding suitable reviewers and have started by searching through the list suggested by our editorial bot. The suggested papers appear similar to yours, so I thought the recommended reviewers might be a good fit. I plan to invite the suggested individuals first, and then I’ll reach out to you to see if you have any additional reviewer suggestions. Please hold tight and keep an eye on the process until I update you. Thank you in advance.

[jbytecode]

👋👋👋 Dear @pariterre 👋👋👋

Would you be willing to assist in reviewing this submission for JOSS (Journal of Open Source Software)?

JOSS publishes articles about open source research software. The submission I'd like you to review is titled:

r3f: Rotation of 3-dimensional Reference Frames

You can find more information at the top of this Github issue (#7315).

The review process at JOSS is unique: it takes place in a GitHub issue, is open, and author-reviewer-editor conversations are encouraged. If you have any questions please let me know.

This is the pre-review issue. After setting at least 2 reviewers we will start the review process in a separate thread. In that thread, there will be around 20 check items for each single reviewer.

Thank you in advance!

[jbytecode]

👋👋👋 Dear @ixjlyons 👋👋👋

Would you be willing to assist in reviewing this submission for JOSS (Journal of Open Source Software)?

JOSS publishes articles about open source research software. The submission I'd like you to review is titled:

r3f: Rotation of 3-dimensional Reference Frames

You can find more information at the top of this Github issue (#7315).

The review process at JOSS is unique: it takes place in a GitHub issue, is open, and author-reviewer-editor conversations are encouraged. If you have any questions please let me know.

This is the pre-review issue. After setting at least 2 reviewers we will start the review process in a separate thread. In that thread, there will be around 20 check items for each single reviewer.

Thank you in advance!

[pariterre]

@jbytecode
I would be willing to review this

[jbytecode]

@editorialbot add @pariterre as reviewer

@pariterre - Thank you for accepting our invitation. I will introduce the review instructions when we start the review in a separate thread.

[editorialbot]

@pariterre added to the reviewers list!

[jbytecode]

@davidwoodburn - We need to assign at least one more reviewers. Do you have any suggestions?

[davidwoodburn]

I'd like to recommend @DevangThakkar, if he's willing.

[jbytecode]

👋👋👋 Dear @DevangThakkar 👋👋👋

Would you be willing to assist in reviewing this submission for JOSS (Journal of Open Source Software)?

JOSS publishes articles about open source research software. The submission I'd like you to review is titled:

r3f: Rotation of 3-dimensional Reference Frames

You can find more information at the top of this Github issue (#7315).

The review process at JOSS is unique: it takes place in a GitHub issue, is open, and author-reviewer-editor conversations are encouraged. If you have any questions please let me know.

This is the pre-review issue. After setting at least 2 reviewers we will start the review process in a separate thread. In that thread, there will be around 20 check items for each single reviewer.

Thank you in advance!

[DevangThakkar]

Hi David and Mehmet,

Thank you for recommending me as a reviewer. Reviewing David's previous submission was a productive experience however after a brief perusal of the repo, I don't think I possess the background required to evaluate this particular submission.

I hope you find a more suitable reviewer for this work!

Cheers,
Devang

[jbytecode]

@DevangThakkar - Thank you for the quick reply.

@davidwoodburn - Do you have any suggestions for potential reviewers? Please don't use the @ character when providing a GitHub handle for avoiding bothering notifications. Thank you in advance.

[vyasr]

Apologies for missing the earlier @ here. I'd be happy to review.

[jbytecode]

@editorialbot add @vyasr as reviewer

[editorialbot]

@vyasr added to the reviewers list!

[jbytecode]

@pariterre, @vyasr - Now we are ready to create a new thread for the review. I'll introduce the instructions in that thread. See you there.

[jbytecode]

@editorialbot start review

[editorialbot]

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

[davidwoodburn]

I understand, DevangThakkar. Thank you again for your help with the other paper.