editorialbot commented 9 months ago

Submitting author: !--author-handle-->@GalagaBits@ivastar<!--end-editor-- Reviewers: @evamariaa, @taylorbell57 Archive: 10.5281/zenodo.11115733

Status

Status badge code:

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

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

@evamariaa & @taylorbell57, 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 @ivastar 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 @evamariaa

📝 Checklist for @taylorbell57

GalagaBits commented 5 months ago

@ivastar @evamariaa, yes, I can fix this issue. This turned out to be a bug in the code that prevented animations from working. I am releasing a new version in a few minutes and I will update all notebooks in the folder to use the latest version of spelunker.

GalagaBits commented 5 months ago

@ivastar @evamariaa , Okay, I have updated the notebooks!

GalagaBits commented 5 months ago

@ivastar I have updated spelunker to 1.1.17! Is there a way to update the JOSS submission to have the latest version as well?

ivastar commented 5 months ago

@GalagaBits I will set the final version before publications. But before we get there I have some editorial comments for the manuscript. Please let me know if you have any questions. Ping me when the changes have been done and we will proceed with the post-review checklist.

Overall comments:

Throughout the text there are several compound words that I think should be written separately. "guide star", "light curve", "time series", "data models" (unless it refers to the datamodels library) I think should all be written as separate phrases (including in the title). Happy to be corrected if the JWST documentation for example consistently uses a different style but a brief look through the internet suggests separate words.
Figure 2 is mentioned before Figure 1 in the text. It is standard that figures should appear in the order in which they are referenced. Please either switch the order of the figures or change the text such that Figure 1 is mentioned first.
One of my colleagues pointed out that the mnemonics functionality is only available via a package that is currently not pip-installable and (as you point out in the documentation) needs to be separately installed by the user. May I suggest that you document this also in the paper, maybe on line 60 by adding something along the lines of "This functionality depends on the additional installation of the jwstuser library. " Or maybe @nespinoza can push that to pypi....

Smaller comments:

Line 10 "Through efficient" --> "through an efficient"
Line 13 "Gaussian parameter and flux time series" --> "Gaussian parameter, flux time series"
Line 18 "and on the JWST" --> "and in the JWST"
Line 25 "technique to detect" --> "method to detect"
Line 33 "uses guidestar to guide" --> "uses guide star to provide information to"
Line 36 "using this data" --> "using these data"
Line 43 typo in utilize
Line 49 "model's orientation" ==> "model orientation"
Line 60 "abilities" --> "capabilities"
Line 66-67 "than a guidestar timeseries" --> "than that"
Line 69 "and spelunker outputs" --> "and its outputs"
Caption of Figure 1, lines 1-2 "observation 1, and visit 1" --> "observations 1 and visit 1", just remove the comma
Caption of Figure 1, line 2, typo in "guidance"
Caption of Figure 1, last line: remove "likely" and maybe change "the functions" to "the core function", as I understand it you are actually demonstrating the that the position of the star is changing during the observations and the ACS is making corrections to try to keep it constant.

GalagaBits commented 5 months ago

@ivastar Sorry for the long reply! I just graduated! finished responding to all of the comments above in the latest commit.

ivastar commented 5 months ago

@editorialbot generate pdf

editorialbot commented 5 months ago

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

ivastar commented 5 months ago

@editorialbot check references

editorialbot commented 5 months ago

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

OK DOIs

- 10.1088/1538-3873/acd1b5 is OK
- 10.1117/12.926578 is OK
- 10.1117/12.2311973 is OK
- 10.1086/160554 is OK
- 10.1007/BF00648343 is OK

MISSING DOIs

- None

INVALID DOIs

- None

ivastar commented 5 months ago

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Double check authors and affiliations (including ORCIDs)
Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSS paper.
Archive the release on Zenodo/figshare/etc and post the DOI here.
Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

[x] Read the text of the paper and offer comments/corrections (as either a list or a pull request)
[x] Check that the archive title, author list, version tag, and the license are correct
[x] Set archive DOI with @editorialbot set <DOI here> as archive
[x] Set version with @editorialbot set <version here> as version
[x] Double check rendering of paper with @editorialbot generate pdf
[x] Specifically check the references with @editorialbot check references and ask author(s) to update as needed
[ ] Recommend acceptance with @editorialbot recommend-accept

GalagaBits commented 5 months ago

I just made another commit to the paper

GalagaBits commented 5 months ago

How do I archive the release on Zenodo?

GalagaBits commented 5 months ago

@ivastar Okay! I finished the additional author tasks!

Latest version number: v.1.1.17
Zenodo DOI: 10.5281/zenodo.11115733

ivastar commented 5 months ago

@editorialbot generate pdf

editorialbot commented 5 months ago

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

ivastar commented 5 months ago

@editorialbot set 10.5281/zenodo.11115733 as archive

editorialbot commented 5 months ago

Done! archive is now 10.5281/zenodo.11115733

ivastar commented 5 months ago

@editorialbot set v.1.1.17 as version

editorialbot commented 5 months ago

Done! version is now v.1.1.17

ivastar commented 5 months ago

@editorialbot generate pdf

editorialbot commented 5 months ago

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

ivastar commented 5 months ago

@editorialbot check references

editorialbot commented 5 months ago

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

OK DOIs

- 10.1088/1538-3873/acd1b5 is OK
- 10.1117/12.926578 is OK
- 10.1117/12.2311973 is OK
- 10.1086/160554 is OK
- 10.1007/BF00648343 is OK

MISSING DOIs

- None

INVALID DOIs

- None

ivastar commented 5 months ago

@editorialbot recommend-accept

editorialbot commented 5 months ago

Attempting dry run of processing paper acceptance...

editorialbot commented 5 months ago

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

OK DOIs

- 10.1088/1538-3873/acd1b5 is OK
- 10.1117/12.926578 is OK
- 10.1117/12.2311973 is OK
- 10.1086/160554 is OK
- 10.1007/BF00648343 is OK

MISSING DOIs

- None

INVALID DOIs

- None

editorialbot commented 5 months ago

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

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5308, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

ivastar commented 5 months ago

@GalagaBits and @nespinoza, congratulations on the publication of this paper! @evamariaa, @taylorbell57 thank you for your detailed review! Thank you all for the dedicated work on this paper and quick turnaround of all comments and revisions.

GalagaBits commented 5 months ago

Thank you all for reviewing our paper!! @ivastar, I noticed a small typo in line 53. I updated the paper again, is there a way to update the final paper where I did not format mnemonics correctly. Is there a way we can update the final paper again? I made the paper change to GitHub again.

ivastar commented 5 months ago

@dfm can look at this again when he does the actual publication.

GalagaBits commented 5 months ago

@ivastar That sounds great! So now I have to wait on @dfm to publish to JOSS?

ivastar commented 5 months ago

Yes, I recommended publication as the editor for this submission, @dfm is the editor in chief for the AASS track and he does the honors for the final publication.

dfm commented 5 months ago

I've opened another small PR with some last edits before publication, and after merging that, the other changes will also be incorporated!

GalagaBits commented 5 months ago

@dfm Okay! I have merged the pull request!!

dfm commented 5 months ago

@editorialbot generate pdf

editorialbot commented 5 months ago

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

dfm commented 5 months ago

@editorialbot recommend-accept

editorialbot commented 5 months ago

Attempting dry run of processing paper acceptance...

editorialbot commented 5 months ago

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

OK DOIs

- 10.1088/1538-3873/acd1b5 is OK
- 10.1117/12.926578 is OK
- 10.1117/12.2311973 is OK
- 10.1086/160554 is OK
- 10.1007/BF00648343 is OK

MISSING DOIs

- None

INVALID DOIs

- None

editorialbot commented 5 months ago

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

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5329, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

dfm commented 5 months ago

@editorialbot accept

editorialbot commented 5 months ago

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

editorialbot commented 5 months ago

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: Deal given-names: Derod orcid: "https://orcid.org/0009-0006-6758-4751" - family-names: Espinoza given-names: Néstor orcid: "https://orcid.org/0000-0001-9513-1449" doi: 10.5281/zenodo.11115733 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Deal given-names: Derod orcid: "https://orcid.org/0009-0006-6758-4751" - family-names: Espinoza given-names: Néstor orcid: "https://orcid.org/0000-0001-9513-1449" date-published: 2024-05-08 doi: 10.21105/joss.06202 issn: 2475-9066 issue: 97 journal: Journal of Open Source Software publisher: name: Open Journals start: 6202 title: "Spelunker: A quick-look Python pipeline for JWST NIRISS FGS Guide Star Data" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06202" volume: 9 title: "Spelunker: A quick-look Python pipeline for JWST NIRISS FGS Guide Star Data" ```

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 commented 5 months ago

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

editorialbot commented 5 months 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/5330
Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06202
If everything looks good, then close this review issue.
Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

dfm commented 5 months ago

Many thanks to @evamariaa and @taylorbell57 for reviewing and to @ivastar for editing! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you!!

@GalagaBits — Your paper is now accepted and published in JOSS! :zap::rocket::boom:

editorialbot commented 5 months 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.06202/status.svg)](https://doi.org/10.21105/joss.06202)

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

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

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:

Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://reviewers.joss.theoj.org/join
Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

GalagaBits commented 5 months ago

@editorialbot generate preprint

editorialbot commented 5 months ago

:page_facing_up: Preprint file created: Find it here in the Artifacts list :page_facing_up:

openjournals / joss-reviews

[REVIEW]: Spelunker: A quick-look Python pipeline for JWST NIRISS FGS Guidestar Data #6202

Status

Reviewer instructions & questions

Checklists

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

Editor Tasks Prior to Acceptance