openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
720 stars 38 forks source link

[PRE REVIEW]: PySHbundle: A Python implementation of GRACE Spherical Harmonics Synthesis MATLAB codes SHbundle #6651

Closed editorialbot closed 4 months ago

editorialbot commented 6 months ago

Submitting author: !--author-handle-->@mn5hk<!--end-author-handle-- (Amin Shakya) Repository: https://github.com/mn5hk/pyshbundle Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: Pending Reviewers: Pending Managing EiC: Kristen Thyng

Status

status

Status badge code:

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

Author instructions

Thanks for submitting your paper to JOSS @mn5hk. Currently, there isn't a JOSS editor assigned to your paper.

@mn5hk if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands
editorialbot commented 6 months ago

Hello human, 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 commented 6 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=0.39 s (261.3 files/s, 114676.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          65           3001           4874           5763
Jupyter Notebook                15              0          26509           2592
Markdown                        15            297              0            641
YAML                             4             10             10            414
TeX                              1             22              0            189
HTML                             1              2              0              9
-------------------------------------------------------------------------------
SUM:                           101           3332          31393           9608
-------------------------------------------------------------------------------

Commit count by author:

   173  Abhishek Mhamane
   170  Amin Shakya
    44  lsmvivek
    42  mn5hk
     3  Walling9
     1  Bramha Dutt Vishwakarma
editorialbot commented 6 months ago

Paper file info:

📄 Wordcount for paper.md is 4530

✅ The paper includes a Statement of need section

editorialbot commented 6 months ago

License info:

🟡 License found: Other (Check here for OSI approval)

editorialbot commented 6 months ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.5194/hgss-13-205-2022 may be a valid DOI for title: A review of different mascon approaches for region...
- 10.1111/j.1365-246x.1987.tb01659.x may be a valid DOI for title: Changes in the Earth’s rotation and low-degree gra...
- 10.3390/geosciences8090350 may be a valid DOI for title: GRACETOOLS—GRACE Gravity Field Recovery Tools
- No DOI given, and none found for title: Understanding filtering on the sphere: Experiences...
- 10.1007/1345_2015_5 may be a valid DOI for title: On the spatial resolution of homogeneous isotropic...
- 10.1007/s12145-018-0368-0 may be a valid DOI for title: GRAMAT: A comprehensive Matlab toolbox for estimat...
- 10.1007/s10712-022-09754-9 may be a valid DOI for title: Using Satellite-Based Terrestrial Water Storage Da...
- No DOI given, and none found for title: Theory of satellite geodesy, Blaisdell Publ
- 10.1007/s00190-009-0317-2 may be a valid DOI for title: Efficient propagation of error covariance matrices...
- No DOI given, and none found for title: Geophysical geodesy
- No DOI given, and none found for title: ggtools 1.1.7
- No DOI given, and none found for title: SHBUNDLE 2021
- 10.1016/j.cageo.2018.06.012 may be a valid DOI for title: SHADE: A MATLAB toolbox and graphical user interfa...
- No DOI given, and none found for title: GRACE-filter
- No DOI given, and none found for title: gravity-toolkit
- 10.1002/2016wr018960 may be a valid DOI for title: Minimizing the effects of filtering on catchment s...
- No DOI given, and none found for title: Understanding and repairing the signal damage due ...
- 10.1002/2017wr021150 may be a valid DOI for title: A data-driven approach for repairing the hydrologi...
- 10.3390/rs10060852 may be a valid DOI for title: What is the spatial resolution of GRACE satellite ...
- 10.3389/fenvs.2020.584690 may be a valid DOI for title: Monitoring droughts from GRACE
- 10.1029/98jb02844 may be a valid DOI for title: Time variability of the Earth’s gravity field: Hyd...
- 10.1029/2018gc007529 may be a valid DOI for title: SHTools: Tools for working with spherical harmonic...
- 10.1007/1345_2020_92 may be a valid DOI for title: LUH-GRACE2018: a new time series of monthly gravit...

INVALID DOIs

- None
editorialbot commented 6 months ago

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

kthyng commented 6 months ago

Hi @mn5hk and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any), or suggest reviewers. For reviewers, please suggest 5 reviewers from the database listed above or your own (non-conflicted) extended network. Their github handles are most useful to receive but please don't use "@" to reference them since it will prematurely ping them.

kthyng commented 6 months ago
mn5hk commented 6 months ago

Hi @mn5hk and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

  • [ ] Substantial scholarly effort
  • [ ] Documentation
  • [ ] Tests of some sort
  • [x] Installation instructions
  • [ ] Clear research application
  • [ ] Check paper
  • [ ] License

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any), or suggest reviewers. For reviewers, please suggest 5 reviewers from the database listed above or your own (non-conflicted) extended network. Their github handles are most useful to receive but please don't use "@" to reference them since it will prematurely ping them.

Hi @kthyng,

Thank you for handling the pre-review stage for our manuscript.

We would like to suggest the following 5 preferred reviewers. The proposed reviewers are experts in GRACE data processing and proficient Python programmers, and we believe them to be good candidates to review our submission. We managed to find the github-id for only one of the proposed reviewers:

  1. Eva Boergens
  2. Holger Steffen
  3. Sujata Goswami [github id:: SujataSaurabh]
  4. Khosro Gobadi-Far
  5. Matthias Weigelt

Thank you for your preliminary feedback. We will address them over time.

For now, I wanted to inquire about feedback on the JOSS paper formatting. Is it related to the missing dois (as reported by the editorial bot), something else editorial (.bib file, formatting of table, figures, etc.), or the length of the manuscript, section headers, etc.? Additionally, would this be something that is expected to be handled in the pre-review phase, or perhaps we can look into the formatting issues at a later stage? As I am new to submitting manuscripts to the journal, the above-mentioned queries will help our team address the paper formatting issues.

I will consult my co-authors, and start working on the pre-review feedback as soon as possible.

Thank you once again for your kind feedback on our submission, A. Shakya

kthyng commented 5 months ago

The reviewers aren't meant to be preferred but suggestions on who might be useful and relevant reviewers. Here is our conflict of interest statement for your review: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html#joss-conflict-of-interest-policy

Please suggest reviewers who have github ids — since the review process is entirely on github, the reviewers will need to be pretty familiar with github.

I suggest you add some information to your readme and if possible your title to describe to a wider audience the purpose of your software. Your paper has this information but most possible users won't probably won't get that far.

Paper: The references section is formatted incorrectly, the paper is too long, and the sections are set up for a traditional journal article instead of for a JOSS article. Please, read the formatting for our journal and abide by it now. I will keep this submission in pre-review until it is ready to move forward into review.

I see notebooks — why aren't these in the docs for a user to browse?

I see there is a test file but it is essentially empty. How is a user to verify that the software is running correctly?

kthyng commented 5 months ago

I am going to add the "paused" label while I wait to hear back.

mn5hk commented 5 months ago

Dear Dr. Thyng,

Thank you for your valuable feedback.

We will take some time to consider the feedback and update the manuscript and the codebase. I hope to get back to you in a month.

I will follow up on the thread again once the updated repository is ready for resubmission.

Best, A. Shakya

kthyng commented 4 months ago

Hi @mn5hk! How are things coming along? Unless you are essentially ready to move forward, I would suggest you to withdraw this submission with the intention of resubmitting at a future date. Please let me know what you think.

mn5hk commented 4 months ago

Dear Dr. @kthyng,

Currently, we are looking at a potential bug that will take some time to fix. As such, we would like to withdraw the submission, with the intention to resubmit at a future date.

I apologize for the inconvenience.

Sincerely, Amin Shakya

kthyng commented 4 months ago

Ok no problem. Please link to this pre-review issue at that point when you resubmit. Thanks.

kthyng commented 4 months ago

@editorialbot withdraw

editorialbot commented 4 months ago

Paper withdrawn.