JAXA catalog explorer¶

Browse the bundled JAXA catalog without touching the network. The catalog ships 118 STAC collections (the jaxa-earth protocol) plus six strategic G-Portal mission products (the gportal protocol), all driven by a protocol discriminator on each row.

No credentials needed; no [jaxa] extra needed for this notebook either.

Open the catalog¶

In [ ]:

from earthlens.jaxa import Catalog

cat = Catalog()
len(cat)

from earthlens.jaxa import Catalog cat = Catalog() len(cat)

Split by protocol¶

The two protocols are routed independently by the backend. by_protocol(...) lists the canonical keys for each.

In [ ]:

jaxa_earth_keys = cat.by_protocol('jaxa-earth')
gportal_keys = cat.by_protocol('gportal')
print(f'jaxa-earth: {len(jaxa_earth_keys)} collections')
print(f'gportal:    {len(gportal_keys)} products')
print()
print('First 5 jaxa-earth keys:')
for k in jaxa_earth_keys[:5]:
    print(f'  {k}')
print()
print('Every gportal key:')
for k in gportal_keys:
    print(f'  {k}')

jaxa_earth_keys = cat.by_protocol('jaxa-earth') gportal_keys = cat.by_protocol('gportal') print(f'jaxa-earth: {len(jaxa_earth_keys)} collections') print(f'gportal: {len(gportal_keys)} products') print() print('First 5 jaxa-earth keys:') for k in jaxa_earth_keys[:5]: print(f' {k}') print() print('Every gportal key:') for k in gportal_keys: print(f' {k}')

Friendly aliases¶

Every one of the 118 jaxa-earth collections has a short, friendly canonical key — the long auto-derived slug stays as an alias for round-tripping. A handful of high-traffic products also accept plain-English aliases (elevation, precipitation, lccs, ...).

In [ ]:

for alias in [
    'elevation',
    'dem',
    'precipitation',
    'lccs',
    'forest-non-forest',
    'palsar2',
    'earthcare',
    'gpm',
]:
    row = cat.get(alias)
    print(f'{alias:18s} -> {row.key:25s} ({row.protocol})')

for alias in [ 'elevation', 'dem', 'precipitation', 'lccs', 'forest-non-forest', 'palsar2', 'earthcare', 'gpm', ]: row = cat.get(alias) print(f'{alias:18s} -> {row.key:25s} ({row.protocol})')

Mission families at a glance¶

The friendly keys follow a <mission>-<product>[-<d|n>][-<cadence>][-norm] pattern. Group by the mission prefix to see how the 118 collections decompose.

In [ ]:

from collections import Counter

families = Counter(k.split('-', 1)[0] for k in cat.by_protocol('jaxa-earth'))
for family, count in families.most_common():
    print(f'  {family:10s} {count:3d} collection(s)')

from collections import Counter families = Counter(k.split('-', 1)[0] for k in cat.by_protocol('jaxa-earth')) for family, count in families.most_common(): print(f' {family:10s} {count:3d} collection(s)')

Inspect a row¶

Every row carries its protocol-specific identifier — a collection (STAC name) for jaxa-earth or a short_name (numeric id) for gportal — plus a default band where applicable.

In [ ]:

aw3d30 = cat.get('elevation')
print('canonical key:', aw3d30.key)
print('protocol:     ', aw3d30.protocol)
print('collection:   ', aw3d30.collection)
print('default band: ', aw3d30.default_band)
print()
palsar2 = cat.get('palsar2')
print('canonical key:', palsar2.key)
print('protocol:     ', palsar2.protocol)
print('short_name:   ', palsar2.short_name)
print('description:  ', palsar2.description)

aw3d30 = cat.get('elevation') print('canonical key:', aw3d30.key) print('protocol: ', aw3d30.protocol) print('collection: ', aw3d30.collection) print('default band: ', aw3d30.default_band) print() palsar2 = cat.get('palsar2') print('canonical key:', palsar2.key) print('protocol: ', palsar2.protocol) print('short_name: ', palsar2.short_name) print('description: ', palsar2.description)

Unknown keys raise with a did-you-mean hint¶

The catalog uses difflib.get_close_matches to suggest the nearest known key on a typo.

In [ ]:

try:
    cat.get('aw3d3')
except ValueError as exc:
    print(exc)

try: cat.get('aw3d3') except ValueError as exc: print(exc)

Refreshing against the live SDK universes¶

The CLI command earthlens datasets refresh jaxa walks jaxa.earth.ImageCollectionList (STAC) and gportal.datasets() (G-Portal) to diff the bundled YAML against the live IDs. Both SDKs are optional — the [jaxa] extra installs them.

earthlens datasets refresh jaxa