Overview¶
cartoee
is a simple Python package used for making publication quality
maps from Earth Engine results using
Cartopy without having to
download results.
This packages aims to do only one thing well: getting processing results from
Earth Engine into a publication quality mapping interface. cartoee
simply gets results from Earth Engine and plots it with the correct geographic
projections leaving ee
and cartopy
to do more of the processing
and visualization.
A typical Earth Engine workflow includes:
- Processing your data on Earth Engine
- Exporting your data from Earth Engine
- Creating maps of your results
Here, we omit the 2nd step and merge steps 1 and 3 into one step. This allows users to process their data using the Python Earth Engine API and quickly create a map.
Installation¶
cartoee
is available to install via pip
. To install the package,
you can use pip install for your Python environment:
$ pip install cartoee
Or, you can install the package manually from source code using the following commands:
$ git clone https://github.com/kmarkert/cartoee.git
$ cd cartoee
$ python setup.py install
Dependencies¶
cartoee
is built using pure Python code however relies on a few dependencies
(earthengine-api and cartopy)
that are available. These additional Python packages have their own dependencies
and users are referred to the dependencies documentation for full installation
instructions:
Using the pip install
command will install all of the necessary dependencies
needed for using cartoee.
Warning
Additional steps need to be taken to authenticate your local machine to use the Earth Engine API. You can do this using the following command and follow the instructions:
$ earthengine authenticate
To test that cartoee and all of the dependencies have been installed correctly, run the following command:
$ cee_install_test
Note
- If your local machine is not yet authenticated for Earth Engine, the
cee_install_test
will walk you through the authentication process.
If all of the test are successful, you will see no ‘failed’ when the test is done.