Skip to content

Commit 480b4db

Browse files
committed
docs
1 parent 456ea41 commit 480b4db

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ export MAPBOX_ACCESS_TOKEN=my.token
7171
- [`list-sources`](#list-sources)
7272
- [`delete-source`](#delete-source)
7373
- [`estimate-area`](#estimate-area)
74+
- [`estimate-cu`](#estimate-cu)
7475
- Recipes
7576
- [`view-recipe`](#view-recipe)
7677
- [`validate-recipe`](#validate-recipe)
@@ -222,6 +223,29 @@ Usage
222223
tilesets delete-source user source_id
223224
```
224225

226+
### estimate-cu
227+
228+
```shell
229+
tilesets estimate-cu <tileset> -s/--sources <sources> -b/--num-bands <number> --raw
230+
```
231+
232+
Estimates the CU value of a tileset before publishing it. This is useful to understand the estimated cost a given tileset before you start processing the data. Note: This is currently only available to tileset recipes with type `raster` and `rasterarray`.
233+
234+
Flags:
235+
- `-s` or `--sources` [optional]: Local path to the sources that your recipe points at. This is highly recommeneded.
236+
- `-b` or `--num-bands` [optional]: The number of bands you expect your recipe to select across all layers. This is recommended.
237+
- `--raw` [optional]: This will toggle the pretty print output.
238+
239+
Usage
240+
241+
```shell
242+
# Estimate the CUs for 'account.tileset' with sources located in 'path/to/sources/' and a band count of 20.
243+
tilesets estimate-cu account.tileset -s 'path/to/sources/*.grib2' -b 20
244+
245+
# Estimate the CUs for 'account.tileset' for a single source and a band count of 10 (pretty print the results)
246+
tilesets estimate-cu account.tileset -s 'path/to/sources/helloworld.grib2' -b 10 --raw
247+
```
248+
225249
### estimate-area
226250

227251
```shell

0 commit comments

Comments
 (0)