porder wrapper for Ordersv2 Batch Client
Project description
pobatch: porder wrapper for Ordersv2 Batch Client
This tool is an add-on to the porder tool, so read about the project here and make sure you take additional installation steps before starting with this. This tool fits the need to order large orders in terms of spatial and temporal grids, splitting them into smaller manageable orders while keeping in mind the concurrency limits(number of orders you can place simultaneously). In this case, the user sets a concurrency limit, and the tool automatically checks and waits before placing the next order. The tool can also estimate order size in terms of bytes per order download. The last step is to perform the same, download using porder's downloaders and an order list as created by multiorder tools. The design of this tool is kept simple, meaning you are relying on mixed use or porder and pobatch to perform these operations. Ordersv2 is the next iteration of Planet's API in getting Analysis Ready Data (ARD) delivered to you. Orders v2 allows you to improved functionality in this domain, including the capability to submit an number of images in a batch order, and perform operations such as top of atmospheric reflectance, compression, coregistration and also enhanced notifications such as email and webhooks.
Please note: This tool is in no way an official tool or Planet offering, but is a personal project created and maintained by Samapriya Roy
If you find this tool useful, star and cite it as below
Samapriya Roy. (2019, May 20). samapriya/pobatch: pobatch: porder wrapper for Ordersv2 Batch Client (Version 0.0.1). Zenodo.
http://doi.org/10.5281/zenodo.3066368
Table of contents
- Installation
- Getting started
- [porder wrapper for Ordersv2 Batch Client](#porder wrapper for Ordersv2 Batch Client)
Installation
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 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.
Shapely is notoriously tricky as a library to install on windows machines so follow the steps mentioned from Shapely’s PyPI package page. You can download and install from the Unofficial Wheel files from here download depending on the python version you have. You will get a wheel file or a file ending with .whl. You can now simply browse to the folder or migrate to it in your command prompt, for example in my case I was running Python 2.7.15 and win32 version so the command was
pip install Shapely-1.6.4.post1-cp27-cp27m-win32.whl
Or you can use anaconda to install. Again, both of these options are mentioned on Shapely’s Official PyPI page. Fiona is a recommended install used by the simplify tool, but it is not necessary. You can find installation instructions here
Once you have shapely configured. To install pobatch: porder wrapper for Ordersv2 Batch Client you can install using two methods
pip install pobatch
on Ubuntu I found it helps to specify the pip type and use sudo
sudo pip2 install pobatch or sudo pip3 install pobatch
or you can also try
git clone https://github.com/samapriya/pobatch.git
cd pobatch
python setup.py install
For linux use sudo or --user.
Installation is an optional step; the application can also be run directly by executing pobatch.py script. The advantage of having it installed is being able to execute pobatch as any command line tool. I recommend installation within a virtual environment. If you don't want to install, browse into the pobatch folder and try python pobatch.py
to get to the same result.
Getting started
Make sure you initialized planet client by typing planet init
or export
or set PL_API_KEY=Your API Key
As usual, to print help:
pobatch -h
usage: pobatch [-h] {idsplit,multiorder,ordsize,downloader} ...
porder wrapper for Ordersv2 Batch Client
positional arguments:
{quota,idsplit,multiorder,ordsize,downloader}
idlist Get idlist using geometry & filters
quota Prints your Planet Quota Details
idsplit Splits ID list incase you want to run them in small
batches
multiorder Place multiple orders based on idlists in folder
ordsize Estimates total download size for each completed
order(Takes times)
downloader Download using order url list
optional arguments:
-h, --help show this help message and exit
To obtain help for a specific functionality, simply call it with help switch, e.g.: pobatch idsplit -h
. If you didn't install pobatch, then you can run it just by going to pobatch directory and running python pobatch.py [arguments go here]
porder wrapper for Ordersv2 Batch Client
The tool is built as a wrapper around the porder tool. The porder tool contains additionally useful tools such as convert shapefile to geojson, base64 encode your gcs credentials, simplify your geometry to fit the 500 vertices requirements and so on. So the idea is to use both of those tools in conjunction and make desired pipelines as needed. This tools is created to give the user some control over long and tedious order queue and implement push and pull of data in a batch manner.
quota
Just a simple tool to print your planet subscription quota quickly.
porder quota
idlist
Create an idlist for your geometry based on some basic filters, including geometry, start and end date and cloud cover. If no cloud cover is specified, everything from 0 to 100% cloud cover is included. For now the tool can handle geojson,json and kml files. The output is a csv file with ids. The tool also allows you to make sure you get percentage overlap, when selecting image, for clip operations adjust it accordingly (usally --ovp 1 for orders not to fail during clip). The tool now also prints estimated area in Square kilometers for the download and estimated area if you clipped your area with the geometry you are searching (just estimates).
I have changed the setup to now do the following two things
-
The number option is optional, so it can look for all images in the time range, but be careful if the area is too large, use at own risk. A better option is to supply the number.
-
It is possible to often forget about the different asset types, so you can now not pass an item and the script will return every possible type of asset for each item type depending on the bundle.
pobatch idlist -h
usage: pobatch idlist [-h] --input INPUT --start START --end END --item ITEM
[--asset ASSET] --outfile OUTFILE [--cmin CMIN]
[--cmax CMAX] [--number NUMBER] [--overlap OVERLAP]
[--filters FILTERS [FILTERS ...]]
optional arguments:
-h, --help show this help message and exit
Required named arguments.:
--input INPUT Input geometry file for now geojson/json/kml
--start START Start date in format YYYY-MM-DD
--end END End date in format YYYY-MM-DD
--item ITEM Item Type PSScene4Band|PSOrthoTile|REOrthoTile etc
--asset ASSET Asset Type analytic, analytic_sr,visual etc
--outfile OUTFILE Output csv file
Optional named arguments:
--cmin CMIN Minimum cloud cover
--cmax CMAX Maximum cloud cover
--number NUMBER Total number of assets, give a large number if you are
not sure
--overlap OVERLAP Percentage overlap of image with search area range
between 0 to 100
--filters FILTERS [FILTERS ...]
Add an additional string or range filter
A simple setup would be the following for 800 max item ids and an overlap of 5% with the geometry we pass to the filter
pobatch idlist --input "path to geometry.geojson" --start "YYYY-MM-DD" --end "YYYY-MM-DD" --item "PSScene4Band" --asset "analytic_sr" --number 800 --outfile "path to idlist.csv file" --overlap 5
To run an experiment to add additional filter, you can now pass an additional string or range filter or both flag for string and range filters, a setup would be. The additional filters are optional
pobatch idlist --input "Path to geojson file" --start "YYYY-MM-DD" --end "YYYY-MM-DD" --item "PSScene4Band" --asset "analytic" --outfile "Path to idlist.csv" --filters range:clear_percent:55:100 --number 20
pobatch idlist --input "Path to geojson file" --start "YYYY-MM-DD" --end "YYYY-MM-DD" --item "PSScene4Band" --asset "analytic" --outfile "Path to idlist.csv" --filters string:satellite_id:"1003,1006,1012,1020,1038" --number 20
pobatch idlist --input "Path to geojson file" --start "YYYY-MM-DD" --end "YYYY-MM-DD" --item "PSScene4Band" --asset "analytic" --outfile "Path to idlist.csv" --filters string:satellite_id:"1003,1006,1012,1020,1038" range:clear_percent:55:100 --number 20
The idlist tool can now use a multipolygon and iteratively look for scenes.
idsplit
This allows you to split your idlist into small csv files to created batches of orders.
usage: pobatch idsplit [-h] [--idlist IDLIST] [--lines LINES] [--local LOCAL]
optional arguments:
-h, --help show this help message and exit
--idlist IDLIST Idlist txt file to split
--lines LINES Maximum number of lines in each split files
--local LOCAL Output folder where split files will be exported
A simple setup would be
pobatch idsplit --idlist "path to idlist.csv" --lines "number of lines in each idlist" --local "folder path to export split id lists"
multiorder
This tool allows you to place the order using the idlist that you created earlier. the --op
argument allows you to take operations, delivery and notifications in a sequence for example --op toar clip email
performs Top of Atmospheric reflectance, followed by clipping to your geometry and send you an email notification once the order has completed, failed or had any change of status. The list of operations is below and order is important.
op | description |
---|---|
clip | Clip imagery can handle single and multi polygon verify or create geojson.io |
toar | Top of Atmosphere Reflectance imagery generated for imagery |
composite | Composite number of images in a given order |
zip | Zip bundles together and creates downloads (each asset has a single bundle so multiple zip files) |
zipall | Create a single zip file containing all assets |
compression | Use image compression |
projection | Reproject before downloaing image |
aws | Option called to specify delivery to AWS |
azure | Option called to specify delivery to AZURE |
gcs | Option called to specify delivery to GCS |
Email notification to your planet registered email |
You can now add some predefined indices for PlanetScope 4 band items with a maximum of 5 indices for a single setup . This is experimental. The list of indices include
Index | Source |
---|---|
Simple ratio (SR) | Jordan 1969 |
Normalized Difference Vegetation Index (NDVI) | Rouse et al 1973 |
Green Normalized Difference Index (GNDVI) | Gitelson et al 1996 |
Blue Normalized Difference Vegetation Index (BNDVI) | Wang et al 2007 |
Transformed Vegetation Index (TVI) | Broge and Leblanc 2000 |
Optimized Soil Adjusted Vegetation Index (OSAVI) | Rondeaux et al 1996 |
Enhanced Vegetation Index (EVI2) | Jian et al 2008 |
Normalized Difference Water Index (NDWI) | Gao 1996 |
Modified Soil-adjusted Vegetation Index v2 (MSAVI2) | Qi 1994 |
This tool makes use of the FIFO (first in first out) concept in queue implementation in python. It checks to see if you have reached your concurrent order limit and then waits for 5 minutes before trying to place the order again iteratively.
usage: pobatch multiorder [-h] --infolder INFOLDER --outfile OUTFILE --max MAX
--item ITEM --asset ASSET [--boundary BOUNDARY]
[--projection PROJECTION] [--kernel KERNEL]
[--compression COMPRESSION] [--aws AWS]
[--azure AZURE] [--gcs GCS] [--op OP [OP ...]]
optional arguments:
-h, --help show this help message and exit
Required named arguments.:
--infolder INFOLDER Folder with multiple order list
--outfile OUTFILE CSV file with list of order urls
--max MAX Maximum concurrent orders allowed on account
--item ITEM Item Type PSScene4Band|PSOrthoTile|REOrthoTile etc
--asset ASSET Asset Type analytic, analytic_sr,visual etc
Optional named arguments:
--boundary BOUNDARY Boundary/geometry for clip operation geojson|json|kml
--projection PROJECTION
Projection for reproject operation of type "EPSG:4326"
--kernel KERNEL Resampling kernel used "near", "bilinear", "cubic",
"cubicspline", "lanczos", "average" and "mode"
--compression COMPRESSION
Compression type used for tiff_optimize tool,
"lzw"|"deflate"
--aws AWS AWS cloud credentials config yml file
--azure AZURE Azure cloud credentials config yml file
--gcs GCS GCS cloud credentials config yml file
--op OP [OP ...] Add operations, delivery & notification clip|toar|comp
osite|zip|zipall|compression|projection|kernel|aws|azu
re|gcs|email <Choose indices from>:
ndvi|gndvi|bndvi|ndwi|tvi|osavi|evi2|msavi2|sr
ordsize
usage: pobatch ordsize [-h] --infile INFILE
optional arguments:
-h, --help show this help message and exit
Required named arguments.:
--infile INFILE CSV file with order list
downloader
The tool now allows you to estimate the total download size for a specific order.
usage: pobatch downloader [-h] --infile INFILE --folder FOLDER --method METHOD
optional arguments:
-h, --help show this help message and exit
Required named arguments.:
--infile INFILE CSV file with order list
--folder FOLDER Local folder to save order files
--method METHOD Method to be utilized for downloading
download|multipart|multiproc
Example Setup
- Get idlist for geometry using porder (porder is installed as a dependency for this tool)
pobatch idlist --input "geometry file.geojson" --start "2018-01-01" --end "2019-02-01" --item "PSScene4Band" --asset "analytic" --outfile "path to idlist.csv"
- Split idlist into smaller subparts
pobatch idsplit --idlist "idlist file created earlier" --lines "number of lines in split files" --local "folder where we save the split id files"
- Now place order using idlists that you created. This requires you to set up a limit on the maximum number of concurrent orders you can place. This setups clips the image to a geometry, zips them and send you an email notification on completion.
pobatch multiorder --infolder "folder where we save the split id files" --max "Maximum concurrent orders you can placed and allowed on your account" --outfile "path to an orderlist with order url" --item "PSScene4Band" --asset "analytic" --boundary "path to geometry.geojson" --op clip zip email
- Estimate order download size for each order (This is optional)
pobatch ordsize --infile "Path to order url list"
- Finally download the order, and choose the download method (choose from sequential download or download| multipart download or multiproc or multiprocessing download)
pobatch downloader --infile "Path to order url list" --folder "download folder" --method "multipart"
Changelog
v0.0.3
- Added queue support to downloader for better handling order list
- General improvements to overall tool
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pobatch-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0354370f4b57feee3949decbc506fd3fa06eb554e5673949c1b3346aba3f621c |
|
MD5 | 4f7a74a6407d222ec490e4246884923c |
|
BLAKE2b-256 | d1cacfed61c3dceba7cb0917ea8df2c504624252ce5d0f32a378eeb88822a934 |