Skip to content

Commit

Permalink
change README to rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Rodrigo committed Nov 7, 2017
1 parent e0174f4 commit d6692e6
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions README.md → README.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
Gee Bap
=
Best Available Pixel (Bap) Composite using the Python API of Google Earth Engine (Gee)
-
Best Available Pixel (Bap) Composite using
------------------------------------------
the Python API of Google Earth Engine (Gee)
-------------------------------------------

This code is based on *Pixel-Based Image Compositing for Large-Area Dense Time Series Applications and Science. (White et al., 2014)*
This code is based on *Pixel-Based Image Compositing for Large-Area Dense Time
Series Applications and Science. (White et al., 2014)*
http://www.tandfonline.com/doi/full/10.1080/07038992.2014.945827

It uses a series of pixel based scores to generate a composite with the *Best Available Pixel*, assuming it is the one that has better score.
It uses a series of pixel based scores to generate a composite with the
*Best Available Pixel*, assuming it is the one that has better score.

Instalation
-
-----------

To use this package you must have installed and running Google Earth Engine Python API: https://developers.google.com/earth-engine/python_install
To use this package you must have installed and running Google Earth Engine
Python API: https://developers.google.com/earth-engine/python_install

Once you have that, proceed

> pip install geebap


Available Collections
-
---------------------

- Serie Landsat

Expand All @@ -37,7 +40,7 @@ Available Collections
- Modis Terra

Available Scores
-
----------------

- Satellite
- Distance to clouds and shadows masks
Expand All @@ -48,14 +51,14 @@ Available Scores
- Absolute value of a vegetation index

Available Indices
-
-----------------

- NDVI
- EVI
- NBR

Basic Usage
-
-----------

.. code:: python
Expand Down

0 comments on commit d6692e6

Please sign in to comment.