Skip to content
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]: BayesEoR: Bayesian 21-cm Power Spectrum Estimation from Interferometric Visibilities #6667

Closed
editorialbot opened this issue Apr 23, 2024 · 62 comments
Assignees
Labels
accepted C published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 1 (AASS) Astronomy, Astrophysics, and Space Sciences

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Apr 23, 2024

Submitting author: @jburba (Jacob Burba)
Repository: https://github.com/PSims/BayesEoR
Branch with paper.md (empty if default branch):
Version: 1.0.0
Editor: @dfm
Reviewers: @musoke, @zonca
Archive: 10.5281/zenodo.13912275

Status

status

Status badge code:

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

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

@musoke & @zonca, 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 @dfm 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 @musoke

📝 Checklist for @zonca

@editorialbot
Copy link
Collaborator Author

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:

@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
Copy link
Collaborator Author

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

OK DOIs

- 10.1093/mnras/stw1768 is OK
- 10.1093/mnras/stz153 is OK
- 10.1093/mnras/stz1888 is OK
- 10.1093/mnras/stad401 is OK
- 10.1093/mnras/staa327 is OK
- 10.1093/mnras/staa414 is OK
- 10.3847/1538-4357/ac1c78 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.06 s (628.5 files/s, 162597.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          25            916           3160           5451
reStructuredText                 5            126             61            128
TeX                              1              6              0            117
Markdown                         2             41              0            114
YAML                             4              6             24             73
TOML                             1              4              0             35
C                                1             15             23             28
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            40           1118           3275           5955
-------------------------------------------------------------------------------

Commit count by author:

   333	jburba
    25	Jacob Burba
    19	PSims

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 589

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

🔴 Failed to discover a valid open source license

@dfm
Copy link

dfm commented Apr 23, 2024

@musoke, @zonca — This is the review thread for the paper. All of our correspondence will happen here from now on. Thanks again for agreeing to participate!

👉 Please read the "Reviewer instructions & questions" in the first comment above, and generate your checklists by commenting @editorialbot generate my checklist on this issue ASAP. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#6667 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for the review process to be completed within about 4-6 weeks but please try to make a start ahead of this as JOSS reviews are by their nature iterative and any early feedback you may be able to provide to the author will be very helpful in meeting this schedule. Please get your review started as soon as possible!

@editorialbot
Copy link
Collaborator Author

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

@dfm
Copy link

dfm commented Apr 23, 2024

@jburba — I should have caught this before, but it looks like your code is not licensed. You'll need to add an appropriate open source license before we can proceed. https://choosealicense.com can be a useful resource.

@jburba
Copy link

jburba commented Apr 23, 2024

Thanks @dfm , we forgot to add that. I've added a license to the repo.

@musoke
Copy link

musoke commented Apr 23, 2024

Review checklist for @musoke

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/PSims/BayesEoR?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@jburba) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
    • Names of dependencies are given in environment.yaml. It wouldn't hurt to specify version numbers.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@zonca
Copy link

zonca commented Apr 24, 2024

Review checklist for @zonca

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/PSims/BayesEoR?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@jburba) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

Documentation

Software paper

PSims/BayesEoR#25

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@zonca
Copy link

zonca commented Apr 24, 2024

@jburba I opened issues on the repository with some feedback, the only one which is blocking is PSims/BayesEoR#20, if you focus first on this issue, I can continue trying to run the example config. I was able to build the matrix stack, but cannot run sampling.

@zonca
Copy link

zonca commented Apr 24, 2024

@jburba @dfm finished my review and opened issues for follow-up on what I found, all linked in the review checklist. Once the issues are addressed (which doesn't necessarily mean we implement what I suggest, we could also agree something is a longer term goal), I think this is good for publication. Thanks!

@musoke
Copy link

musoke commented Apr 25, 2024

@jburba, would you like to respond to some of @zonca's requests before I finish my review? As is, I expect that many of my comments will be agreement that installation should be simplified/clarified.

(@dfm, let me know if this would be procedurally problematic 😃)

@jburba
Copy link

jburba commented Apr 25, 2024

@musoke yes, I can respond to @zonca's requests first, that's fine. I will note in my current job I only have ~1 day a week for independent research (which this falls under). Apologies in advance if I'm a bit slow to respond at times!

@dfm
Copy link

dfm commented Apr 26, 2024

Thanks all!

@musoke — I'd probably recommend that you see how far you can get with your review, as long as @zonca's issues aren't full blockers (it does seem like the installation one might be?). That way @jburba could work on addressing all the comments in parallel. Otherwise this could end up dragging on longer than we want. But you are all welcome to proceed as you feel is best for everyone involved!

@zonca
Copy link

zonca commented May 10, 2024

Good job @jburba, my review is finished,
there are 3 open issues that I think would be good to address, but I do not think they are blocking.

@musoke I think you can get started, you might want to check the 3 issues I left open in the repo to see if you feel those should be addressed before publication or not: https://github.com/PSims/BayesEoR/issues/created_by/zonca

@dfm
Copy link

dfm commented May 17, 2024

@musoke — Just a ping to make sure this is on your radar. Please revisit ASAP. Thank you!

@musoke
Copy link

musoke commented Jun 5, 2024

I have finished my review.

Summary: it's a nice package but there are some outstanding issues to address.

@dfm
Copy link

dfm commented Jun 23, 2024

@musoke, @zonca — It looks like @jburba has responded to the issues that you opened on the BayesEoR repo. Can you take a look soon and update your checklists / respond to those comments accordingly soon? Thanks!!

@zonca
Copy link

zonca commented Jun 24, 2024

Thank you. I completed my checklist

@dfm
Copy link

dfm commented Nov 3, 2024

@editorialbot set 10.5281/zenodo.13912275 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.13912275

@dfm
Copy link

dfm commented Nov 3, 2024

@editorialbot check references

@dfm
Copy link

dfm commented Nov 3, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1093/mnras/stw1768 is OK
- 10.1093/mnras/stz153 is OK
- 10.1093/mnras/stz1888 is OK
- 10.1093/mnras/stad401 is OK
- 10.1093/mnras/staa327 is OK
- 10.1093/mnras/staa414 is OK
- 10.3847/1538-4357/ac1c78 is OK
- 10.21105/joss.00140 is OK
- 10.1051/0004-6361/201322971 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@dfm
Copy link

dfm commented Nov 3, 2024

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1093/mnras/stw1768 is OK
- 10.1093/mnras/stz153 is OK
- 10.1093/mnras/stz1888 is OK
- 10.1093/mnras/stad401 is OK
- 10.1093/mnras/staa327 is OK
- 10.1093/mnras/staa414 is OK
- 10.3847/1538-4357/ac1c78 is OK
- 10.21105/joss.00140 is OK
- 10.1051/0004-6361/201322971 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @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#6087, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Nov 3, 2024
@dfm
Copy link

dfm commented Nov 3, 2024

@musoke, @zonca — Many thanks again for your reviews here! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you!!

@jburba — I have now handed your paper off for a final review by the track editor @warrickball, who may have some final edits before publication. Thanks again for your patience!

@warrickball
Copy link

Hi @jburba — I've been quietly working through a few checks but I do apologise for the slightly slow response to this. I've opened a pull request with a few final editorial touches. With those implemented I'll test the metadata generation one more time then almost certainly be able to proceed with publication.

@jburba
Copy link

jburba commented Nov 18, 2024

Hi @warrickball , we've merged your pull request, thanks for the edits. If you need anything else from us please let us know!

@warrickball
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.1093/mnras/stw1768 is OK
- 10.1093/mnras/stz153 is OK
- 10.1093/mnras/stz1888 is OK
- 10.1093/mnras/stad401 is OK
- 10.1093/mnras/staa327 is OK
- 10.1093/mnras/staa414 is OK
- 10.3847/1538-4357/ac1c78 is OK
- 10.21105/joss.00140 is OK
- 10.1051/0004-6361/201322971 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @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#6152, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@warrickball
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

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: Sims
  given-names: Peter H.
  orcid: "https://orcid.org/0000-0002-2871-0413"
- family-names: Burba
  given-names: Jacob
  orcid: "https://orcid.org/0000-0002-8465-9341"
- family-names: Pober
  given-names: Jonathan C.
  orcid: "https://orcid.org/0000-0002-3492-0433"
contact:
- family-names: Burba
  given-names: Jacob
  orcid: "https://orcid.org/0000-0002-8465-9341"
doi: 10.5281/zenodo.13912275
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Sims
    given-names: Peter H.
    orcid: "https://orcid.org/0000-0002-2871-0413"
  - family-names: Burba
    given-names: Jacob
    orcid: "https://orcid.org/0000-0002-8465-9341"
  - family-names: Pober
    given-names: Jonathan C.
    orcid: "https://orcid.org/0000-0002-3492-0433"
  date-published: 2024-11-18
  doi: 10.21105/joss.06667
  issn: 2475-9066
  issue: 103
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6667
  title: "BayesEoR: Bayesian 21-cm Power Spectrum Estimation from
    Interferometric Visibilities"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06667"
  volume: 9
title: "BayesEoR: Bayesian 21-cm Power Spectrum Estimation from
  Interferometric Visibilities"

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
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

🦋🦋🦋 👉 Bluesky post for this paper 👈 🦋🦋🦋

@editorialbot
Copy link
Collaborator Author

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

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.06667 joss-papers#6153
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06667
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Nov 18, 2024
@warrickball
Copy link

Thanks once again to @musoke & @zonca for reviewing and @dfm for editing this submission! JOSS simply wouldn't be possible without its community of volunteers.

Congratulations @jburba, your paper has been published in JOSS!

@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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

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

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

This is how it will look in your documentation:

DOI

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted C published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 1 (AASS) Astronomy, Astrophysics, and Space Sciences
Projects
None yet
Development

No branches or pull requests

7 participants