Skip to content

Commit

Permalink
Added mkdocs dark mode (#1338)
Browse files Browse the repository at this point in the history
  • Loading branch information
giswqs committed Nov 20, 2022
1 parent a7ca0af commit 72edb6b
Show file tree
Hide file tree
Showing 15 changed files with 119 additions and 78 deletions.
19 changes: 11 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ geemap
.. image:: https://mybinder.org/badge_logo.svg
:target: https://gishub.org/geemap-binder

.. image:: https://studiolab.sagemaker.aws/studiolab.svg
:target: https://studiolab.sagemaker.aws/import/github/giswqs/geemap/blob/master/examples/notebooks/00_geemap_key_features.ipynb

.. image:: https://renkulab.io/renku-badge.svg
:target: https://renkulab.io/projects/renku-stories/geemap/sessions/new?autostart=1

Expand All @@ -24,7 +27,7 @@ geemap
:target: https://geemap.org

.. image:: https://img.shields.io/badge/YouTube-Channel-red
:target: https://www.youtube.com/c/QiushengWu
:target: https://youtube.com/@giswqs

.. image:: https://img.shields.io/lgtm/grade/python/g/giswqs/geemap.svg?logo=lgtm&logoWidth=18
:target: https://lgtm.com/projects/g/giswqs/geemap/context:python
Expand All @@ -48,7 +51,7 @@ geemap
* PyPI: https://pypi.org/project/geemap/
* Conda-forge: https://anaconda.org/conda-forge/geemap
* 360+ GEE notebook examples: https://github.com/giswqs/earthengine-py-notebooks
* GEE Tutorials on YouTube: https://www.youtube.com/c/QiushengWu
* GEE Tutorials on YouTube: https://youtube.com/@giswqs
* Free software: MIT license

**Acknowledgment:** This material is based upon work supported by the National Aeronautics and Space Administration (NASA) under Grant No. 80NSSC22K1742 issued through the `Open Source Tools, Frameworks, and Libraries 2020 Program <https://bit.ly/3RVBRcQ>`__.
Expand All @@ -69,13 +72,13 @@ geemap
Introduction
------------

**geemap** is a Python package for interactive mapping with `Google Earth Engine <https://earthengine.google.com/>`__ (GEE), which is a cloud computing platform with a `multi-petabyte catalog <https://developers.google.com/earth-engine/datasets/>`__ of satellite imagery and geospatial datasets. During the past few years,
**Geemap** is a Python package for interactive mapping with `Google Earth Engine <https://earthengine.google.com/>`__ (GEE), which is a cloud computing platform with a `multi-petabyte catalog <https://developers.google.com/earth-engine/datasets/>`__ of satellite imagery and geospatial datasets. During the past few years,
GEE has become very popular in the geospatial community and it has empowered numerous environmental applications at local, regional, and global scales. GEE provides both JavaScript and Python APIs for
making computational requests to the Earth Engine servers. Compared with the comprehensive `documentation <https://developers.google.com/earth-engine>`__ and interactive IDE (i.e., `GEE JavaScript Code Editor <https://code.earthengine.google.com/>`__) of the GEE JavaScript API,
the GEE Python API has relatively little documentation and limited functionality for visualizing results interactively. The **geemap** Python package was created to fill this gap. It is built upon `ipyleaflet <https://github.com/jupyter-widgets/ipyleaflet>`__ and `ipywidgets <https://github.com/jupyter-widgets/ipywidgets>`__, and enables users to
analyze and visualize Earth Engine datasets interactively within a Jupyter-based environment.

**geemap** is intended for students and researchers, who would like to utilize the Python ecosystem of diverse libraries and tools to explore Google Earth Engine. It is also designed for existing GEE users who would like to transition from the GEE JavaScript API to Python API. The automated JavaScript-to-Python `conversion module <https://github.com/giswqs/geemap/blob/master/geemap/conversion.py>`__ of the **geemap** package
**Geemap** is intended for students and researchers, who would like to utilize the Python ecosystem of diverse libraries and tools to explore Google Earth Engine. It is also designed for existing GEE users who would like to transition from the GEE JavaScript API to Python API. The automated JavaScript-to-Python `conversion module <https://github.com/giswqs/geemap/blob/master/geemap/conversion.py>`__ of the **geemap** package
can greatly reduce the time needed to convert existing GEE JavaScripts to Python scripts and Jupyter notebooks.

For video tutorials and notebook examples, please visit `<https://geemap.org/tutorials>`__. For complete documentation on geemap modules and methods, please visit `<https://geemap.org/geemap>`_.
Expand Down Expand Up @@ -132,14 +135,14 @@ To use **geemap**, you must first `sign up <https://earthengine.google.com/signu
.. image:: https://i.imgur.com/ng0FzUT.png
:target: https://earthengine.google.com

**geemap** is available on `PyPI <https://pypi.org/project/geemap/>`__. To install **geemap**, run this command in your terminal:
**Geemap** is available on `PyPI <https://pypi.org/project/geemap/>`__. To install **geemap**, run this command in your terminal:

.. code:: python
pip install geemap
**geemap** is also available on `conda-forge <https://anaconda.org/conda-forge/geemap>`__. If you have `Anaconda <https://www.anaconda.com/distribution/#download-section>`__ or `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`__ installed on your computer, you can create a conda Python environment to install geemap:
**Geemap** is also available on `conda-forge <https://anaconda.org/conda-forge/geemap>`__. If you have `Anaconda <https://www.anaconda.com/distribution/#download-section>`__ or `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`__ installed on your computer, you can create a conda Python environment to install geemap:

.. code:: python
Expand Down Expand Up @@ -205,12 +208,12 @@ Note that `Google Colab <https://colab.research.google.com/>`__ currently does n
you can use `import geemap <https://github.com/giswqs/geemap/blob/master/geemap/geemap.py>`__, which provides more functionalities for capturing user input (e.g.,
mouse-clicking and moving).

More GEE Tutorials are available on my `YouTube channel <https://www.youtube.com/c/QiushengWu>`__.
More GEE Tutorials are available on my `YouTube channel <https://youtube.com/@giswqs>`__.

|YouTube|

.. |YouTube| image:: https://wetlands.io/file/images/youtube.png
:target: https://www.youtube.com/c/QiushengWu
:target: https://youtube.com/@giswqs

To create an ipyleaflet-based interactive map:

Expand Down
17 changes: 9 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Welcome to geemap

[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://gishub.org/geemap-colab)
[![image](https://mybinder.org/badge_logo.svg)](https://gishub.org/geemap-binder)
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://gishub.org/geemap-colab)
[![Open in Binder](https://mybinder.org/badge_logo.svg)](https://gishub.org/geemap-binder)
[![Open In Studio Lab](https://studiolab.sagemaker.aws/studiolab.svg)](https://studiolab.sagemaker.aws/import/github/giswqs/geemap/blob/master/examples/notebooks/00_geemap_key_features.ipynb)
[![image](https://img.shields.io/pypi/v/geemap.svg)](https://pypi.python.org/pypi/geemap)
[![image](https://img.shields.io/conda/vn/conda-forge/geemap.svg)](https://anaconda.org/conda-forge/geemap)
[![image](https://pepy.tech/badge/geemap)](https://pepy.tech/project/geemap)
[![image](https://github.com/giswqs/geemap/workflows/docs/badge.svg)](https://geemap.org)
[![image](https://github.com/giswqs/geemap/workflows/build/badge.svg)](https://github.com/giswqs/geemap/actions?query=workflow%3Abuild)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/giswqs/geemap.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/giswqs/geemap/context:python)
[![image](https://img.shields.io/badge/YouTube-Channel-red)](https://www.youtube.com/c/QiushengWu)
[![image](https://img.shields.io/badge/YouTube-Channel-red)](https://youtube.com/@giswqs)
[![image](https://img.shields.io/twitter/follow/giswqs?style=social)](https://twitter.com/giswqs)
[![image](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![image](https://joss.theoj.org/papers/10.21105/joss.02305/status.svg)](https://joss.theoj.org/papers/10.21105/joss.02305)
Expand All @@ -20,16 +21,16 @@
- PyPI: <https://pypi.org/project/geemap>
- Conda-forge: <https://anaconda.org/conda-forge/geemap>
- 360+ GEE notebook examples: <https://github.com/giswqs/earthengine-py-notebooks>
- GEE Tutorials on YouTube: <https://www.youtube.com/c/QiushengWu>
- GEE Tutorials on YouTube: <https://youtube.com/@giswqs>
- Free software: [MIT license](https://opensource.org/licenses/MIT)

**Acknowledgment:** This material is based upon work supported by the National Aeronautics and Space Administration (NASA) under Grant No. 80NSSC22K1742 issued through the [Open Source Tools, Frameworks, and Libraries 2020 Program](https://bit.ly/3RVBRcQ).

## Introduction

**geemap** is a Python package for interactive mapping with [Google Earth Engine](https://earthengine.google.com/) (GEE), which is a cloud computing platform with a [multi-petabyte catalog](https://developers.google.com/earth-engine/datasets/) of satellite imagery and geospatial datasets. During the past few years, GEE has become very popular in the geospatial community and it has empowered numerous environmental applications at local, regional, and global scales. GEE provides both JavaScript and Python APIs for making computational requests to the Earth Engine servers. Compared with the comprehensive [documentation](https://developers.google.com/earth-engine) and interactive IDE (i.e., [GEE JavaScript Code Editor](https://code.earthengine.google.com/)) of the GEE JavaScript API, the GEE Python API has relatively little documentation and limited functionality for visualizing results interactively. The geemap Python package was created to fill this gap. It is built upon [ipyleaflet](https://github.com/jupyter-widgets/ipyleaflet) and [ipywidgets](https://github.com/jupyter-widgets/ipywidgets), and enables users to analyze and visualize Earth Engine datasets interactively within a Jupyter-based environment.
**Geemap** is a Python package for interactive mapping with [Google Earth Engine](https://earthengine.google.com/) (GEE), which is a cloud computing platform with a [multi-petabyte catalog](https://developers.google.com/earth-engine/datasets/) of satellite imagery and geospatial datasets. During the past few years, GEE has become very popular in the geospatial community and it has empowered numerous environmental applications at local, regional, and global scales. GEE provides both JavaScript and Python APIs for making computational requests to the Earth Engine servers. Compared with the comprehensive [documentation](https://developers.google.com/earth-engine) and interactive IDE (i.e., [GEE JavaScript Code Editor](https://code.earthengine.google.com/)) of the GEE JavaScript API, the GEE Python API has relatively little documentation and limited functionality for visualizing results interactively. The geemap Python package was created to fill this gap. It is built upon [ipyleaflet](https://github.com/jupyter-widgets/ipyleaflet) and [ipywidgets](https://github.com/jupyter-widgets/ipywidgets), and enables users to analyze and visualize Earth Engine datasets interactively within a Jupyter-based environment.

**geemap** is intended for students and researchers, who would like to utilize the Python ecosystem of diverse libraries and tools to explore Google Earth Engine. It is also designed for existing GEE users who would like to transition from the GEE JavaScript API to Python API. The automated JavaScript-to-Python [conversion module](https://github.com/giswqs/geemap/blob/master/geemap/conversion.py) of the geemap package can greatly reduce the time needed to convert existing GEE JavaScripts to Python scripts and Jupyter notebooks.
**Geemap** is intended for students and researchers, who would like to utilize the Python ecosystem of diverse libraries and tools to explore Google Earth Engine. It is also designed for existing GEE users who would like to transition from the GEE JavaScript API to Python API. The automated JavaScript-to-Python [conversion module](https://github.com/giswqs/geemap/blob/master/geemap/conversion.py) of the geemap package can greatly reduce the time needed to convert existing GEE JavaScripts to Python scripts and Jupyter notebooks.

For video tutorials and notebook examples, please visit the [examples page](https://github.com/giswqs/geemap/tree/master/examples). For complete documentation on geemap modules and methods, please visit the [API Reference](https://geemap.org/geemap/).

Expand Down Expand Up @@ -76,6 +77,6 @@ Below is a partial list of features available for the geemap package. Please che

## YouTube Channel

I have created a [YouTube Channel](https://www.youtube.com/c/QiushengWu) for sharing **geemap** tutorials. You can subscribe to my channel for regular updates. If there is any specific tutorial you would like to see, please submit a feature request [here](https://github.com/giswqs/geemap/issues).
I have created a [YouTube Channel](https://youtube.com/@giswqs) for sharing **geemap** tutorials. You can subscribe to my channel for regular updates. If there is any specific tutorial you would like to see, please submit a feature request [here](https://github.com/giswqs/geemap/issues).

[![Earth Engine Tutorials on YouTube](https://wetlands.io/file/images/youtube.png)](https://www.youtube.com/c/QiushengWu)
[![Earth Engine Tutorials on YouTube](https://wetlands.io/file/images/youtube.png)](https://youtube.com/@giswqs)
2 changes: 1 addition & 1 deletion docs/notebooks/39_timelapse.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"\n",
"**Web Apps:** https://streamlit.geemap.org\n",
"\n",
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://www.youtube.com/c/QiushengWu))"
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://youtube.com/@giswqs))"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/41_water_app.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"2. Adjust the parameters (e.g., band combination, threshold, color, download chart data) if needed. \n",
"3. Click the `Submit` button to create timeseries of Landsat imagery and normalized difference indices.\n",
"\n",
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://www.youtube.com/c/QiushengWu))"
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://youtube.com/@giswqs))"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## YouTube Channel

More video tutorials for geemap and Earth Engine are available on my [YouTube channel](https://www.youtube.com/c/QiushengWu). If you can't access YouTube in your country, you can try [西瓜视频](http://gishub.org/xigua) or [哔哩哔哩](https://space.bilibili.com/527404442)
More video tutorials for geemap and Earth Engine are available on my [YouTube channel](https://youtube.com/@giswqs). If you can't access YouTube in your country, you can try [西瓜视频](http://gishub.org/xigua) or [哔哩哔哩](https://space.bilibili.com/527404442)

[![Earth Engine Tutorials on YouTube](https://wetlands.io/file/images/youtube.png)](https://www.youtube.com/c/QiushengWu)
[![Earth Engine Tutorials on YouTube](https://wetlands.io/file/images/youtube.png)](https://youtube.com/@giswqs)

## geemap Tutorials

Expand Down
2 changes: 1 addition & 1 deletion docs/workshops/Crop_Mapping_2022.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"- [Awesome GEE Community Datasets](https://samapriya.github.io/awesome-gee-community-datasets)\n",
"- [Geemap website](https://geemap.org/)\n",
"- [Geemap book](https://book.geemap.org/)\n",
"- [Geemap YouTube videos](https://www.youtube.com/c/QiushengWu)"
"- [Geemap YouTube videos](https://youtube.com/@giswqs)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/workshops/Japan_2022.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"- [Awesome GEE Community Datasets](https://samapriya.github.io/awesome-gee-community-datasets)\n",
"- [Geemap website](https://geemap.org/)\n",
"- [Geemap book](https://book.geemap.org/)\n",
"- [Geemap YouTube videos](https://www.youtube.com/c/QiushengWu)\n",
"- [Geemap YouTube videos](https://youtube.com/@giswqs)\n",
"- [Streamlit Web App](https://github.com/giswqs/streamlit-geospatial)\n",
"\n",
"## Installing geemap\n",
Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

## YouTube Channel

More video tutorials for geemap and Earth Engine are available on my [YouTube channel](https://www.youtube.com/c/QiushengWu). If you can't access YouTube in your country, you can try [西瓜视频](http://gishub.org/xigua) or [哔哩哔哩](https://space.bilibili.com/527404442)
More video tutorials for geemap and Earth Engine are available on my [YouTube channel](https://youtube.com/@giswqs). If you can't access YouTube in your country, you can try [西瓜视频](http://gishub.org/xigua) or [哔哩哔哩](https://space.bilibili.com/527404442)

[![Earth Engine Tutorials on YouTube](https://wetlands.io/file/images/youtube.png)](https://www.youtube.com/c/QiushengWu)
[![Earth Engine Tutorials on YouTube](https://wetlands.io/file/images/youtube.png)](https://youtube.com/@giswqs)

## Tutorials

Expand Down
2 changes: 1 addition & 1 deletion examples/notebooks/39_timelapse.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"\n",
"**Web Apps:** https://streamlit.geemap.org\n",
"\n",
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://www.youtube.com/c/QiushengWu))"
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://youtube.com/@giswqs))"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/notebooks/41_water_app.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"2. Adjust the parameters (e.g., band combination, threshold, color, download chart data) if needed. \n",
"3. Click the `Submit` button to create timeseries of Landsat imagery and normalized difference indices.\n",
"\n",
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://www.youtube.com/c/QiushengWu))"
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://youtube.com/@giswqs))"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/notebooks/water_app.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"\n",
"**Web Apps:** https://gishub.org/water-app, https://gishub.org/water-ngrok\n",
"\n",
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://www.youtube.com/c/QiushengWu))"
"**Contact:** Dr. Qiusheng Wu ([Website](https://wetlands.io/), [LinkedIn](https://www.linkedin.com/in/qiushengwu), [Twitter](https://twitter.com/giswqs), [YouTube](https://youtube.com/@giswqs))"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/workshops/Crop_Mapping_2022.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"- [Awesome GEE Community Datasets](https://samapriya.github.io/awesome-gee-community-datasets)\n",
"- [Geemap website](https://geemap.org/)\n",
"- [Geemap book](https://book.geemap.org/)\n",
"- [Geemap YouTube videos](https://www.youtube.com/c/QiushengWu)"
"- [Geemap YouTube videos](https://youtube.com/@giswqs)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/workshops/Japan_2022.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"- [Awesome GEE Community Datasets](https://samapriya.github.io/awesome-gee-community-datasets)\n",
"- [Geemap website](https://geemap.org/)\n",
"- [Geemap book](https://book.geemap.org/)\n",
"- [Geemap YouTube videos](https://www.youtube.com/c/QiushengWu)\n",
"- [Geemap YouTube videos](https://youtube.com/@giswqs)\n",
"- [Streamlit Web App](https://github.com/giswqs/streamlit-geospatial)\n",
"\n",
"## Installing geemap\n",
Expand Down
Loading

0 comments on commit 72edb6b

Please sign in to comment.