diff --git a/README.md b/README.md index 728d3d0..0523763 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![Build Status](https://img.shields.io/badge/dynamic/json.svg?label=downloads&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Fgeeup%2Frecent%3Fperiod%3Dmonth&query=%24.data.last_month&colorB=blue&suffix=%2fmonth) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -This 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](https://github.com/samapriya/gee_asset_manager_addon) 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 thier 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. +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](https://github.com/samapriya/gee_asset_manager_addon) 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. ## Table of contents * [Installation](#installation) @@ -25,11 +25,11 @@ This assumes that you have native python & pip installed in your system, you can ```python``` and then ```pip list``` -If you get no errors and you have python 2.7.14 or higher you should be good to go. Please note that I have tested this only on python 2.7.15 but it should run on python 3. +If you get no errors and you have python 2.7.14 or higher you should be good to go. Please note that I have tested this only on python 2.7.15, but it should run on Python 3. **This also needs earthengine cli to be [installed and authenticated on your system](https://developers.google.com/earth-engine/python_install_manual) 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 +To install **geeup: Simple CLI for Earth Engine Uploads** you can install using two methods. ```pip install geeup``` @@ -40,9 +40,9 @@ git clone https://github.com/samapriya/geeup.git cd geeup python setup.py install ``` -For linux use sudo. +For Linux use sudo or try ```pip install geeup --user```. -Installation is an optional step; the application can be also run directly by executing geeup.py script. The advantage of having it installed is being able to execute ppipe as any command line tool. I recommend installation within virtual environment. If you don't want to install, browse into the geeup folder and try ```python geeup.py``` to get to the same result. +Installation is an optional step; the application can also be run directly by executing geeup.py script. The advantage of having it installed is that geeup can be executed as any command line tool. I recommend installation within a virtual environment. If you don't want to install, browse into the geeup folder and try ```python geeup.py``` to get to the same result. ## Getting started @@ -77,13 +77,13 @@ optional arguments: ``` -To obtain help for a 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]` +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. +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. ### selenium update -This download selenium drivers and places to to your local directory for windows and linux subsystems. This is the first step to use selenium supported upload. +**This is a key step since all upload function depends on this step, 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. ``` geeup update``` @@ -98,7 +98,7 @@ optional arguments: ``` ### gee Zipshape -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 together, this tool looks for the shp file and finds the subsidary files and zips them ready for upload. It also helps when your have limited upload bandwith. 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. +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 @@ -113,7 +113,7 @@ Required named arguments.: ``` ### gee upload -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; with optional parameter you can provide a different name. +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; with the optional parameter you can provide a different name. ``` usage: geeup upload [-h] --source SOURCE --dest DEST [-m METADATA] @@ -138,7 +138,7 @@ Optional named arguments: --nodata NODATA The value to burn into the raster as NoData (missing data) --bands BANDS Comma-separated list of names to use for the image - bands. Spacesor other special characters are not + bands. Spaces or other special characters are not allowed. -b BUCKET, --bucket BUCKET Google Cloud Storage bucket name. @@ -146,7 +146,7 @@ Optional named arguments: ``` ### gee selupload -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; with optional parameter you can provide a different name. +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; with the optional parameter you can provide a different name. ``` usage: geeup.py selupload [-h] --source SOURCE --dest DEST [-m METADATA] @@ -194,7 +194,7 @@ Required named arguments.: ``` ### gee tasks -This script counts all currently running,ready,completed,failed and cancelled tasks along with failed tasks. This is linked to the account you initialized with your google earth engine account. This takes no 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] @@ -204,7 +204,7 @@ optional arguments: ``` ### gee delete -The delete is recursive, meaning it will delete also all children assets: images, collections and folders. Use with caution! +The delete is recursive, meaning it will also delete all children assets: images, collections, and folders. Use with caution! ``` usage: geeup delete [-h] id @@ -221,7 +221,7 @@ optional arguments: ### v0.0.9 -- fixed attribution and dependecy issues +- fixed attribution and dependency issues - Included poster to improve streaming uploads - All uploads now use selenium