-
-
Notifications
You must be signed in to change notification settings - Fork 41
[REVIEW]: PyNGHam: A Python library of the NGHam protocol #4915
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
Comments
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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Wordcount for |
|
Dear @pritchardn, @0xCoto Thank you again, for accepting our invitation to review. This is the review thread. Please, firstly type
to generate your own checklist. In that checklist, there are ~20 check items. Whenever you complete the corresponding task, you can check off them. Please write your comments as separate posts and do not modify your checklist descriptions. The review process is interactive so you can always interact with the authors, reviewers, and the editor. You can also create issues and pull requests in the target repo. Please do mention this thread's URL in the issues so we can keep tracking what is going on out of our world. Please do not hesitate to ask me about anything, anytime. Thank you in advance! |
Review checklist for @0xCotoConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @pritchardnConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@mgm8 - Could you please comment on how this library compares against conventional DSP tools (such as GNU Radio, whose versatility may permit similar processing pipelines)? Considering GNU Radio's increasing popularity in the field of satellite communications, I think it would be useful for readers to understand the cases where PyNGHam could replace/complement the functionality of GNU Radio-based modules, such as Some initial minor comments (language suggestions to improve the quality of the manuscript):
(More to come) Also, it might be useful to mention what "NGHam" stands for (i.e. "Next Generation Ham Radio") somewhere, as it does not appear to be a very well-known protocol. The reader currently has to head to the Skagmo (2014) reference to figure this out. |
I'll be adding my comments as I go, I plan to have my review completed in the next two weeks 😄 Documentation - Statement of Need: There is a space in the overview page for explaining the point of the protocol however the last sentence, where the statement of need actually is seems unfinished - ending with Consider elaborating a little more about why an easy-to-use Python-based implementation is useful (I think it is, but I'd like to see it written) - especially since this is a pure-python implementation, rather than a binding of the original implementation, |
@mgm8 - Our reviewers have suggested some corrections, could you please update your status? Thank you in advance. |
Documentation - Community Guidlines
Just makes things super clear and easily accessible 😄 |
Functionality documentation As a good start, writing proper docstrings in the main classes and methods will populate tooltips in IDEs and be a good start towards automating API doc generation - Sphinx has some pretty powerful autodoc features that make life easier. |
@mgm8 - could you please update your status? |
@0xCoto thanks for your comments and suggestions! All suggestions were fixed in this commit: 913f9e8 About the first comment: This library is independent from high level frameworks like GNURadio. The intention is to use it in final user applications, like satellite decoders used in real satellite missions. It is an alternative to the GNURadio blocks such as the gr-nuts, but independent from the GNURadio ecosystem. It is also useful as a simulation or research/education tool, that can be used in simple Python scripts. Do you think this explanation should be added to the paper and/or documentation? |
Yes, this is definitely something worth addressing, as readers may be curious as to why they should give this package a try instead of GNU Radio. The potential applications and purpose of the package should be made clear in the manuscript. You can also briefly state the advantages NGHam offers compared to other modulation/encoding schemes used in CubeSats, to emphasize the importance of having a Python-based solution for something like this. |
@pritchardn I think this commit also solves your first suggestion. |
@pritchardn Thanks for your suggestions! I improved the references to the contributing instructions in 4533d5c and cebe889. |
@editorialbot generate pdf |
@0xCoto Sorry, I made the last changes in a different branch and I think the generated article proof is outdated. I just merged the dev branch to the main and now the article proof should be updated. |
@editorialbot generate pdf |
@mgm8 - Comments for the rest of the manuscript:
|
@editorialbot set 10.5281/zenodo.7555428 as archive |
Done! Archive is now 10.5281/zenodo.7555428 |
@editorialbot check references |
|
@editorialbot generate pdf |
Dear @mgm8 Everything seems okay to me. I am now recommending an acceptance. Our track editor will make the final decision. I hope your library will get more users and your paper gets lots of citations! Thank you in advance |
@editorialbot recommend-accept |
|
|
👋 @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#3892, then you can now move forward with accepting the submission by compiling again with the command |
@mgm8 - I'm the track editor for this submission, and I'll now proofread it, and then move the process towards publication |
I've suggested some minor changes to the paper in mgm8/pyngham#28 - please merge this, or let e know what you disagree with, then we can continue. |
@danielskatz Done! I accepted the pull request! |
@editorialbot recommend-accept |
|
|
👋 @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#3898, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
Congratulations to @mgm8 (Gabriel Marcelino)!! And thanks to @pritchardn and @0xCoto for reviewing, and to @jbytecode for editing! |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
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:
|
Submitting author: @mgm8 (Gabriel Marcelino)
Repository: https://github.com/mgm8/pyngham
Branch with paper.md (empty if default branch): main
Version: v1.1.1
Editor: @jbytecode
Reviewers: @pritchardn, @0xCoto
Archive: 10.5281/zenodo.7555428
Status
Status badge code:
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
@pritchardn & @0xCoto, 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:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @jbytecode 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 @0xCoto
📝 Checklist for @pritchardn
The text was updated successfully, but these errors were encountered: