-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: pygwb
: a Python-based library for gravitational-wave background searches
#5454
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:
|
@editorialbot generate my checklist |
@Sbozzolo I can't do that because you are not a reviewer |
Hi @a-renzini, I will be reviewing your package. I wanted to clear some expectations regarding the timeline: I will soon leave for some travel, so I won't be able to work on the review for the next 3 weeks or so. I am sorry about that since I see that you've already waited for a month. Even if the second reviewer hasn't been found yet, I would invite you to look at the review checklist and make sure that your project checks all the boxes. From my cursory first look, I can already see some areas for improvement. In particular, the documentation seems particularly bare bones. Critically, the available documentation does not tell me what the code does nor how to use it.
My personal rule of thumb to identify good documentation is to see if I could use the code just looking at the documentation. Currently, this is not possible. I will open an issue in your repo regarding this. I am looking forward to diving into your package! |
@Sbozzolo thanks for your initial review! Apologies for the |
Review checklist for @SbozzoloConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@editorialbot add @cmbiwer as reviewer |
@cmbiwer added to the reviewers list! |
I'll start reviewing and filling out the checklist on Friday. |
Review checklist for @cmbiwerConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
I added some comments to the issue @Sbozzolo started here: a-renzini/pygwb#1 I reviewed it without looking at @Sbozzolo review. And ended up with many of the same issues. I worked around some of the issues with the installation to try the test suite. I added a couple more things to that already existing issue on pygwb. |
@Sbozzolo @cmbiwer thank you so much for you initial reviews! I appreciate you making an issue on the upstream repo to keep track of specific suggestions You can also feel free to open separate issues for each individual suggestion, rather than having a single large issue. @a-renzini please begin addressing the issues raised by the reviewers. Once you feel you have addressed them adequately, you can reply to this thread. Let me know if you have any questions! |
The existence of two nearly identical public repositories (https://github.com/a-renzini/pygwb/, https://git.ligo.org/pygwb/pygwb) is a little bit confusing. Which one is the "real" one? If you want to continue the development on GitLab but also want to be on GitHub, maybe you can consider mirroring the repository instead of creating a separate one? |
Hello @Sbozzolo - that is exactly what I've done; the GitHub is a mirror of the GitLab! We are currently developing on GitLab. |
It doesn't look like that the mirroring is working properly: the latest commit on GitLab is 36e6550eb5622d4456861b46c10c047163d394a5, but this commit does not exist on GitHub. Also, if the repo on GitHub is just a mirror, I'd recommend pointing users to the GitLab repo in the readme (and maybe renaming the repo to pygwb-mirror, see, e.g., https://github.com/emacs-mirror/emacs). Your JOSS submission says that the link to the repo is the GitHub one, so maybe we should amend that too. |
That is odd! I have just checked, and indeed the mirror failed a month ago. I will get that fixed asap. I'll look into pointing/renaming as suggested. This does bring up a more top-level question though: during initial submission (which was a while ago now) we fixed the version for review to v1.0.0, which is the one associated to the ApJ paper. Shall we review this version for the JOSS paper, or shall we review the most up-to-date version? This will make a difference to the documentation. We don't have strong feelings either way; I don't know what the standard for JOSS papers is (whether the paper is linked to a specific version of the code, or whether it is meant to be somewhat general). |
I have now fixed the mirroring. sorry about that. |
@Sbozzolo I realise this wasn't obvious: the new documentation is produced as a pages job in github, and lives here: https://a-renzini.github.io/pygwb/ once we are happy with it, I will merge it into gitlab and it will be produced as a gitlab pages job. |
👋 @openjournals/aass-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#5064, then you can now move forward with accepting the submission by compiling again with the command |
@a-renzini — Looking good! I've opened one small PR then I think we should be good to go. |
@dfm I saw the update astropy PR - should be merged. |
@editorialbot generate pdf |
@editorialbot check references |
|
@dfm done :) |
@editorialbot generate pdf |
@editorialbot recommend-accept |
|
|
👋 @openjournals/aass-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#5065, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
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
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. |
🐘🐘🐘 👉 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... |
Many thanks to @Sbozzolo and @cmbiwer for reviewing and to @plaplant for editing! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you!! @a-renzini — Your paper is now accepted and published in JOSS! ⚡🚀💥 |
🎉🎉🎉 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: @a-renzini (Arianna Renzini)
Repository: https://github.com/a-renzini/pygwb/
Branch with paper.md (empty if default branch): joss_submission
Version: v1.4.0
Editor: @plaplant
Reviewers: @Sbozzolo, @cmbiwer
Archive: 10.5281/zenodo.10532825
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
@Sbozzolo, 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 @plaplant 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 @Sbozzolo
📝 Checklist for @cmbiwer
The text was updated successfully, but these errors were encountered: