This tool came of the simple need to handle batch uploads of both image assets to collections but also thanks to the new table feature the possibility of batch uploading shapefiles into a folder. Though a lot of these tools including batch image uploader is part of my other project geeadd which also includes additional features to add to the python CLI, this tool was designed to be minimal so as to allow the user to simply query their quota, upload images or tables and also to query ongoing tasks and delete assets. I am hoping this tool with a simple objective proves useful to a few users of Google Earth Engine.
-If you find this tool useful, star and cite it as below
Samapriya Roy. (2021). samapriya/geeup: geeup: Simple CLI for Earth Engine Uploads (0.5.1). Zenodo. https://doi.org/10.5281/zenodo.5144379
ReadMe Page: https://samapriya.github.io/geeup/
This assumes that you have native python & pip installed in your system, you can test this by going to the terminal (or windows command prompt) and trying
python and then
geeup now only support Python v3.4 or higher from geeup version 0.3.3
This command line tool is dependent on functionality from GDAL
For installing GDAL in Ubuntu
sudo add-apt-repository ppa:ubuntugis/ppa && sudo apt-get update sudo apt-get install gdal-bin sudo apt-get install python-gdal
Shapely and a few other libraries are notoriously difficult to install on windows machines so follow the steps mentioned here before installing porder. You can download and install shapely and other libraries from the Unofficial Wheel files from here download depending on the python version you have. Do this only once you have install GDAL. I would recommend the steps mentioned above to get the GDAL properly installed. However I am including instructions to using a precompiled version of GDAL similar to the other libraries on windows. You can test to see if you have gdal by simply running
in your command prompt. If you get a read out and not an error message you are good to go. If you don't have gdal try Option 1,2 or 3 in that order and that will install gdal along with the other libraries
Starting from geeup v0.3.4 onwards:
geeup -h after installation. This should go fetch the extra libraries you need and install them. Once installation is complete, the porder help page will show up. This should save you from the few steps below.
If this does not work or you get an unexpected error try the following commands. You can also use these commands if you simply want to update these libraries.
pipwin refresh pipwin install gdal
For Windows I also found this guide from UCLA
Also for Ubuntu Linux I saw that this is necessary before the install
sudo apt install libcurl4-openssl-dev libssl-dev
This also needs earthengine cli to be installed and authenticated on your system and earthengine to be callable in your command line or terminal
To install geeup: Simple CLI for Earth Engine Uploads you can install using two methods.
pip install geeup
or you can also try
git clone https://github.com/samapriya/geeup.git cd geeup python setup.py install
For Linux use sudo or try
pip install geeup --user.
I recommend installation within a virtual environment. Find more information on creating virtual environments here.
This tool assumes that you have a Google Earth Engine account. The earthengine command line tool needs to be authenticated using a Google account.
or in a terminal you can also use
earthengine authenticate --quiet
As usual, to print help:
To obtain help for specific functionality, simply call it with help switch, e.g.:
geeup zipshape -h. If you didn't install geeup, then you can run it just by going to geeup directory and running
python geeup.py [arguments go here]
geeup Simple CLI for Earth Engine Uploads
The tool is designed to handle batch uploading of images and tables(shapefiles). While there are image collection where you can batch upload imagery, for vector or shapefiles you have to batch upload them to a folder.
This is a key step only if you are going to use selenium method to upload imagery instead of the cookies approach added since v0.4.6. All versions before 0.4.6 requires this step, since all upload function depends on it, so make sure you run this. This downloads selenium driver and places to your local directory for windows and Linux subsystems. This is the first step to use selenium supported upload.
Once in a while the geckodriver/selenium requires manual input before signing into the google earth engine, this tool will allow you to interact with the initialization of Google Earth Engine code editor window. It allows the user to specify the account they want to use, and should only be needed once.
Just a simple tool to print your earth engine quota quickly. Since Google Earth Engine also allows you to use Cloud Projects instead of the standard legacy folders, this tool now has the option to pass the project path (usually projects/project-name/assets/)
usage: geeup quota [-h] [--project PROJECT] optional arguments: -h, --help show this help message and exit Optional named arguments: --project PROJECT Project Name usually in format projects/project- name/assets/
So here's how table upload in Google Earth Engine works, you can either upload the component files shp, shx, prj and dbf or you can zip these files together and upload it as a single file. The pros for this is that it reduces the overall size of the shapefile after zipping them along, this tool looks for the shp file and finds the subsidiary files and zips them ready for upload. It also helps when you have limited upload bandwidth. Cons you have to create a replicate structure of the file system, but it saves on bandwidth and auto-arranges your files so you don't have to look for each additional file.
usage: geeup zipshape [-h] --input INPUT --output OUTPUT optional arguments: -h, --help show this help message and exit Required named arguments.: --input INPUT Path to the input directory with all shape files --output OUTPUT Destination folder Full path where shp, shx, prj and dbf files if present in input will be zipped and stored
This script generates a generalized metadata using information parsed from gdalinfo and metadata properties. For now it generates metadata with image name, x and y dimension of images and the number of bands.
usage: geeup getmeta [-h] --input INPUT --metadata METADATA optional arguments: -h, --help show this help message and exit Required named arguments.: --input INPUT Path to the input directory with all raster files --metadata METADATA Full path to export metadata.csv file
Setting up Cookies
This method was added since v0.4.6 and uses a third party chrome extension to simply code all cookies. The chrome extension is simply the first one I found and is no way related to the project and as such I do not extend any support or warranty for it.
The chrome extension I am using is called Copy Cookies and you can find it here
It does exactly one thing, copies cookies over and in this case we are copying over the cookies after logging into code.earthengine.google
Import things to Note
- Open a brand new incognito or a browser window while you are copying cookies, if you have multiple GEE accounts open on the same browser the cookies being copied may create some read issues at GEE end.
- Clear cookies and make sure you are copying cookies from code.earthengine.google in a fresh browser instance if upload fails with a
Unable to readerror.
- Make sure you save the cookie for the same account which you initiliazed using earthengine authenticate
To run cookie_setup and to parse and save cookie user
For Bash the cannonical mode will allow you to only paste upto 4095 characters and as such geeup cookie_setup might seem to fail for this use the following steps
Disable cannonical mode by typing
stty -icanonin terminal
Once done reenable cannonical mode by typing
stty icanonin terminal
Since cookies generated here are post login, theoretically it should work on accounts even with two factor auth or university based Single Sign on GEE accounts but might need further testing
The script creates an Image Collection from GeoTIFFs in your local directory. By default, the image name in the collection is the same as the local directory name. The upload tool now allows the user to copy cookie list from your browser and bypass selenium based authentication. It saves the cookie temporarily and uses it automatically till it expires when it asks you for cookie list again. Just use the
--method cookies argument.
This tool allows you to batch download tables/shapefiles/CSVs to a folder. It uses a modified version of the image upload and a wrapper around the earthengine upload cli to achieve this while creating folders if they don't exist and reporting on assets and checking on uploads. This only requires a source, destination and your ee authenticated email address. This tool also uses selenium to upload the tables. The table upload tool now allows the user to copy cookie list from your browser and bypass selenium based authentication. It saves the cookie temporarily and uses it automatically till it expires when it asks you for cookie list again. Just use the
--method cookies argument.
This script counts all currently running, ready, completed, failed and canceled tasks along with failed tasks. This tool is linked to your google earth engine account with which you initialized the earth engine client. This takes no argument.
usage: geeup tasks [-h] optional arguments: -h, --help show this help message and exit
The delete is recursive, meaning it will also delete all children assets: images, collections, and folders. Use with caution!
usage: geeup delete [-h] id positional arguments: id Full path to asset for deletion. Recursively removes all folders, collections and images. optional arguments: -h, --help show this help message and exit