[REVIEW]: eemont: A Python package that extends Google Earth Engine

[whedon]

Submitting author: @davemlz (David Montero Loaiza)
Repository: https://github.com/davemlz/eemont
Version: v0.2.0
Editor: @kbarnhart
Reviewer: @giswqs, @elbeejay, @patrickcgray
Archive: 10.5281/zenodo.4900067

⚠️ JOSS reduced service mode ⚠️

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/34696c5b62c50898b4129cbbe8befb0a"><img src="https://joss.theoj.org/papers/34696c5b62c50898b4129cbbe8befb0a/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/34696c5b62c50898b4129cbbe8befb0a/status.svg)](https://joss.theoj.org/papers/34696c5b62c50898b4129cbbe8befb0a)

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

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

1. Make sure you're logged in to your GitHub account
2. 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 @kbarnhart 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 @giswqs

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 repository url?
• 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 (@davemlz) 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?

Review checklist for @elbeejay

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 repository url?
• 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 (@davemlz) 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?

Review checklist for @patrickcgray

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 repository url?
• 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 (@davemlz) 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?

[whedon]

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @giswqs, @elbeejay, @patrickcgray it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

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.

⭐ Important ⭐

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:

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

2. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/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]

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=1.89 s (96.6 files/s, 32422.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                            87          10387            261          22070
JavaScript                      13           2289           2320           8445
SVG                              1              0              0           2671
Python                          17            517           1411           1917
reStructuredText                40            851           1108            910
CSS                              4            181             33            715
Jupyter Notebook                14              0           4682            380
Markdown                         1             20              0             67
TeX                              1              3              0             37
DOS Batch                        1              8              1             26
Rmd                              1             23             40             16
make                             1              4              7              9
INI                              1              1              0              5
YAML                             1              2              5              5
-------------------------------------------------------------------------------
SUM:                           183          14286           9868          37273
-------------------------------------------------------------------------------


Statistical information for the repository 'bfdd8f3f248f5bff15cc1cf9' was
gathered on 2021/04/12.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
U-dmlmont-PC\dmlmont            97         31442          10698          100.00

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
U-dmlmont-PC\dmlmont      20744           66.0          2.5               12.84

[whedon]

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

[whedon]

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

OK DOIs

- 10.1016/j.rse.2017.06.031 is OK
- 10.21105/joss.02272 is OK
- 10.21105/joss.02305 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[kbarnhart]

@giswqs, @elbeejay, @patrickcgray - thanks for agreeing to review this submission to JOSS. In the prior comments there is a checklist that you can use to guide you through your review.

We have an automatic reminder set up in two weeks to ask you how the review is going. At present we request that reviewers complete their reviews within 6 weeks. JOSS is trying to be mindful of changes people have experienced due to COVID-19.

As you work through your review, if there are any issues that come up, please make an issue in the eemont repository, and link to this issue (/issues/3168). That way most of the discussion can occur on in-repo issues.

If you have any questions, please let me know (tag me here or email krbarnhart@usgs.gov).

[kbarnhart]

/ooo April 15 until April 20

[kbarnhart]

FYI, I will be out of the office from April 15 until April 20. The ooo bot should respond indicating this if you tag me during that time. I will respond to any comments once I return.

[whedon]

👋 @elbeejay, please update us on how your review is going (this is an automated reminder).

[whedon]

👋 @patrickcgray, please update us on how your review is going (this is an automated reminder).

[whedon]

👋 @giswqs, please update us on how your review is going (this is an automated reminder).

[elbeejay]

I've gone though the package and opened up a few issues (#18 and #19 in the eemont repository) where I outline my outstanding questions, concerns, and suggestions regarding this submission.

But overall I think the eemont is a valuable contribution to the Python+Google Earth Engine community, it seems to have picked up a reasonable user-base already and is featured on the GEE developer resources page. Once those 2 outstanding issues are taken care of I will be able to complete the checklist and recommend the eemont software and JOSS paper for publication.

[kbarnhart]

@elbeejay thanks for completing your review and identifying those issues. If @giswqs or @patrickcgray have questions as you work on your reviews, please let me know.

[giswqs]

@whedon generate pdf

[whedon]

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

[giswqs]

I just released geemap v0.8.15, which should help resolve the issue raised in davemlz/eemont#18 regarding the eemont tutorial notebooks.

[davemlz]

Hi to everyone!

Following @elbeejay suggestions (davemlz/eemont#19), I have modified the paper (davemlz/eemont@5e50b13) with new sections (including the GEE Community: Developer Resources and the integration with the Earth Engine Plugin for QGIS), benefits of the package (including comparisons with the Earth Engine Python API), and I adjusted it for the State of the Field.

[giswqs]

@whedon generate pdf

[whedon]

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

[kbarnhart]

@davemlz I've made two pull requests with very small changes to the text and the .bib file. Please consider these PRs. After you have done so, please test that the article builds correctly here, and presuming it does do the following:

• Make a tagged release of your software, and list the version tag of the archived version here.
• Archive the reviewed software in Zenodo or a similar service (e.g., figshare, an institutional repository)
• Check the archival deposit (e.g., in Zenodo) has the correct metadata. This includes the title (should match the paper title) and author list (make sure the list is correct and people who only made a small fix are not on it). You may also add the authors' ORCID.
• Please list the DOI of the archived version here.

I can then move forward with accepting the submission.

Know also that I'll be out of the office June 3-June 8.

[kbarnhart]

@davemlz FYI, I will be out of the office Thursday June 3-Tuesday June 8.

[davemlz]

Hi, @kbarnhart!

Sorry for the late response, I'll start with it!

[davemlz]

@whedon generate pdf

[whedon]

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

[davemlz]

@whedon check references

[whedon]

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

OK DOIs

- 10.1016/j.rse.2017.06.031 is OK
- 10.21105/joss.02272 is OK
- 10.21105/joss.02305 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[davemlz]

Hi, @kbarnhart!

The package is now in Zenodo:

• Tagged release: 0.2.0
• Software archived in: Zenodo
• List of authors revised.
• DOI: 10.5281/zenodo.4900067

[kbarnhart]

@whedon set 10.5281/zenodo.4900067 as archive

[whedon]

OK. 10.5281/zenodo.4900067 is the archive.

[kbarnhart]

@whedon set v0.2.0 as version

[whedon]

OK. v0.2.0 is the version.

[kbarnhart]

@whedon recommend-accept

[whedon]

Attempting dry run of processing paper acceptance...

[whedon]

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

OK DOIs

- 10.1016/j.rse.2017.06.031 is OK
- 10.21105/joss.02272 is OK
- 10.21105/joss.02305 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[whedon]

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

Check final proof 👉 openjournals/joss-papers#2377

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

@whedon accept deposit=true

[kbarnhart]

@davemlz I've now recommended that this submission be accepted. One of the @openjournals/joss-eics will handle the final steps of this process. Congratulations on a valuable contribution. Many thanks to reviewers @giswqs, @elbeejay, @patrickcgray for you thoughtful and constructive reviews.

[kthyng]

Everything looks great! Ready to go!

[kthyng]

@whedon accept deposit=true

[whedon]

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

[whedon]

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

[whedon]

🚨🚨🚨 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.03168 joss-papers#2378
1. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03168
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...

[kthyng]

Congrats on your new publication @davemlz! Thank you to editor @kbarnhart and reviewers @giswqs, @elbeejay, and @patrickcgray for your hard work and expertise!

[whedon]

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

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

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

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

[davemlz]

Thank you very much, @kbarnhart and @kthyng, it looks amazing!

Big thanks to @elbeejay, @giswqs, @patrickcgray for the awesome help with the eemont review!