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]: Shapelets: A Python package implementing shapelet functions and their applications #6058

Closed
editorialbot opened this issue Nov 13, 2023 · 63 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 3 (PE) Physics and Engineering

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Nov 13, 2023

Submitting author: @nasserma (Nasser Mohieddin Abukhdeir)
Repository: https://github.com/uw-comphys/shapelets
Branch with paper.md (empty if default branch): publications
Version: v1.0
Editor: @kyleniemeyer
Reviewers: @tbmiller-astro, @Anshuman5
Archive: 10.5281/zenodo.10819578

Status

status

Status badge code:

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

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

@tbmiller-astro & @Anshuman5, 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 @AoifeHughes 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 @tbmiller-astro

📝 Checklist for @Anshuman5

@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

Software report:

github.com/AlDanial/cloc v 1.88  T=0.02 s (708.9 files/s, 72487.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                         3            131              0            220
TeX                              1             16              0            177
Python                           6            138            350            173
YAML                             1              1              0             18
TOML                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            12            286            350            591
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 2379

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1111/j.1365-2966.2005.09453.x is OK
- 10.1088/1361-6528/aaf353 is OK
- 10.1103/physreve.91.033307 is OK
- 10.1093/mnras/stz787 is OK
- 10.1088/2053-1591/3/8/082001 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1364/opex.12.005760 is OK
- 10.1007/s10827-008-0107-5 is OK
- 10.1152/jn.00498.2005 is OK
- 10.1088/0004-637x/813/2/102 is OK
- 10.1093/mnras/stu2611 is OK
- 10.1007/978-1-4612-2812-7_1 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@tbmiller-astro
Copy link

tbmiller-astro commented Nov 13, 2023

Review checklist for @tbmiller-astro

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/uw-comphys/shapelets?
  • 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 (@nasserma) 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.
  • 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?

@nasserma
Copy link

Software report:

github.com/AlDanial/cloc v 1.88  T=0.02 s (708.9 files/s, 72487.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                         3            131              0            220
TeX                              1             16              0            177
Python                           6            138            350            173
YAML                             1              1              0             18
TOML                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            12            286            350            591
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@AoifeHughes Could this software report be rerun, I am relatively sure it was using the publications branch of the repository, which did not have up-to-date code, I just merged it with the main branch and if the report is run now it will reflect the actual number of source files, lines of code, comments, etc.

@AoifeHughes
Copy link

@editorialbot check repository

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.04 s (703.1 files/s, 107182.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          15            485           1095            940
reStructuredText                 4            255             82            342
Markdown                         3            141              0            256
TeX                              1             16              0            177
YAML                             1              1              0             18
TOML                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            25            898           1177           1736
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 2379

@AoifeHughes
Copy link

@tbmiller-astro, @Anshuman5 how are the reviews coming along?

@Anshuman5
Copy link

Anshuman5 commented Dec 5, 2023

Review checklist for @Anshuman5

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/uw-comphys/shapelets?
  • 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 (@nasserma) 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.
  • 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?

@Anshuman5
Copy link

@AoifeHughes reviews will take another 2-3 weeks.

@tbmiller-astro
Copy link

@AoifeHughes I have some time the next few days and hope to be done the initial review by the end of the week

@tbmiller-astro
Copy link

Hi, I was actually able to get my initial review done this afternoon. The package overall looks great, well done @nasserma and the other authors.

There are a few issues I found. Two major ones to do with missing tests/ folder and need for more API documentation that I created issues for on the package's GitHub page.

@mptino
Copy link

mptino commented Dec 6, 2023

Hi @tbmiller-astro - thanks for the comments. I closed one issue regarding the unit testing and shapelets-test entry point (which is now functional) and uploaded a set of minimal tests for basic functionality of the package. More unit tests will appear in the coming weeks.

@nasserma
Copy link

nasserma commented Dec 7, 2023

I closed one issue regarding the unit testing

@mptino I re-opened this issue, once @tbmiller-astro is satisfied we can close it.

@nasserma
Copy link

@tbmiller-astro @Anshuman5 We are working through these issues this week and should have most of the issues address by the end of the year, sorry for the wait!

@nasserma
Copy link

@tbmiller-astro @Anshuman5 We have addressed all of the issues that you have brought-up with the package, please see more detailed descriptions in the responses to those issues. Is there anything else we should address as part of the first round of review comments?

@Anshuman5
Copy link

@nasserma thank you for fixing the issues. I do not have any additional comments. Also, I have updated the review checklist above.

@nasserma
Copy link

@nasserma thank you for fixing the issues. I do not have any additional comments. Also, I have updated the review checklist above.

@Anshuman5 thanks for your efforts!

@tbmiller-astro
Copy link

Well done @nasserma and the other authors, my checklist is completed now too and I have no further issues.

@nasserma
Copy link

Thanks @tbmiller-astro ! @AoifeHughes I think we addressed all of the reviewer comments, please let us know if anything else is needed, thanks.

@nasserma
Copy link

nasserma commented Feb 6, 2024

@AoifeHughes just checking in, are there any further actions on our part regarding the review?

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1111/j.1365-2966.2005.09453.x is OK
- 10.1088/1361-6528/ad1df4 is OK
- 10.1088/1361-6528/aaf353 is OK
- 10.1103/physreve.91.033307 is OK
- 10.1093/mnras/stz787 is OK
- 10.1088/2053-1591/3/8/082001 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1364/opex.12.005760 is OK
- 10.1007/s10827-008-0107-5 is OK
- 10.1152/jn.00498.2005 is OK
- 10.1088/0004-637x/813/2/102 is OK
- 10.1093/mnras/stu2611 is OK
- 10.1007/978-1-4612-2812-7_1 is OK

MISSING DOIs

- No DOI given, and none found for title: Shapelets—I. A method for image analysis
- No DOI given, and none found for title: High-precision timing of 42 millisecond pulsars wi...
- No DOI given, and none found for title: Advances in K-means clustering: a data mining thin...

INVALID DOIs

- None

@kyleniemeyer
Copy link

kyleniemeyer commented Mar 14, 2024

@nasserma it does look like DOIs might be available for two of those references, can you add?

  • Refregier 2003 paper on shapelets: 10.1046/j.1365-8711.2003.05901.x
  • Desvignes et al. 2016: 10.1093/mnras/stw483

No need to update the archive, just the paper.

@nasserma
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1046/j.1365-8711.2003.05901.x is OK
- 10.1111/j.1365-2966.2005.09453.x is OK
- 10.1088/1361-6528/ad1df4 is OK
- 10.1088/1361-6528/aaf353 is OK
- 10.1103/physreve.91.033307 is OK
- 10.1093/mnras/stz787 is OK
- 10.1088/2053-1591/3/8/082001 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1364/opex.12.005760 is OK
- 10.1007/s10827-008-0107-5 is OK
- 10.1152/jn.00498.2005 is OK
- 10.1088/0004-637x/813/2/102 is OK
- 10.1093/mnras/stu2611 is OK
- 10.1093/mnras/stw483 is OK
- 10.1007/978-3-642-29807-3 is OK
- 10.1007/978-1-4612-2812-7_1 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@nasserma
Copy link

@kyleniemeyer sorry for the oversights, they are corrected.

@kyleniemeyer
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.1046/j.1365-8711.2003.05901.x is OK
- 10.1111/j.1365-2966.2005.09453.x is OK
- 10.1088/1361-6528/ad1df4 is OK
- 10.1088/1361-6528/aaf353 is OK
- 10.1103/physreve.91.033307 is OK
- 10.1093/mnras/stz787 is OK
- 10.1088/2053-1591/3/8/082001 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1364/opex.12.005760 is OK
- 10.1007/s10827-008-0107-5 is OK
- 10.1152/jn.00498.2005 is OK
- 10.1088/0004-637x/813/2/102 is OK
- 10.1093/mnras/stu2611 is OK
- 10.1093/mnras/stw483 is OK
- 10.1007/978-3-642-29807-3 is OK
- 10.1007/978-1-4612-2812-7_1 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/pe-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#5141, 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 Mar 17, 2024
@kyleniemeyer
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.1046/j.1365-8711.2003.05901.x is OK
- 10.1111/j.1365-2966.2005.09453.x is OK
- 10.1088/1361-6528/ad1df4 is OK
- 10.1088/1361-6528/aaf353 is OK
- 10.1103/physreve.91.033307 is OK
- 10.1093/mnras/stz787 is OK
- 10.1088/2053-1591/3/8/082001 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1364/opex.12.005760 is OK
- 10.1007/s10827-008-0107-5 is OK
- 10.1152/jn.00498.2005 is OK
- 10.1088/0004-637x/813/2/102 is OK
- 10.1093/mnras/stu2611 is OK
- 10.1093/mnras/stw483 is OK
- 10.1007/978-3-642-29807-3 is OK
- 10.1007/978-1-4612-2812-7_1 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@nasserma
Copy link

@kyleniemeyer could we have the rest of the day to go through the manuscript, just one last proof?

@kyleniemeyer
Copy link

@nasserma sure thing. I'll plan to finalize tomorrow

@nasserma
Copy link

@kyleniemeyer thanks, we have made many minor typographical and grammatical corrections, we think the manuscript is finalized.

@kyleniemeyer
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@kyleniemeyer
Copy link

looks good to me!

@kyleniemeyer
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: Tino
  given-names: Matthew Peres
  orcid: "https://orcid.org/0009-0005-6832-1761"
- family-names: Abdulaziz
  given-names: Abbas Yusuf
- family-names: Suderman
  given-names: Robert
- family-names: Akdeniz
  given-names: Thomas
- family-names: Abukhdeir
  given-names: Nasser Mohieddin
  orcid: "https://orcid.org/0000-0002-1772-0376"
contact:
- family-names: Abukhdeir
  given-names: Nasser Mohieddin
  orcid: "https://orcid.org/0000-0002-1772-0376"
doi: 10.5281/zenodo.10819578
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Tino
    given-names: Matthew Peres
    orcid: "https://orcid.org/0009-0005-6832-1761"
  - family-names: Abdulaziz
    given-names: Abbas Yusuf
  - family-names: Suderman
    given-names: Robert
  - family-names: Akdeniz
    given-names: Thomas
  - family-names: Abukhdeir
    given-names: Nasser Mohieddin
    orcid: "https://orcid.org/0000-0002-1772-0376"
  date-published: 2024-03-18
  doi: 10.21105/joss.06058
  issn: 2475-9066
  issue: 95
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6058
  title: "Shapelets: A Python package implementing shapelet functions
    and their applications"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06058"
  volume: 9
title: "Shapelets: A Python package implementing shapelet functions and
  their applications"

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

🚨🚨🚨 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.06058 joss-papers#5145
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06058
  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 Mar 18, 2024
@kyleniemeyer
Copy link

Congratulations @nasserma on your article's publication in JOSS! Please consider signing up as a reviewer if you haven't already.

Many thanks to @tbmiller-astro and @Anshuman5 for reviewing this.

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

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

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

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 published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 3 (PE) Physics and Engineering
Projects
None yet
Development

No branches or pull requests

7 participants