pyOpenSci / software-submission

Submit your package for review by pyOpenSci here! If you have questions please post them here: https://pyopensci.discourse.group/
94 stars 36 forks source link

EOmaps #137

Closed raphaelquast closed 1 year ago

raphaelquast commented 1 year ago

Submitting Author: Raphael Quast (@raphaelquast)
Package Name: EOmaps One-Line Description of Package: https://eomaps.readthedocs.io/en/latest/ Repository Link (if existing): https://github.com/raphaelquast/EOmaps


Code of Conduct & Commitment to Maintain Package

Description

EOmaps is a python package to visualize and analyze geographical datasets.

It is intended to simplify the process of geospatial data visualization and to provide a straight forward way to turn the maps into interactive widgets for data analysis.

EOmaps is based on matplotlib and cartopy and extends cartopy's capabilities with the following features

It is extensively documented, unit-tested, citable via a zenodo doi and installable via conda or pip (however using pip is discouraged since dependencies like GDAL and PYPROJ can be difficult to install, especially on windows)

Community Partnerships

We partner with communities to support peer review with an additional layer of checks that satisfy community requirements. If your package fits into an existing community please check below:

Scope

Domain Specific & Community Partnerships

- [x] Geospatial
- [ ] Education
- [ ] Pangeo
- [ ] Unsure/Other (explain below)

EOmaps can be used to visualize geospatial datasets provided in any projection supported by PyProj.

I am unsure if Pangeo is applicable or not (I have no experience with the pangeo community so far)

The target audience are scientists and researchers working with geospatial datasets. EOmaps can be used to quilkly visualize datasets, compare multiple datasets with each other or compare maps to an extensive list of open access webmap services.

In addition to the interactive capabilities, maps created with EOmaps can be exported as high-resolution images or vector-graphics to create publication-ready plots.

Since EOmaps is based on matplotlib, maps can be connected to ordinary matplotlib axes to analyze multi-dimensional (e.g. timeseries) data.

It also has great potential to be used in education to teach about projections, distortions, spatial resolution, rasterization of data etc.

EOmaps is based on cartopy. While cartopy provides similar functionalities in terms of data visualization, EOmaps greatly extends these capabilities (especially for large datasets), adds multi-layer support, a basic GUI, easy-access to webmaps, and many more features.

There exist other packages that focus on interactive geo-data visualization, but to my knowledge none that focusses on local use in pure python.

P.S. Have feedback/comments about our review process? Leave a comment here

NickleDave commented 1 year ago

Hi @raphaelquast and welcome to pyOpenSci. Thank you for opening this detailed presubmission issue.

EOmaps is definitely in scope for pyOpenSci.
To be extra sure I discussed with our executive director @lwasser, and she agreed this dataviz package is in scope under the description in our guide here: https://www.pyopensci.org/software-peer-review/about/package-scope.html#what-if-my-package-seems-like-its-category-or-domain-is-out-of-scope

Just to make sure you see it, the checklist we start reviews with is here: https://www.pyopensci.org/software-peer-review/our-process/review-timeline.html#step-0-optional-author-submits-pre-submission-inquiry I have already done most of the initial checks and do not expect those to be an issue.

Please proceed with a full submission, and be sure to reference this issue by number when you do.

raphaelquast commented 1 year ago

@NickleDave Thank you very much for your quick response. ... and I am glad to hear that EOmaps fits into the scope of pyOpenSci!

I had a look at the checklist and I agree that most points should already be fulfilled. (I'll try to add a contributing.md file in the next minor release and implement an issue template as soon as possible)

I'll proceed with a proper submission and I'm very much looking forward to your insights and comments on the package!

NickleDave commented 1 year ago

I had a look at the checklist and I agree that most points should already be fulfilled. (I'll try to add a contributing.md file in the next minor release and implement an issue template as soon as possible)

Great, yes we will need those before we can start the review.

I'll proceed with a proper submission and I'm very much looking forward to your insights and comments on the package!

Excellent, I saw you did so. We are looking for an editor now. And we're looking forward to the review, thanks!

raphaelquast commented 1 year ago

I just put this here for reference... I've added all missing points so the checklist should now be complete!