From 69f1e0cbb5037a65d0f5b519b40beb2f2f2b1cbd Mon Sep 17 00:00:00 2001 From: Raphael Quast Date: Tue, 13 Feb 2024 23:25:25 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 114 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 78 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index a03fbbdaf..54b820f6e 100644 --- a/README.md +++ b/README.md @@ -13,64 +13,110 @@ chat on gitter ---- + -# EOmaps - Interactive maps in python! +

A python package to visualize and analyze geographical datasets.

-**EOmaps** is a python package to visualize and analyze geographical datasets. +> **EOmaps** aims to provide a comprehensive, flexible, well-documented and easy-to-use API to create publication-ready maps that can directly be used for interactive data analysis. -It is built on top of [matplotlib](https://matplotlib.org/) and [cartopy](https://scitools.org.uk/cartopy/docs/latest/) and provides an intuitive and easy-to-use interface to speed up and simplify the creation and comparison of maps. +## How does it work? +**EOmaps** is built on top of [matplotlib](https://matplotlib.org/) and [cartopy](https://scitools.org.uk/cartopy/docs/latest/) and integrates well with the scientific python infrastructure (e.g., `numpy`, `pandas`, `geopandas`, `xarray` etc.), allowing you to visualize point-, raster- or vector-datasets provided in almost any format you can imagine, no matter if you're dealing with just a few unsorted datapoints or multi-dimensional stacks of global high-resolution datasets. + +Figures created with EOmaps are multi-layered, so you can (transparently) overlay and interactively compare your datasets with ease. With the accompanying GUI widget, you can quickly switch layers, change the layout, examine the large collection of features and web-map services, and explore the capabilities of EOmaps. +Once you're map is ready, you can export it as high-resolution image or vector-graphic for further editing. +Leveraging the powers of matplotlib, you can also embed interactive maps in Jupyter Notebooks, GUI frameworks like `Qt`, `tkinter`, `wx` or on a webpage (html). + + +> [!TIP] > For a quick hands-on introduction, checkout this article on dev.to: > [Geographic data visualization and analysis with EOmaps: Interactive maps in python!](https://dev.to/raphaelquast/geographic-data-visualization-and-analysis-with-eomaps-interactive-maps-in-python-48e1) -> -> --- + +--- ### What can EOmaps do for you? -- Create [▤ multi-layered maps](https://eomaps.readthedocs.io/en/latest/api_basics.html#layer-management) and interactively compare different layers with each other -- [🔴 Visualize datasets](https://eomaps.readthedocs.io/en/latest/api_data_visualization.html) with millions of datapoints and handle reprojections + + +Checkout the [🌱 Basics](https://eomaps.readthedocs.io/en/latest/api_basics.html) in the documentation to get started! + +
+ +- Create [▤ multi-layered maps](https://eomaps.readthedocs.io/en/latest/api_basics.html#layer-management) (and interactively compare layers with each other) +- [🔴 Visualize datasets](https://eomaps.readthedocs.io/en/latest/api_data_visualization.html) with millions of datapoints (and handle reprojections) +- Get a useful [🧰 CompanionWidget GUI](https://eomaps.readthedocs.io/en/latest/api_companion_widget.html) +- Use [🛸 Callbacks](https://eomaps.readthedocs.io/en/latest/api_callbacks.html) to make your figure interactive +- Adjust the layout with the [🏗️ LayoutEditor](https://eomaps.readthedocs.io/en/latest/api_layout_editor.html) +- [🗺 Export](https://eomaps.readthedocs.io/en/latest/api_basics.html#image-export-jpeg-png-svg-etc) high resolution images or vektor graphics + + + - Provide a comprehensive set of tools to customize the map - [🌵NaturalEarth features](https://eomaps.readthedocs.io/en/latest/api_naturalearth_features.html) - [📏Scalebars](https://eomaps.readthedocs.io/en/latest/api_scalebar.html) - [▦ Gridlines](https://eomaps.readthedocs.io/en/latest/api_gridlines.html) - [🛰 WebMap layers](https://eomaps.readthedocs.io/en/latest/api_webmaps.html) - [🏕 Annotations, Markers, Lines, Logos...](https://eomaps.readthedocs.io/en/latest/api_annotations_markers_etc.html) - - . . . -- Get a useful [🧰 CompanionWidget](https://eomaps.readthedocs.io/en/latest/api_companion_widget.html) GUI -- Use [🛸 Callbacks](https://eomaps.readthedocs.io/en/latest/api_callbacks.html) to interact with the figure -- Interactively re-arrange multiple maps in a figure with the [🏗️ LayoutEditor](https://eomaps.readthedocs.io/en/latest/api_layout_editor.html) -- [🗺 Export](https://eomaps.readthedocs.io/en/latest/api_basics.html#image-export-jpeg-png-svg-etc) publication ready high resolution images (png, jpeg, tiff, ...) -or export figures as vector graphics (svg, eps, pdf ...) - . . . and much more! + +
-Checkout the [🌱 Basics](https://eomaps.readthedocs.io/en/latest/api_basics.html) in the documentation to get started! - - ## 🔨 Installation -To install EOmaps (and all its dependencies) via the [conda](https://docs.conda.io/projects/conda/en/stable/) package-manager, simply use: +To install **EOmaps** (and all its dependencies) with the [conda](https://docs.conda.io/projects/conda/en/stable/) package-manager, simply use: ```python conda install -c conda-forge eomaps ``` -> ... to get a **huge speedup**, use [mamba](https://mamba.readthedocs.io/en/latest/) to solve the dependencies! + +> [!TIP] +> To get a **huge speedup**, use [mamba](https://mamba.readthedocs.io/en/latest/) to solve the dependencies! > ```python -> conda install -c conda-forge mamba > mamba install -c conda-forge eomaps > ``` + + +> Advanced users can also use `pip` to install **EOmaps** (and selectively install optional dependency groups) +> ```pyhton +> pip install eomaps # install only minimal required dependencies +> pip install eomaps[all] # install all optional dependencies +> ... +> ``` + Need more information? - Have a look at the [🐛Installation](https://eomaps.readthedocs.io/en/latest/installation.html) instructions in the docs. - Checkout the quickstart guide [🚀 From 0 to EOmaps](https://eomaps.readthedocs.io/en/latest/FAQ.html#from-0-to-eomaps-a-quickstart-guide). ## 📖 Documentation -Make sure to have a look at the 📖 Documentation which provides a lot of 🌐Examples on how to create awesome interactive maps (incl. 🐍 source code)! +Make sure to have a look at the 📖 Documentation ! +It provides a lot of 🌐Examples on how to create awesome interactive maps (incl. 🐍 source code)! ## ✔️ Citation Did EOmaps help in your research? Support the development and add a citation to your publication! -[![https://doi.org/10.5281/zenodo.6459598](https://zenodo.org/badge/410829039.svg)](https://zenodo.org/badge/latestdoi/410829039) +https://zenodo.org/badge/latestdoi/410829039 + +
+BibTeX +
+The following BibTeX entry uses the DOI that always points to the latest release of EOmaps!
+(You can get the DOI for a specific version form the zenodo-page) + +```bibtex +@software{eomaps, + author = {Raphael Quast}, + title = {EOmaps: A python package to visualize and analyze geographical datasets.}, + doi = {10.5281/zenodo.6459598}, + url = {https://doi.org/10.5281/zenodo.6459598} +} +``` + +
## 🌟 Contribute @@ -85,21 +131,12 @@ Interested in contributing to EOmaps? Awesome! --------------- - -
EOmaps example 6
- - - - - - - + + + @@ -121,14 +164,13 @@ Interested in contributing to EOmaps? Awesome! - - +
- EOmaps example 6 - - EOmaps example 2 -
+ + EOmaps GUI + EOmaps example 9 @@ -107,6 +144,12 @@ Interested in contributing to EOmaps? Awesome!
+ EOmaps example 6 + + EOmaps example 2 + EOmaps example 7 EOmaps example 3
EOmaps example 9 EOmaps example 4
From ad578e24c1a88e71d430fdbc7fe40dbae8535113 Mon Sep 17 00:00:00 2001 From: Raphael Quast Date: Fri, 16 Feb 2024 16:24:34 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 136 +++++++++++++++++++++--------------------------------- 1 file changed, 53 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 54b820f6e..df2f47e78 100644 --- a/README.md +++ b/README.md @@ -13,57 +13,58 @@ chat on gitter ---- -

A python package to visualize and analyze geographical datasets.

-> **EOmaps** aims to provide a comprehensive, flexible, well-documented and easy-to-use API to create publication-ready maps that can directly be used for interactive data analysis. + + +
+EOmaps aims to provide a comprehensive, flexible, well-documented and easy-to-use API to create publication-ready maps that can directly be used for interactive data analysis. +
-## How does it work? +## What can I do with EOmaps? **EOmaps** is built on top of [matplotlib](https://matplotlib.org/) and [cartopy](https://scitools.org.uk/cartopy/docs/latest/) and integrates well with the scientific python infrastructure (e.g., `numpy`, `pandas`, `geopandas`, `xarray` etc.), allowing you to visualize point-, raster- or vector-datasets provided in almost any format you can imagine, no matter if you're dealing with just a few unsorted datapoints or multi-dimensional stacks of global high-resolution datasets. -Figures created with EOmaps are multi-layered, so you can (transparently) overlay and interactively compare your datasets with ease. With the accompanying GUI widget, you can quickly switch layers, change the layout, examine the large collection of features and web-map services, and explore the capabilities of EOmaps. +Figures created with EOmaps are multi-layered, so you can (transparently) overlay and interactively compare your datasets with ease. With the accompanying GUI widget, you can quickly switch layers, change the layout, examine the large collection of features and web-map services, and explore the capabilities of EOmaps. Once you're map is ready, you can export it as high-resolution image or vector-graphic for further editing. -Leveraging the powers of matplotlib, you can also embed interactive maps in Jupyter Notebooks, GUI frameworks like `Qt`, `tkinter`, `wx` or on a webpage (html). +Leveraging the powers of matplotlib, you can also embed interactive maps in Jupyter Notebooks, on a webpage or in GUI frameworks like Qt, tkinter etc.. + +> [!IMPORTANT] +> +> EOmaps is 100% free and open-source. +> As such, acknowledgement is extremely important to allow continued support and development of the package. +> +> Did EOmaps help in your research? $\Rightarrow$ **Add a ✔️ Citation to your publication!** +> +> https://zenodo.org/badge/latestdoi/410829039 +> +>
+> BibTeX +>
+> The following BibTeX entry uses a DOI that always points to the latest release of EOmaps!
+> (You can get the DOI for a specific version form the zenodo-page) +> +> ```bibtex +> @software{eomaps, +> author = {Raphael Quast}, +> title = {EOmaps: A python package to visualize and analyze geographical datasets.}, +> doi = {10.5281/zenodo.6459598}, +> url = {https://doi.org/10.5281/zenodo.6459598} +> } +> ``` +> +>
+> +## 🚀 Getting started + +Head over to the start-page of the 📖 Documentation to get an overview of all available features and functionalities! > [!TIP] > For a quick hands-on introduction, checkout this article on dev.to: > [Geographic data visualization and analysis with EOmaps: Interactive maps in python!](https://dev.to/raphaelquast/geographic-data-visualization-and-analysis-with-eomaps-interactive-maps-in-python-48e1) ---- - -### What can EOmaps do for you? - - - -Checkout the [🌱 Basics](https://eomaps.readthedocs.io/en/latest/api_basics.html) in the documentation to get started! - -
- -- Create [▤ multi-layered maps](https://eomaps.readthedocs.io/en/latest/api_basics.html#layer-management) (and interactively compare layers with each other) -- [🔴 Visualize datasets](https://eomaps.readthedocs.io/en/latest/api_data_visualization.html) with millions of datapoints (and handle reprojections) -- Get a useful [🧰 CompanionWidget GUI](https://eomaps.readthedocs.io/en/latest/api_companion_widget.html) -- Use [🛸 Callbacks](https://eomaps.readthedocs.io/en/latest/api_callbacks.html) to make your figure interactive -- Adjust the layout with the [🏗️ LayoutEditor](https://eomaps.readthedocs.io/en/latest/api_layout_editor.html) -- [🗺 Export](https://eomaps.readthedocs.io/en/latest/api_basics.html#image-export-jpeg-png-svg-etc) high resolution images or vektor graphics - - - -- Provide a comprehensive set of tools to customize the map - - [🌵NaturalEarth features](https://eomaps.readthedocs.io/en/latest/api_naturalearth_features.html) - - [📏Scalebars](https://eomaps.readthedocs.io/en/latest/api_scalebar.html) - - [▦ Gridlines](https://eomaps.readthedocs.io/en/latest/api_gridlines.html) - - [🛰 WebMap layers](https://eomaps.readthedocs.io/en/latest/api_webmaps.html) - - [🏕 Annotations, Markers, Lines, Logos...](https://eomaps.readthedocs.io/en/latest/api_annotations_markers_etc.html) -- . . . and much more! - -
- ## 🔨 Installation @@ -77,7 +78,7 @@ conda install -c conda-forge eomaps > ```python > mamba install -c conda-forge eomaps > ``` - + > Advanced users can also use `pip` to install **EOmaps** (and selectively install optional dependency groups) > ```pyhton @@ -86,44 +87,13 @@ conda install -c conda-forge eomaps > ... > ``` -Need more information? -- Have a look at the [🐛Installation](https://eomaps.readthedocs.io/en/latest/installation.html) instructions in the docs. -- Checkout the quickstart guide [🚀 From 0 to EOmaps](https://eomaps.readthedocs.io/en/latest/FAQ.html#from-0-to-eomaps-a-quickstart-guide). - -## 📖 Documentation - -Make sure to have a look at the 📖 Documentation ! -It provides a lot of 🌐Examples on how to create awesome interactive maps (incl. 🐍 source code)! - -## ✔️ Citation -Did EOmaps help in your research? -Support the development and add a citation to your publication! - -https://zenodo.org/badge/latestdoi/410829039 - -
-BibTeX -
-The following BibTeX entry uses the DOI that always points to the latest release of EOmaps!
-(You can get the DOI for a specific version form the zenodo-page) - -```bibtex -@software{eomaps, - author = {Raphael Quast}, - title = {EOmaps: A python package to visualize and analyze geographical datasets.}, - doi = {10.5281/zenodo.6459598}, - url = {https://doi.org/10.5281/zenodo.6459598} -} -``` - -
+For more detailes, have a look at the [Installation Instructions](https://eomaps.readthedocs.io/en/latest/installation.html) or the quickstart guide ["From 0 to EOmaps"](https://eomaps.readthedocs.io/en/latest/FAQ.html#from-0-to-eomaps-a-quickstart-guide)! ## 🌟 Contribute -Interested in contributing to EOmaps? Awesome! - -- Checkout the [🚀 Contribution Guide](https://eomaps.readthedocs.io/en/latest/contribute.html) on how to get started! +Interested in contributing to EOmaps? **Awesome!** +You can find detailed instructions on how to setup EOmaps for development in the [Contribution Guide](https://eomaps.readthedocs.io/en/latest/contribute.html)! > Found a bug or got an idea for an interesting feature? > Open an [issue](https://github.com/raphaelquast/EOmaps/issues) or start a [discussion](https://github.com/raphaelquast/EOmaps/discussions), and I'll see what I can do! @@ -134,41 +104,41 @@ Interested in contributing to EOmaps? Awesome! From 962c68938c2f2c1986a7ff06c4282c0d4c3cb84b Mon Sep 17 00:00:00 2001 From: Raphael Quast Date: Fri, 16 Feb 2024 17:07:06 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df2f47e78..aacf7966e 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ ## What can I do with EOmaps? -**EOmaps** is built on top of [matplotlib](https://matplotlib.org/) and [cartopy](https://scitools.org.uk/cartopy/docs/latest/) and integrates well with the scientific python infrastructure (e.g., `numpy`, `pandas`, `geopandas`, `xarray` etc.), allowing you to visualize point-, raster- or vector-datasets provided in almost any format you can imagine, no matter if you're dealing with just a few unsorted datapoints or multi-dimensional stacks of global high-resolution datasets. +**EOmaps** is built on top of [matplotlib](https://matplotlib.org/) and [cartopy](https://scitools.org.uk/cartopy/docs/latest/) and integrates well with the scientific python infrastructure (e.g., [numpy](https://numpy.org/), [pandas](https://pandas.pydata.org/), [geopandas](https://geopandas.org/), [xarray](https://xarray.dev/) etc.), allowing you to visualize point-, raster- or vector-datasets provided in almost any format you can imagine, no matter if you're dealing with just a few unsorted datapoints or multi-dimensional stacks of global high-resolution datasets. Figures created with EOmaps are multi-layered, so you can (transparently) overlay and interactively compare your datasets with ease. With the accompanying GUI widget, you can quickly switch layers, change the layout, examine the large collection of features and web-map services, and explore the capabilities of EOmaps. Once you're map is ready, you can export it as high-resolution image or vector-graphic for further editing.
- EOmaps GUI + EOmaps GUI Example - EOmaps example 9 + EOmaps Timeseries Example - EOmaps example 4 + EOmaps Callbacks Example
- EOmaps example 6 + EOmaps Webmaps Example - EOmaps example 2 + EOmaps Webmaps Example 2 - EOmaps example 7 + EOmaps Scalebars Example - EOmaps example 8 + EOmaps Multiple Maps Example
- EOmaps inset-maps + EOmaps LayoutEditor Example - EOmaps example 3 + EOmaps Vector Data Example - EOmaps example 9 + EOmaps Lines Example - EOmaps example 4 + EOmaps InsetMaps Example