[REVIEW]: Astronomical échelle spectroscopy data analysis with muler

[editorialbot]

Submitting author: @gully (Michael Gully-Santiago)
Repository: https://github.com/OttoStruve/muler
Branch with paper.md (empty if default branch):
Version: v0.3.4
Editor: @xuanxu
Reviewers: @bmorris3, @wtgee
Archive: 10.5281/zenodo.6539458

Status

Status badge code:

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

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

@bmorris3 & @wtgee, 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 @xuanxu 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 @wtgee

📝 Checklist for @bmorris3

[editorialbot]

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]

Software report:

github.com/AlDanial/cloc v 1.88  T=0.13 s (382.7 files/s, 187077.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
TeX                              5           1458           1268          12598
Python                          11            547            587           1621
Jupyter Notebook                15              0           4698            467
YAML                             5              9             10            169
Markdown                         4             45              0            120
reStructuredText                 5            106             62            116
DOS Batch                        1              8              1             26
make                             2              5             11             21
INI                              1              0              0              2
-------------------------------------------------------------------------------
SUM:                            49           2178           6637          15140
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

[editorialbot]

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

OK DOIs

- 10.1088/0004-637X/812/2/128 is OK
- 10.1117/12.2056431 is OK
- 10.1117/12.2312345 is OK
- 10.1117/12.317283 is OK
- 10.1117/12.395422 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.5281/zenodo.3509134 is OK
- 10.3847/1538-3881/aabc4f is OK
- 10.1051/0004-6361/201322068 is OK
- 10.3847/1538-3881/ab40a7 is OK
- 10.1117/12.926102 is OK
- 10.1117/12.2056417 is OK
- 10.1117/12.2313835 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.5281/zenodo.845059 is OK
- 10.21105/joss.03095 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

Wordcount for paper.md is 1030

[editorialbot]

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

[wtgee]

Review checklist for @wtgee

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

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/OttoStruve/muler?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@gully) 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

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.
• 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 and who the target audience is?
• 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?

[bmorris3]

Review checklist for @bmorris3

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

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/OttoStruve/muler?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@gully) 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

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.
• 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 and who the target audience is?
• 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?

[bmorris3]

@xuanxu I've completed my review, this submission looks fantastic. Excellent work, @gully et al.!

[xuanxu]

@bmorris3 great, thanks!

[gully]

Thank you all for the reviewing and editing process. We would like to add a coauthor who contributed code during the JOSS review process. I have made the coauthor addition on the paper.md in the main branch of the repo.

Thank you all again 🙏

[wtgee]

Thanks for addressing my issues @gully. I'll try to finish up my review today.

[wtgee]

@gully I finished off the review and added a few minor issues as well as OttoStruve/muler#108, which prevents me from running two of the notebooks from a clean install. If I manually fix that issue the two notebooks don't have any other issues.

I've checked off all the boxes for my review but that Issue above should get fixed before final approval. The other minor grammatical issues don't affect the review.

[wtgee]

Thanks @gully, things look good on my end.

@xuanxu my review is complete as well. Thanks!

[xuanxu]

@wtgee Thank you!

[xuanxu]

@editorialbot generate pdf

[xuanxu]

@editorialbot check references

[editorialbot]

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

OK DOIs

- 10.1088/0004-637X/812/2/128 is OK
- 10.1117/12.2056431 is OK
- 10.1117/12.2312345 is OK
- 10.1117/12.317283 is OK
- 10.1117/12.395422 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.5281/zenodo.3509134 is OK
- 10.3847/1538-3881/aabc4f is OK
- 10.1051/0004-6361/201322068 is OK
- 10.3847/1538-3881/ab40a7 is OK
- 10.1117/12.926102 is OK
- 10.1117/12.2056417 is OK
- 10.1117/12.2313835 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.5281/zenodo.845059 is OK
- 10.21105/joss.03095 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

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

[xuanxu]

OK @gully, everything looks good, here are the next steps:

• Please release a new tagged version from the current main branch so it includes all the changes made during the review process
• Then archive that latest release in Zenodo or a similar service
• Check the Zenodo deposit has the correct metadata: title and authors names should match the paper; you may also add authors' ORCIDs.

Once you do that please report here the version number and archive DOI

[gully]

Version number is v0.3.4, here is the link to Zenodo:

https://zenodo.org/record/6539458#.YnvVcy-B1pQ

[xuanxu]

@editorialbot set v0.3.4 as version

[editorialbot]

Done! version is now v0.3.4

[xuanxu]

@editorialbot set 10.5281/zenodo.6539458 as archive

[editorialbot]

Done! Archive is now 10.5281/zenodo.6539458

[xuanxu]

Thank you @gully. We're all set. Recommending for acceptance.

[xuanxu]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

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

OK DOIs

- 10.1088/0004-637X/812/2/128 is OK
- 10.1117/12.2056431 is OK
- 10.1117/12.2312345 is OK
- 10.1117/12.317283 is OK
- 10.1117/12.395422 is OK
- 10.1038/s41586-020-2649-2 is OK
- 10.5281/zenodo.3509134 is OK
- 10.3847/1538-3881/aabc4f is OK
- 10.1051/0004-6361/201322068 is OK
- 10.3847/1538-3881/ab40a7 is OK
- 10.1117/12.926102 is OK
- 10.1117/12.2056417 is OK
- 10.1117/12.2313835 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.5281/zenodo.845059 is OK
- 10.21105/joss.03095 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

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

Check final proof 👉 openjournals/joss-papers#3210

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3210, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

[arfon]

@editorialbot accept

[editorialbot]

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

[editorialbot]

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

[editorialbot]

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

Here's what you must now do:

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

Any issues? Notify your editorial technical team...

[arfon]

@bmorris3, @wtgee – many thanks for your reviews here and to @xuanxu for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@gully – your paper is now accepted and published in JOSS ⚡🚀💥

[editorialbot]

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

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

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

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