[REVIEW]: lhorizon: geometry and targeting via JPL Horizons

whedon commented 3 years ago

Submitting author: @m-stclair (Michael St. Clair) Repository: https://github.com/MillionConcepts/lhorizon Version: 1.0.0 Editor: @arfon Reviewer: @malmans2, @steo85it Archive: 10.5281/zenodo.5504214

:warning: JOSS reduced service mode :warning:

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

Status badge code:

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

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

@malmans2 & @steo85it, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

Make sure you're logged in to your GitHub account
Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @arfon 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 ✨

Review checklist for @malmans2

Conflict of interest

[x] 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

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@m-stclair) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] 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

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[x] 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

[x] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[x] 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 and who the target audience is?
[x] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[x] 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?

Review checklist for @steo85it

Conflict of interest

[x] 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

[x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

[x] Repository: Is the source code for this software available at the repository url?
[x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
[x] Contribution and authorship: Has the submitting author (@m-stclair) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
[x] Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

[x] Installation: Does installation proceed as outlined in the documentation?
[x] Functionality: Have the functional claims of the software been confirmed?
[x] 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

[x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
[x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
[x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
[x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
[x] Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
[x] 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

[x] Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
[x] 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 and who the target audience is?
[x] State of the field: Do the authors describe how this software compares to other commonly-used packages?
[x] Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
[x] 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?

whedon commented 3 years ago

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @malmans2, @steo85it it looks like you're currently assigned to review this paper :tada:.

:warning: JOSS reduced service mode :warning:

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

:star: Important :star:

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

whedon commented 3 years ago

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.06 s (573.4 files/s, 77666.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          24            254            529           1591
Markdown                         4            249              0            821
HCL                              1            180              0            427
Jupyter Notebook                 3              0            430            120
TeX                              1             11              1             90
YAML                             2              0              0             38
-------------------------------------------------------------------------------
SUM:                            35            694            960           3087
-------------------------------------------------------------------------------

Statistical information for the repository '3248759cf4c8ca9efd34b58a' was
gathered on 2021/07/15.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
m-stclair                        1           309             22            0.90
michael                          2           691              2            1.89
mstclair@millionconc            23         18486          17088           97.20

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
mstclair@millionconc       2374           12.8          0.8               10.11

whedon commented 3 years ago

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

OK DOIs

- 10.3847/1538-3881/aafc33 is OK
- doi.org/10.21105/joss.02050 is OK
- 10.3847/1538-3881/aabc4f is OK

MISSING DOIs

- None

INVALID DOIs

- None

whedon commented 3 years ago

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

arfon commented 3 years ago

@malmans2, @steo85it – This is the review thread for the paper. All of our communications will happen here from now on.

Please read the "Reviewer instructions & questions" in the first comment above.

Both reviewers have checklists at the top of this thread (in that first comment) with the JOSS requirements. 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 https://github.com/openjournals/joss-reviews/issues/3495 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 make a start well 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.

whedon commented 3 years ago

:wave: @steo85it, please update us on how your review is going (this is an automated reminder).

whedon commented 3 years ago

:wave: @malmans2, please update us on how your review is going (this is an automated reminder).

steo85it commented 3 years ago

@arfon Hi, sorry for the late arrival (ignoring the conversation as suggested resulted in "really missing any update" somehow)... I'm getting to the review now but it seems that the invitation link has expired. If still useful, could you please issue a new one? Thanks!

danielskatz commented 3 years ago

@whedon re-invite @steo85it as reviewer

whedon commented 3 years ago

OK, the reviewer has been re-invited.

@steo85it please accept the invite by clicking this link: https://github.com/openjournals/joss-reviews/invitations

malmans2 commented 3 years ago

@whedon generate pdf

whedon commented 3 years ago

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

steo85it commented 3 years ago

Just FYI, I'm out of office (w/o laptop) most of this week. I'll review your changes asap. (What I quickly saw looks good though, thanks)

malmans2 commented 3 years ago

@arfon all my comments have been addressed by the authors and I think lhorizon is suitable for publication! The package is in line with all best practices for open source software and I'm sure many users will find lhorizon very useful!

steo85it commented 3 years ago

@arfon Same here, all my comments have been addressed and I'd recommend this useful package (and related paper) for publication. Thanks for inviting me to take part to this interesting process!

arfon commented 3 years ago

@malmans2 & @steo85it – many thanks for your updates!

@steo85it – could you check off the last remaining items in your review checklist?

steo85it commented 3 years ago

@arfon Done, sorry!

arfon commented 3 years ago

@whedon generate pdf

whedon commented 3 years ago

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

arfon commented 3 years ago

@m-stclair – could you please merge this PR which fixes a few issues with the current paper: https://github.com/MillionConcepts/lhorizon/pull/26

After that, could you make a new release of this software that includes the changes that have resulted from this review. Then, please make an archive of the software in Zenodo/figshare/other service and update this thread with the DOI of the archive? For the Zenodo/figshare archive, please make sure that:

The title of the archive is the same as the JOSS paper title
That the authors of the archive are the same as the JOSS paper authors

I can then move forward with accepting the submission.

m-stclair commented 3 years ago

@arfon - I have accepted your PR and archived the software in Zenodo. The DOI is 10.5281/zenodo.550421. Thank you for your assistance!

arfon commented 3 years ago

@whedon set 10.5281/zenodo.550421 as archive

whedon commented 3 years ago

OK. 10.5281/zenodo.550421 is the archive.

arfon commented 3 years ago

@whedon set 10.5281/zenodo.5504214 as archive

whedon commented 3 years ago

OK. 10.5281/zenodo.5504214 is the archive.

arfon commented 3 years ago

@whedon recommend-accept

whedon commented 3 years ago

Attempting dry run of processing paper acceptance...

whedon commented 3 years ago

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

OK DOIs

- 10.3847/1538-3881/aafc33 is OK
- 10.21105/joss.02050 is OK
- 10.3847/1538-3881/aabc4f is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.5281/zenodo.3509134 is OK

MISSING DOIs

- None

INVALID DOIs

- None

whedon commented 3 years ago

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

Check final proof :point_right: https://github.com/openjournals/joss-papers/pull/2585

If the paper PDF and Crossref deposit XML look good in https://github.com/openjournals/joss-papers/pull/2585, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

arfon commented 3 years ago

@whedon accept deposit=true

whedon commented 3 years ago

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

whedon commented 3 years ago

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

whedon commented 3 years ago

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

Here's what you must now do:

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

Any issues? Notify your editorial technical team...

arfon commented 3 years ago

@malmans2, @steo85it – many thanks 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 ✨

@m-stclair – your paper is now accepted and published in JOSS :zap::rocket::boom:

whedon commented 3 years ago

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

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

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

This is how it will look in your documentation:

We need your help!

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://joss.theoj.org/reviewer-signup.html
Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

m-stclair commented 3 years ago

@arfon awesome, thank you! one final request -- I hadn't actually noticed the tags on this issue -- would it be possible for you to remove the HCL / Tcl tags from the article page? GitHub misrecognizes SPICE kernels as code in those languages. If not, I doubt it will cause much confusion.

arfon commented 3 years ago

@arfon awesome, thank you! one final request -- I hadn't actually noticed the tags on this issue -- would it be possible for you to remove the HCL / Tcl tags from the article page? GitHub misrecognizes SPICE kernels as code in those languages. If not, I doubt it will cause much confusion.

Yep, that's done now.

m-stclair commented 3 years ago

Thanks very much. On Mon, Sep 13, 2021 at 17:00 Arfon Smith @.***> wrote:

@arfon https://github.com/arfon awesome, thank you! one final request -- I hadn't actually noticed the tags on this issue -- would it be possible for you to remove the HCL / Tcl tags from the article page? GitHub misrecognizes SPICE kernels as code in those languages. If not, I doubt it will cause much confusion.

Yep, that's done now.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/openjournals/joss-reviews/issues/3495#issuecomment-918571775, or unsubscribe https://github.com/notifications/unsubscribe-auth/APIXBZL4ECZ7QAYHWGEREGLUBZRABANCNFSM5ANOEXBQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

openjournals / joss-reviews