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]: geemap: A Python package for interactive mapping with Google Earth Engine #2305

Closed
whedon opened this issue Jun 8, 2020 · 53 comments
Closed

Comments

@whedon
Copy link
Collaborator

@whedon whedon commented Jun 8, 2020

Submitting author: @giswqs (Qiusheng Wu)
Repository: https://github.com/giswqs/geemap
Version: v0.7.6
Editor: @hugoledoux
Reviewer: @fbiljecki, @steflhermitte
Archive: 10.6084/m9.figshare.12608834.v1

⚠️ 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

Status badge code:

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

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

@fbiljecki & @steflhermitte, 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 @hugoledoux know.

Please try and complete your review in the next six weeks

Review checklist for @fbiljecki

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 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 (@giswqs) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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: Do the authors clearly state 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 @steflhermitte

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 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 (@giswqs) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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: Do the authors clearly state 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
Copy link
Collaborator Author

@whedon whedon commented Jun 8, 2020

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @fbiljecki, @steflhermitte 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:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

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
Copy link
Collaborator Author

@whedon whedon commented Jun 8, 2020

Reference check summary:

OK DOIs

- 10.1016/j.rse.2017.06.031 is OK
- 10.1126/science.1244693 is OK
- 10.3390/rs9121315 is OK
- 10.3390/rs10050691 is OK
- 10.1038/s41893-020-0521-x is OK
- 10.1038/nature20584 is OK
- 10.1016/j.rse.2019.04.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@whedon
Copy link
Collaborator Author

@whedon whedon commented Jun 8, 2020

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jun 8, 2020

👋🏼 @fbiljecki @steflhermitte this is the review thread for the paper. All of our communications will happen here from now on.

Both reviewers have checklists at the top of this thread with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#2305 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use Whedon (our bot) to set automatic reminders if you know you'll be away for a known period of time.

It's for both of you the first review here, so it can be a bit overwhelming. Please feel free to ping me (@hugoledoux) if you have any questions/concerns.

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jun 23, 2020

@fbiljecki I see you ticked several checkboxes above, but not all. If you haven't done some yet it's fine, but if you have questions or think the software/docs should be modified, the idea is that you state so here in a new comment. If it's something complex you can open a new issue in the repo of the project and put a link here too.

@giswqs
Copy link

@giswqs giswqs commented Jun 23, 2020

@fbiljecki Thank you very much for taking the time to review the repo! Regarding the two unchecked items:

  • Performance: There are no performance claims of the package.
  • Automated tests: I have some automated tests in tests/test_geemap.py as well as py-check.yaml. Would these be sufficient?

I would be happy to make improvement if needed. Thank you.

@fbiljecki
Copy link

@fbiljecki fbiljecki commented Jun 29, 2020

Thanks @giswqs, nice job on the software.
I recommend the acceptance of this submission.

@giswqs
Copy link

@giswqs giswqs commented Jun 29, 2020

@fbiljecki Thank you very much for your time. Appreciated.

@steflhermitte
Copy link

@steflhermitte steflhermitte commented Jul 2, 2020

Dear @giswqs,

First I would like to thank you for the development of what looks at first sight/experience an extremely useful, powerful and well-designed package for interacting with GEE. Looking forward to explore it further in the coming days when finishing the review.

When installing the package I faced some initial glitches as pip install geemap failed to correctly install the ipyleaflet and ipytree dependencies (on macports + pip). They should have been automatically installed (I did receive any error message), but I could not load them in my notebook. I managed to solve it by manually re-installing these packages. I don't think it is necessarily a geemap issue, but it could provide a hurdle for others. I don't know how to handle this though in your package description and/or if it is needed, but wanted to mention it.

Hope to finish the rest of the review in the coming hours/days.

Groet,
Stef

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 2, 2020

Here are some things you can ask me to do:

# List Whedon's capabilities
@whedon commands

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

EDITORIAL TASKS

# Compile the paper
@whedon generate pdf

# Compile the paper from alternative branch
@whedon generate pdf from branch custom-branch-name

# Ask Whedon to check the references for missing DOIs
@whedon check references

# Ask Whedon to check repository statistics for the submitted software
@whedon check repository

@steflhermitte
Copy link

@steflhermitte steflhermitte commented Jul 2, 2020

@hugoledoux Practical question: how do I tick the review checklist? I see the checkboxes, but can't tick them.

@giswqs
Copy link

@giswqs giswqs commented Jul 2, 2020

Dear @giswqs,

First I would like to thank you for the development of what looks at first sight/experience an extremely useful, powerful and well-designed package for interacting with GEE. Looking forward to explore it further in the coming days when finishing the review.

When installing the package I faced some initial glitches as pip install geemap failed to correctly install the ipyleaflet and ipytree dependencies (on macports + pip). They should have been automatically installed (I did receive any error message), but I could not load them in my notebook. I managed to solve it by manually re-installing these packages. I don't think it is necessarily a geemap issue, but it could provide a hurdle for others. I don't know how to handle this though in your package description and/or if it is needed, but wanted to mention it.

Hope to finish the rest of the review in the coming hours/days.

Groet,
Stef

@steflhermitte Thank you very much for taking to time to test the package. The ipyleaflet dependency sometime can be a bit tricky to install, as it might conflict with some of you existing packages. The best way to install geemap is to create a fresh conda environment, if you have Anaconda or Miniconda installed on your computer. I also have a YouTube video showing users how to install the package using conda. Hope it helps. Thanks.

https://github.com/giswqs/geemap#installation

conda create -n gee python=3.7
conda activate gee
conda install mamba -c conda-forge
mamba install geemap -c conda-forge
@giswqs
Copy link

@giswqs giswqs commented Jul 2, 2020

@hugoledoux Practical question: how do I tick the review checklist? I see the checkboxes, but can't tick them.

You might have received an invitation email earlier on. You will need to click the link in that email to accept the invitation. After that, you should be able to tick the review checklist.

@steflhermitte
Copy link

@steflhermitte steflhermitte commented Jul 2, 2020

@giswqs Thanks for the clarifications! I agree that your manual is very clear. I was just testing it in my own environment and that seems to work (after solving the conflicting dependencies).

The invitation seems not to work any longer Sorry, we couldn't find that repository invitation It is possible that the invitation was revoked or that you are not logged into the invited account. I am logged in with the correct account, so I guess that I need to be re-invited to be able to tick the boxes.

@danielskatz
Copy link

@danielskatz danielskatz commented Jul 2, 2020

@whedon re-invite @steflhermitte as reviewer

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 2, 2020

OK, the reviewer has been re-invited.

@steflhermitte please accept the invite by clicking this link: https://github.com/openjournals/joss-reviews/invitations

@steflhermitte
Copy link

@steflhermitte steflhermitte commented Jul 2, 2020

Dear @giswqs and @hugoledoux,

I have been reviewing the software and accompanying paper and want to congratulate @giswqs on the nice piece of software. Geemap contains very useful tools for the designed audience that want to use Google Earth Engine in a Jupyter Notebook environment. The tools are simple, perform good and are well documented by example notebooks and accompanying Youtube videos.

Based on this review I recommend the acceptance of this submission.

Best regards,
Stef Lhermitte

@giswqs
Copy link

@giswqs giswqs commented Jul 2, 2020

@steflhermitte Thank you very much for your support! Appreciated.

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 3, 2020

Nice work @giswqs, this review was very smooth! The 2 reviewers now recommend acceptance so we're reaching the end of the review!

At this point could you:

  • accept the PR I made to your paper, there was a small typo in the acknowlegment
  • 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.

@giswqs
Copy link

@giswqs giswqs commented Jul 3, 2020

Dear @hugoledoux, I have made the requested changes. Thanks.

  1. Merged your pull request.
  2. Made a tagged version v0.7.6
  3. Archived the software in figshare
  4. Figshare citation: Wu, Q., 2020. geemap: A Python package for interactive mapping with Google Earth Engine. https://doi.org/10.6084/m9.figshare.12608834.v1
@FainazInamdeen
Copy link

@FainazInamdeen FainazInamdeen commented Jul 4, 2020

i have installed geemap through Anaconda, but when I coding in Jupiter notebook, I cannot open the map as you shown in video, what would be the wrong?

@giswqs
Copy link

@giswqs giswqs commented Jul 4, 2020

@FainazInamdeen Did you create a fresh conda env to install geemap? Check the installation guidelines. If you still encounter issues, please open a new issue here. This thread is for the joss-review paper only, not for trouble shooting package installation issues.

conda create -n gee python=3.7
conda activate gee
conda install mamba -c conda-forge
mamba install geemap -c conda-forge
@FainazInamdeen
Copy link

@FainazInamdeen FainazInamdeen commented Jul 4, 2020

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 6, 2020

@whedon generate pdf

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 6, 2020

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 6, 2020

@whedon set 10.6084/m9.figshare.12608834.v1 as archive

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 6, 2020

OK. 10.6084/m9.figshare.12608834.v1 is the archive.

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 6, 2020

@whedon set v0.7.6 as version

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 6, 2020

OK. v0.7.6 is the version.

@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 6, 2020

@whedon accept

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 6, 2020

Attempting dry run of processing paper acceptance...
@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 6, 2020

Reference check summary:

OK DOIs

- 10.1016/j.rse.2017.06.031 is OK
- 10.1126/science.1244693 is OK
- 10.3390/rs9121315 is OK
- 10.3390/rs10050691 is OK
- 10.1038/s41893-020-0521-x is OK
- 10.1038/nature20584 is OK
- 10.1016/j.rse.2019.04.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 6, 2020

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

Check final proof 👉 openjournals/joss-papers#1546

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

@whedon accept deposit=true
@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 6, 2020

Congratulations @giswqs your submission is now accepted! Your paper will be handled and published in the near future.

Thanks to @fbiljecki and @steflhermitte for the reviews and feedback!

@giswqs
Copy link

@giswqs giswqs commented Jul 6, 2020

@hugoledoux @fbiljecki @steflhermitte Thank you very much for taking the time to review the package. Much appreciated.

@giswqs
Copy link

@giswqs giswqs commented Jul 15, 2020

@whedon @hugoledoux Is there anything I need to do on my end? It seems the paper is not moving forward.

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@whedon commands
@hugoledoux
Copy link
Collaborator

@hugoledoux hugoledoux commented Jul 15, 2020

@giswqs no you don't, it should be picked up by one of the journal editor. It's summer I guess, sorry for delay

@danielskatz
Copy link

@danielskatz danielskatz commented Jul 15, 2020

@giswqs - sorry this slipped by - I'll work on now

@danielskatz
Copy link

@danielskatz danielskatz commented Jul 15, 2020

@giswqs - Please merge the changes in giswqs/geemap#115 then we can proceed to publication

@giswqs
Copy link

@giswqs giswqs commented Jul 15, 2020

@danielskatz I have merged your pull request. Thank you very much for your help!

@danielskatz
Copy link

@danielskatz danielskatz commented Jul 15, 2020

@whedon accept

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

Attempting dry run of processing paper acceptance...
@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

Reference check summary:

OK DOIs

- 10.1016/j.rse.2017.06.031 is OK
- 10.1126/science.1244693 is OK
- 10.3390/rs9121315 is OK
- 10.3390/rs10050691 is OK
- 10.5194/essd-11-881-2019 is OK
- 10.1038/s41893-020-0521-x is OK
- 10.1038/nature20584 is OK
- 10.1016/j.rse.2019.04.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None
@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

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

Check final proof 👉 openjournals/joss-papers#1573

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

@whedon accept deposit=true
@danielskatz
Copy link

@danielskatz danielskatz commented Jul 15, 2020

@whedon accept deposit=true

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

Doing it live! Attempting automated processing of paper acceptance...
@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

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

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

🚨🚨🚨 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 👉 openjournals/joss-papers#1574
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.02305
  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...

@danielskatz
Copy link

@danielskatz danielskatz commented Jul 15, 2020

Thanks to @fbiljecki & @steflhermitte for reviewing and @hugoledoux for editing!

Congratulations to @giswqs (Qiusheng Wu)!!

@whedon
Copy link
Collaborator Author

@whedon whedon commented Jul 15, 2020

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

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

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

This is how it will look in your documentation:

DOI

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
You can’t perform that action at this time.