eeExtra
=======
.. raw:: html
.. toctree::
:maxdepth: 2
:caption: API Reference
:hidden:
modules/index
**GitHub**: `https://github.com/r-earthengine/ee_extra `_
**Documentation**: `https://ee-extra.readthedocs.io `_
**PyPI**: `https://pypi.python.org/pypi/ee_extra `_
**Conda-forge**: `https://anaconda.org/conda-forge/ee_extra `_
Overview
--------
`Google Earth Engine `_ (GEE) is a cloud-based service for
geospatial processing of vector and raster data. The Earth Engine platform has a
`JavaScript and a Python API `_ with
different methods to process geospatial objects. Google Earth Engine also provides a
`HUGE PETABYTE-SCALE CATALOG `_ of
raster and vector data that users can process online.
There are a lot of fantastic third-party GEE packages and projects around GitHub. However,
most of them are coded in JavaScript or Python, and they are not straightforward
to translate to R, Julia, or other programming languages. The main goal of `eeExtra` is
to guarantee a smooth `import` of these projects in other programming languages by
standardizing different methods and enabling the use of JavaScript modules outside the
`Code Editor `_.
.. raw:: html
Some of the `eeExtra` features are listed here:
- Automatic scaling and offsetting.
- Spectral Indices computation (using `Awesome Spectral Indices `_).
- Clouds and shadows masking.
- STAC related functions.
And the most important feature:
- Enabling the usage of JavaScript modules outside the Code Editor.
How does it work?
-----------------
`eeExtra` is a Python package, just like any other, but it is a *ninja* that serves as a
methods provider for different environments: R, Julia and Python itself. `eeExtra`
accomplish this by being the powerhouse of some amazing packages such as `rgee `_,
`rgee+ `_, and `eemont `_.
Public JavaScript module can also be used outside the Code Editor in these packages
through `eeExtra`. For this, `eeExtra` implements a rigorous JavaScript translation
module that allows users to install, require and use JavaScript modules as if they
were on the Code Editor!
You may be wondering *"Why is it a ninja package?"*, well, that's a valid question,
the whole point of `eeExtra` resides in the fact that nobody has to use `eeExtra` itself,
but rather use one of the packages that are powered by `eeExtra`! :)
Installation
------------
Install the latest version from PyPI:
.. code-block:: python
pip install ee_extra
Install soft ee_extra dependencies:
.. code-block:: python
pip install jsbeautifier regex
Upgrade `eeExtra` by running:
.. code-block:: python
pip install -U ee_extra
Install the latest version from conda-forge:
.. code-block:: python
conda install -c conda-forge ee_extra
Install the latest dev version from GitHub by running:
.. code-block:: python
pip install git+https://github.com/r-earthengine/ee_extra