Skip to content

Commit

Permalink
Updated README and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
giswqs committed Mar 16, 2020
1 parent 2b2f976 commit e598090
Show file tree
Hide file tree
Showing 7 changed files with 213 additions and 154 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ recursive-include geemap *
recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
recursive-exclude * *.ipynb

recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
71 changes: 67 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
geemap
======

.. image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://gishub.org/geemap-colab

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/giswqs/geemap/master

.. image:: https://binder.pangeo.io/badge_logo.svg
:target: https://binder.pangeo.io/v2/gh/giswqs/geemap/master

.. image:: https://img.shields.io/pypi/v/geemap.svg
:target: https://pypi.python.org/pypi/geemap
Expand All @@ -11,23 +19,78 @@ geemap

.. image:: https://readthedocs.org/projects/geemap/badge/?version=latest
:target: https://geemap.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status


.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT


A Python package for interactive mapping using Google Earth Engine and ipyleaflet
Authors: Dr. Qiusheng Wu (https://wetlands.io)

A Python package for interactive mapping using Google Earth Engine, ipyleaflet, and ipywidgets

* Free software: MIT license
* GitHub repo: https://github.com/giswqs/geemap
* Documentation: https://geemap.readthedocs.io.
* PyPI: https://pypi.org/project/geemap/
* Free software: MIT license


**Contents**

- `Features`_
- `Installation`_
- `Examples`_
- `Dependencies`_
- `Reporting Bugs`_
- `Credits`_




Features
--------

* TODO


Installation
------------
To install **geemap** , run this command in your terminal:

.. code:: python
pip install geemap
If you have Anaconda_ or Miniconda_ installed on your computer, you can use conda to install geemap:

.. code:: python
conda create -n gee python
conda activate gee
pip install geemap
If you have installed **geemap** before and want to upgrade to the latest version, you can use the following command:

.. code:: python
pip install geemap -U
.. _Anaconda: https://www.anaconda.com/distribution/#download-section
.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html


Examples
--------

* TODO

Dependencies
------------

* TODO

Credits
-------

Expand Down
14 changes: 7 additions & 7 deletions examples/geemap_and_earthengine.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "6c884effc340498fa0110cef0384f6c5",
"model_id": "641647807b1f4455b9fe5ee212f24bb6",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -180,7 +180,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "99d4dd1ad5504d60a70c49d9dadcc45f",
"model_id": "78a3d92d01f84e7a966a7101846e9da8",
"version_major": 2,
"version_minor": 0
},
Expand All @@ -194,7 +194,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "3c895859bccd47cf8e67ec2f58c5f58f",
"model_id": "dce43ae572a74c07b2c8bdd41edd45df",
"version_major": 2,
"version_minor": 0
},
Expand All @@ -208,7 +208,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "74bc908b4b774c498a5220f571b5391c",
"model_id": "c95c36e21fb641949b6becf41057f80e",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -294,7 +294,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "294832e9e4554e9fb03f9a1352763dab",
"model_id": "2b54e333499a40f0ad61d9c64a077bf9",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -396,7 +396,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "a74d022089c64764a10bc382d1e740fa",
"model_id": "4936457fe6454d93bb55df4e0ee12dfd",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -428,7 +428,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "ea08c1d5e089418980591272f02f71ec",
"model_id": "29ecfca8bdb24a1f9dba233590c1727b",
"version_major": 2,
"version_minor": 0
},
Expand Down
12 changes: 6 additions & 6 deletions examples/geemap_and_ipyleaflet.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "f2a2e260cf384c3692446e9993b6c9e0",
"model_id": "0e795277feb440b69275463fa833796e",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -162,7 +162,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "f272c104ff2943fab04de92c25cbb172",
"model_id": "4c39a8a3b47d432c8f4998f356c04a99",
"version_major": 2,
"version_minor": 0
},
Expand All @@ -176,7 +176,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "d6bf2e31548644748ad9d5da67cc947c",
"model_id": "5dea88e9447f419d86cfc8db50c20094",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -245,7 +245,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "12f6d52fa5584433ae6333e43308bbc6",
"model_id": "fb8919a870b249abbea9413b1dcd8dcd",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -321,7 +321,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "e2ed4267efbe440f9e7a154fd6d667d6",
"model_id": "b6bcdc88cacf49c39790ba5217fb879a",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -384,7 +384,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.3"
"version": "3.8.2"
}
},
"nbformat": 4,
Expand Down

0 comments on commit e598090

Please sign in to comment.