README.md

stactools-worldpop

• Name: worldpop
• Package: stactools.worldpop
• PyPI: https://pypi.org/project/stactools-worldpop/
• Owner: @jamesvrt
• Dataset homepage: https://www.worldpop.org/
• STAC extensions used:
  • proj
  • scientific
  • raster
  • item-assets

Dataset Structure

WorldPop is a collection of 15 "projects" each containing several "categories" covering many demographic products and the supporting data used to derive them. This package is limited to two projects and two categories within each, totalling four categories:

• Project: Population counts (pop) [link]
  • Category: Unconstrained, UN adjusted, 100m (wpgpunadj) [link]
  • Category: Constrained, UN adjusted, 100m (cic2020_UNadj_100m) [link]
• Project: Population age and sex structure (age_structures) [link]
  • Category: Unconstrained, 100m (aswpgp) [link]
  • Category: Constrained, UN adjusted, 100m (ascicua_2020) [link]

You can read more about unconstrained vs. constrained methods here.

STAC Structure

The STAC is structured to match the project/category format of WorldPop, resulting in four separate STAC Collections. Each item in each Collection covers a country.

• Collection: Age and sex pop. structures (unconstrained, 100m)
  • Items: Countries * years
    • Assets: Ages * sexes
• Collection: Age and sex pop. structures (constrained, UN adj., 100m)
  • Items: Countries * 2020
    • Assets: Ages * sexes
• Collection: Population counts (unconstrained, UN adj., 100m)
  • Items: Countries * years
    • Assets: Ages * sexes
• Collection: Population counts (constrained, UN adj., 100m)
  • Items: Countries * 2020
    • Assets: Ages * sexes

STAC Examples

• Collection
• Item

Command-line usage

To create one Item:

$ stac worldpop create-item -d destination

To create one Collection (not populated with Items):

$ stac worldpop create-collection -d destination

To create one Collection and populate it with Items:

$ stac worldpop populate-collection -d destination

To create all Collections and populate them with Items:

$ stac worldpop populate-all-collections -d destination

To convert a GeoTIFF to a cloud optimized GeoTIFF (COG):

$ stac worldpop create-cog -d destination -s cog_path

Use stac worldpop <subcommand> --help to see all options.