Added conda-forge

gee-community · Mar 21, 2020 · ac08559 · ac08559
1 parent 268dd1c
commit ac08559
Show file tree

Hide file tree

Showing 34 changed files with 8,361 additions and 28 deletions.
diff --git a/README.rst b/README.rst
@@ -14,6 +14,9 @@ geemap
 .. image:: https://img.shields.io/pypi/v/geemap.svg
         :target: https://pypi.python.org/pypi/geemap
 
+.. image:: https://img.shields.io/conda/vn/conda-forge/geemap.svg
+        :target: https://anaconda.org/conda-forge/geemap
+
 .. image:: https://pepy.tech/badge/geemap
         :target: https://pepy.tech/project/geemap
 
@@ -34,7 +37,7 @@ A Python package for interactive mapping with Google Earth Engine, ipyleaflet, a
 * GitHub repo: https://github.com/giswqs/geemap
 * Documentation: https://geemap.readthedocs.io
 * PyPI: https://pypi.org/project/geemap/
-* 300+ GEE notebook examples: https://github.com/giswqs/earthengine-py-notebooks
+* 360+ GEE notebook examples: https://github.com/giswqs/earthengine-py-notebooks
 * Free software: MIT license
 
 
@@ -64,7 +67,7 @@ Installation
 ------------
 
 The **geemap** Python package is built upon the `ipyleaflet <https://github.com/jupyter-widgets/ipyleaflet>`__ and `folium <https://github.com/python-visualization/folium>`__ packages and
-implements several methods for displaying Earth Engine data layers, such as ``Map.addLayer()``, ``Map.setCenter()``, and ``Map.centerObject()``.
+implements several methods for interacting with Earth Engine data layers, such as ``Map.addLayer()``, ``Map.setCenter()``, and ``Map.centerObject()``.
 
 
 
@@ -75,13 +78,13 @@ To install **geemap**, run this command in your terminal:
   pip install geemap
 
 
-If you have Anaconda_ or Miniconda_ 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_ or Miniconda_ installed on your computer, you can create a conda Python environment to install geemap:
 
 .. code:: python
 
   conda create -n gee python
   conda activate gee
-  pip install geemap
+  conda install -c conda-forge geemap
 
 
 If you have installed **geemap** before and want to upgrade to the latest version, you can run the following command in your terminal:

diff --git a/examples/notebooks/ipyleaflet_tutorials.ipynb b/examples/notebooks/ipyleaflet_tutorials.ipynb
@@ -0,0 +1,153 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<table class=\"ee-notebook-buttons\" align=\"left\">\n",
+    "    <td><a target=\"_blank\"  href=\"https://github.com/giswqs/geemap/tree/master/examples/notebooks/ipyleaflet_tutorials.ipynb\"><img width=32px src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" /> View source on GitHub</a></td>\n",
+    "    <td><a target=\"_blank\"  href=\"https://nbviewer.jupyter.org/github/giswqs/geemap/blob/master/examples/notebooks/ipyleaflet_tutorials.ipynb\"><img width=26px src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/3/38/Jupyter_logo.svg/883px-Jupyter_logo.svg.png\" />Notebook Viewer</a></td>\n",
+    "    <td><a target=\"_blank\"  href=\"https://mybinder.org/v2/gh/giswqs/geemap/master?filepath=examples/notebooks/ipyleaflet_tutorials.ipynb\"><img width=58px src=\"https://mybinder.org/static/images/logo_social.png\" />Run in binder</a></td>\n",
+    "    <td><a target=\"_blank\"  href=\"https://colab.research.google.com/github/giswqs/geemap/blob/master/examples/notebooks/ipyleaflet_tutorials.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" /> Run in Google Colab</a></td>\n",
+    "</table>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Install Earth Engine API and geemap\n",
+    "Install the [Earth Engine Python API](https://developers.google.com/earth-engine/python_install) and [geemap](https://github.com/giswqs/geemap). The **geemap** Python package is built upon the [ipyleaflet](https://github.com/jupyter-widgets/ipyleaflet) and [folium](https://github.com/python-visualization/folium) packages and implements several methods for interacting with Earth Engine data layers, such as `Map.addLayer()`, `Map.setCenter()`, and `Map.centerObject()`.\n",
+    "The following script checks if the geemap package has been installed. If not, it will install geemap, which automatically installs its [dependencies](https://github.com/giswqs/geemap#dependencies), including earthengine-api, folium, and ipyleaflet.\n",
+    "\n",
+    "**Important note**: A key difference between folium and ipyleaflet is that ipyleaflet is built upon ipywidgets and allows bidirectional communication between the front-end and the backend enabling the use of the map to capture user input, while folium is meant for displaying static data only ([source](https://blog.jupyter.org/interactive-gis-in-jupyter-with-ipyleaflet-52f9657fa7a)). Note that [Google Colab](https://colab.research.google.com/) currently does not support ipyleaflet ([source](https://github.com/googlecolab/colabtools/issues/60#issuecomment-596225619)). Therefore, if you are using geemap with Google Colab, you should use [`import geemap.eefolium`](https://github.com/giswqs/geemap/blob/master/geemap/eefolium.py). If you are using geemap with [binder](https://mybinder.org/) or a local Jupyter notebook server, 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)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Installs geemap package\n",
+    "import subprocess\n",
+    "\n",
+    "try:\n",
+    "    import geemap\n",
+    "except ImportError:\n",
+    "    print('geemap package not installed. Installing ...')\n",
+    "    subprocess.check_call([\"python\", '-m', 'pip', 'install', 'geemap'])\n",
+    "\n",
+    "# Checks whether this notebook is running on Google Colab\n",
+    "try:\n",
+    "    import google.colab\n",
+    "    import geemap.eefolium as emap\n",
+    "except:\n",
+    "    import geemap as emap\n",
+    "\n",
+    "# Authenticates and initializes Earth Engine\n",
+    "import ee\n",
+    "\n",
+    "try:\n",
+    "    ee.Initialize()\n",
+    "except Exception as e:\n",
+    "    ee.Authenticate()\n",
+    "    ee.Initialize()  "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an interactive map \n",
+    "The default basemap is `Google Satellite`. [Additional basemaps](https://github.com/giswqs/geemap/blob/master/geemap/geemap.py#L13) can be added using the `Map.add_basemap()` function. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Map = emap.Map(center=[40,-100], zoom=4)\n",
+    "Map.add_basemap('ROADMAP') # Add Google Map\n",
+    "Map"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Add Earth Engine Python script "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Add Earth Engine dataset\n",
+    "image = ee.Image('USGS/SRTMGL1_003')\n",
+    "\n",
+    "# Set visualization parameters.\n",
+    "vis_params = {\n",
+    "  'min': 0,\n",
+    "  'max': 4000,\n",
+    "  'palette': ['006633', 'E5FFCC', '662A00', 'D8D8D8', 'F5F5F5']}\n",
+    "\n",
+    "# Print the elevation of Mount Everest.\n",
+    "xy = ee.Geometry.Point([86.9250, 27.9881])\n",
+    "elev = image.sample(xy, 30).first().get('elevation').getInfo()\n",
+    "print('Mount Everest elevation (m):', elev)\n",
+    "\n",
+    "# Add Earth Engine layers to Map\n",
+    "Map.addLayer(image, vis_params, 'DEM')\n",
+    "Map.addLayer(xy, {'color': 'red'}, 'Mount Everest')\n",
+    "\n",
+    "# Center the map based on an Earth Engine object or coordinates (longitude, latitude)\n",
+    "# Map.centerObject(xy, 4)\n",
+    "Map.setCenter(86.9250, 27.9881, 4)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Display Earth Engine data layers "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Map.addLayerControl() # This line is not needed for ipyleaflet-based Map.\n",
+    "Map"
+   ]
+  }
+ ],
+ "metadata": {
+  "anaconda-cloud": {},
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}
diff --git a/examples/notebooks/template.ipynb b/examples/notebooks/template.ipynb
@@ -0,0 +1,153 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<table class=\"ee-notebook-buttons\" align=\"left\">\n",
+    "    <td><a target=\"_blank\"  href=\"https://github.com/giswqs/geemap/tree/master/examples/template/template.ipynb\"><img width=32px src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" /> View source on GitHub</a></td>\n",
+    "    <td><a target=\"_blank\"  href=\"https://nbviewer.jupyter.org/github/giswqs/geemap/blob/master/examples/template/template.ipynb\"><img width=26px src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/3/38/Jupyter_logo.svg/883px-Jupyter_logo.svg.png\" />Notebook Viewer</a></td>\n",
+    "    <td><a target=\"_blank\"  href=\"https://mybinder.org/v2/gh/giswqs/geemap/master?filepath=examples/template/template.ipynb\"><img width=58px src=\"https://mybinder.org/static/images/logo_social.png\" />Run in binder</a></td>\n",
+    "    <td><a target=\"_blank\"  href=\"https://colab.research.google.com/github/giswqs/geemap/blob/master/examples/template/template.ipynb\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" /> Run in Google Colab</a></td>\n",
+    "</table>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Install Earth Engine API and geemap\n",
+    "Install the [Earth Engine Python API](https://developers.google.com/earth-engine/python_install) and [geemap](https://github.com/giswqs/geemap). The **geemap** Python package is built upon the [ipyleaflet](https://github.com/jupyter-widgets/ipyleaflet) and [folium](https://github.com/python-visualization/folium) packages and implements several methods for interacting with Earth Engine data layers, such as `Map.addLayer()`, `Map.setCenter()`, and `Map.centerObject()`.\n",
+    "The following script checks if the geemap package has been installed. If not, it will install geemap, which automatically installs its [dependencies](https://github.com/giswqs/geemap#dependencies), including earthengine-api, folium, and ipyleaflet.\n",
+    "\n",
+    "**Important note**: A key difference between folium and ipyleaflet is that ipyleaflet is built upon ipywidgets and allows bidirectional communication between the front-end and the backend enabling the use of the map to capture user input, while folium is meant for displaying static data only ([source](https://blog.jupyter.org/interactive-gis-in-jupyter-with-ipyleaflet-52f9657fa7a)). Note that [Google Colab](https://colab.research.google.com/) currently does not support ipyleaflet ([source](https://github.com/googlecolab/colabtools/issues/60#issuecomment-596225619)). Therefore, if you are using geemap with Google Colab, you should use [`import geemap.eefolium`](https://github.com/giswqs/geemap/blob/master/geemap/eefolium.py). If you are using geemap with [binder](https://mybinder.org/) or a local Jupyter notebook server, 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)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Installs geemap package\n",
+    "import subprocess\n",
+    "\n",
+    "try:\n",
+    "    import geemap\n",
+    "except ImportError:\n",
+    "    print('geemap package not installed. Installing ...')\n",
+    "    subprocess.check_call([\"python\", '-m', 'pip', 'install', 'geemap'])\n",
+    "\n",
+    "# Checks whether this notebook is running on Google Colab\n",
+    "try:\n",
+    "    import google.colab\n",
+    "    import geemap.eefolium as emap\n",
+    "except:\n",
+    "    import geemap as emap\n",
+    "\n",
+    "# Authenticates and initializes Earth Engine\n",
+    "import ee\n",
+    "\n",
+    "try:\n",
+    "    ee.Initialize()\n",
+    "except Exception as e:\n",
+    "    ee.Authenticate()\n",
+    "    ee.Initialize()  "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an interactive map \n",
+    "The default basemap is `Google Satellite`. [Additional basemaps](https://github.com/giswqs/geemap/blob/master/geemap/geemap.py#L13) can be added using the `Map.add_basemap()` function. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Map = emap.Map(center=[40,-100], zoom=4)\n",
+    "Map.add_basemap('ROADMAP') # Add Google Map\n",
+    "Map"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Add Earth Engine Python script "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Add Earth Engine dataset\n",
+    "image = ee.Image('USGS/SRTMGL1_003')\n",
+    "\n",
+    "# Set visualization parameters.\n",
+    "vis_params = {\n",
+    "  'min': 0,\n",
+    "  'max': 4000,\n",
+    "  'palette': ['006633', 'E5FFCC', '662A00', 'D8D8D8', 'F5F5F5']}\n",
+    "\n",
+    "# Print the elevation of Mount Everest.\n",
+    "xy = ee.Geometry.Point([86.9250, 27.9881])\n",
+    "elev = image.sample(xy, 30).first().get('elevation').getInfo()\n",
+    "print('Mount Everest elevation (m):', elev)\n",
+    "\n",
+    "# Add Earth Engine layers to Map\n",
+    "Map.addLayer(image, vis_params, 'DEM')\n",
+    "Map.addLayer(xy, {'color': 'red'}, 'Mount Everest')\n",
+    "\n",
+    "# Center the map based on an Earth Engine object or coordinates (longitude, latitude)\n",
+    "# Map.centerObject(xy, 4)\n",
+    "Map.setCenter(86.9250, 27.9881, 4)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Display Earth Engine data layers "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "Map.addLayerControl() # This line is not needed for ipyleaflet-based Map.\n",
+    "Map"
+   ]
+  }
+ ],
+ "metadata": {
+  "anaconda-cloud": {},
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}