Initialize with user name and password

$ planet auth init

See API key that is being used for requests

$ planet auth value

NOTE: Right now you must init before you get help, until planetlabs#463 is resolved

Most commands are pretty self-documenting, can use --help after any command to get usage info. And many will give you help if you don't form a complete command.

$ planet --help
$ planet
$ planet orders
$ planet orders list --help

See recent orders you've made

$ planet orders list

Print them more nicely (both are options, jq is a bit more advanced, but prints a bit nicer and is more powerful)

$ planet orders list | jq
$ planet orders list --pretty

Get the number of your recent orders. (-s collects objects into a single array)

$ planet orders list | jq -s length

Get more info on a single order

$ planet orders get 782b414e-4e34-4f31-86f4-5b757bd062d7

Download the order

$ planet orders download 782b414e-4e34-4f31-86f4-5b757bd062d7

Download it to a different directory (relative to where the command is run)

$ mkdir psscene
$ planet orders download 782b414e-4e34-4f31-86f4-5b757bd062d7 --directory psscene

Download to a directory specified absolutely (in this case to my desktop)

$ planet orders download 782b414e-4e34-4f31-86f4-5b757bd062d7 --directory /Users/cholmes/Desktop/

Verify the checksum to make sure the file I got wasn't corrupted along the way (during download, etc)

$ planet orders download 782b414e-4e34-4f31-86f4-5b757bd062d7 --checksum MD5

Create a new order request from a scene ID found in Explorer (Note that \ just tells the console to treat the next line as the same one - used here to be a bit easier to read)

$ planet orders request --name "My First Order" --bundle analytic_sr_udm2 --id 20220605_124027_64_242b \
 --item-type PSScene

Save to a file in the directory where the command was run

$ planet orders request --name "My First Order" --bundle analytic_sr_udm2 --id 20220605_124027_64_242b \
 --item-type PSScene > request-1.json

Make a new order with that request (should be the same as this one)

$ planet orders create request-1.json

Create the request and make a new order with it all in one call

$ planet orders request --name "My First Order" --bundle analytic_sr_udm2 --id 20220605_124027_64_242b \
 --item-type PSScene | planet orders create

Download the order. Note this only works when the order is ready:

$ planet orders download 65df4eb0-e416-4243-a4d2-38afcf382c30

Wait until the order is ready for download, then order it:

$ planet orders wait 65df4eb0-e416-4243-a4d2-38afcf382c30 \
&& planet orders download 65df4eb0-e416-4243-a4d2-38afcf382c30 

Create an order from a request, wait for it and download when ready (TODO: this works, but doesn't match usage examples, so should align to that.)

$ id=`planet orders create request-1.json | jq -r '.id'` && planet orders wait $id && planet orders download $id

Create an order clipped to a geometry

(download raw json from github, or preview)

$ planet orders request --item-type PSScene --clip geometry.geojson --name clipped-geom \
 --bundle analytic_sr_udm2 --id 20220605_124027_64_242b | planet orders create

Order Two Scenes in one order

$ planet orders request --item-type PSScene --name "Two Scenes" \
 --bundle analytic_sr_udm2 --id 20220605_124027_64_242b,20220605_124025_34_242b | planet orders create

Composite them together

Use this, save as tools-composite.json

[
    {
      "composite": {
        }
    }
]

Then create command and order

$ planet orders request --item-type PSScene --name "Two Scenes Composited" \
 --bundle analytic_sr_udm2 --id 20220605_124027_64_242b,20220605_124025_34_242b --tools tools-composite.json | planet orders create

Get the output as a cloud-optimized GeoTIFF: (save as tools-cog.json)

[
    {
      "composite": {
        }
    },
    {
    "file_format": {
        "format": "COG"
      }
    }
]

The following command just shows the output, you can pipe into orders create if you'd like:

$ planet orders request --item-type PSScene --name "Two Scenes Composited" \
 --bundle analytic_sr_udm2 --id 20220605_124027_64_242b,20220605_124025_34_242b --tools tools-cog.json

To clip and composite you need to specify the clip in the tools (instead of --clip). Can get it from this gist

$ planet orders request --item-type PSScene --name "Two Scenes Clipped and Composited" \
 --bundle analytic_sr_udm2 --id 20220605_124027_64_242b,20220605_124025_34_242b --tools tools-clip-composite.json

Or can even stream that in:

$ url -s https://gist.githubusercontent.com/cholmes/378d050a263ae433ddbbb91c3439994b/raw/ebcaa54cacdc6f696a0506705785f8ff8dae9af1/ \
tools-clip-composite.json | planet orders request --item-type PSScene --name "Streaming Clip & Composite" \
 --bundle analytic_sr_udm2 --id 20220605_124027_64_242b,20220605_124025_34_242b --tools - | planet orders create

TODO: STAC Output

Run a search for all the latest planetscope scenes that you have download access to:

$ planet data filter > filter.json
$ planet data search-quick PSScene filter.json

Or using piping (recommended)

$ planet data filter | planet data search-quick PSScene -

Run a search for all the latest PS Scenes in a bounding box in Iowa:

Save this as geometry.json

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -93.7353,
              41.6236
            ],
            [
              -92.2741,
              41.6236
            ],
            [
              -92.2741,
              42.3747
            ],
            [
              -93.7353,
              42.3747
            ],
            [
              -93.7353,
              41.6236
            ]
          ]
        ]
      }
    }
  ]
}

$ planet data filter --geom geometry.json | planet data search-quick PSScene -

And turn into GeoJSON (many gis programs do better with 'real' geojson, the default output is newline delimited geojson)

$ planet data filter --geom geometry.json | planet data search-quick PSScene - | planet collect

Search just for 8-band assets

$ planet data filter --asset ortho_analytic_8b_sr | planet data search-quick PSScene -

Search for 8-band assets that also have a UDM

$ planet data filter --asset ortho_analytic_8b_sr --asset udm2 | planet data search-quick PSScene -

Search for any 8 band data, not just ones that you have download access to (default is only those you have access to)

$ planet data filter --permission false --asset ortho_analytic_8b_sr | planet data search-quick PSScene -

Make a filter for data acquired in July 2021

$ planet data filter --date-range acquired gte 2021-07-01 --date-range acquired lt 2021-08-01

Make a filter for data with clear pixels greater than 90%

$ planet data filter --range clear_percent gt 90

Search for all landsat 8, sentinel 2 and planetscope images in an area of interest

$ planet data filter --geom geometry.json  | planet data search-quick PSScene,Sentinel2L1C,Landsat8L1G

Get the id of the most recent skysat image taken (that you have download access to)

$ planet data filter | planet data search-quick SkySatCollect --limit 1 - | jq -r .id

Order the most recent skysat image taken.

$ planet orders request --name "SkySat Latest" --item-type SkySatCollect --bundle analytic \
--id `planet data filter | planet data search-quick SkySatCollect --limit 1 - | jq -r .id` \
| planet orders create

Get the 5 latest cloud free images in an area and create an order that clips to that area, using geometry.geojson from above: (this one uses variables in unix) (note that you need the tr and sd to format the output of jq into the comma delimited list we need as input. There is likely some better way to do this...) (currently lists two options, but only because range isn't yet working, so once that is we'll take it away. May also switch to PSScene)

$ ids=`planet data filter --geom geometry.geojson | planet data search-quick SkySatCollect --limit 5 - | jq -r .id | tr '\n' , | sed 's/.$//'`
$ ids=`planet data filter --geom geometry.geojson --range clear_percent gt 90 | planet data search-quick SkySatCollect --limit 5 - | jq -r .id | tr '\n' , | sed 's/.$//'`
$ planet orders request -- "Clipped Scenes" --item-type SkySatCollect --bundle analytic --id $ids | planet orders create --clip geometry.geojson

$ 

$ 

Run a search for planetscope data on a bounding box in Iowa

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -93.7353,
              41.6236
            ],
            [
              -92.2741,
              41.6236
            ],
            [
              -92.2741,
              42.3747
            ],
            [
              -93.7353,
              42.3747
            ],
            [
              -93.7353,
              41.6236
            ]
          ]
        ]
      }
    }
  ]
}

Run search for planetscope with cloud cover less than 20 Run search with permission filter to just be data that can be downloaded Run search with just good sun angles Run search for sentinel 2 images Run search for landsat8 images Run search for sentinel 1 images Run search for all data from Planet & public satellites for the last 5 grow seasons in Iowa (April 15 - October 15th) Get it into a shapefile for use by naive GIS people Get stats of number of images captured by satellite, show in chart Get stats of number of cloud free images by satellite Run search with a geojson of 7 small to moderate sized fields, try out a few filters Run search and turn results into STAC output, to: Understand results with stac-terminal Add to an existing stac catalog with stactools

planet orders list

--pretty or | jq

Order and download a scene id found from explorer

```console
20220605_124027_64_242b

$ 

$ 

$ 

As surface reflectance Order and download the results of 3-4 of the first set of searches above Order and download the above as STAC to: Add to an existing STAC catalog with stactools Browse resulting catalog with STAC Browser Visualize results in Unfolded Studio Do this with both surface reflectance data as well as clipped, composite, harmonized data. Run search of geojson of 7 moderate-sized fields, download clipped, cloud-free imagery of each. Do clip & composite of them Clip, composite & harmonize Clip, composite and NDVI COG’s for each of the outputs

Run a search for planetscope data on a bounding box in Iowa Run search for planetscope with cloud cover less than 20 Run search with permission filter to just be data that can be downloaded Run search with just good sun angles Run search for sentinel 2 images Run search for landsat8 images Run search for sentinel 1 images Run search for all data from Planet & public satellites for the last 5 grow seasons in Iowa (April 15 - October 15th) Get it into a shapefile for use by naive GIS people Get stats of number of images captured by satellite, show in chart Get stats of number of cloud free images by satellite Run search with a geojson of 7 small to moderate sized fields, try out a few filters Run search and turn results into STAC output, to: Understand results with stac-terminal Add to an existing stac catalog with stactools

Download 3 months of imagery over a small field stored in a shapefile, but only download the imagery that is 90% cloud free over the field. https://hello.planet.com/code/benjamin/cloud_free_order can help us Set up a subscription of planetscope data over a bound box in iowa With cloud cover less than 25% Set up a subscription clipped to the 7 small to moderate-sized fields And then do it with harmonization & composites Only use those that are 90% cloud-free over the actual AOI Backfill a subscription for the previous 6 months