cli

cli

PlanetaryPy unified CLI.

Usage: plp fetch mro.ctx.edr P02_001916_2221_XI_42N027W plp hifetch PSP_003092_0985 –browse plp ctxqv J05_046771_1950 plp catalog build

Functions

Name	Description
catalog_build	Build the PDS catalog database from pdr-tests definitions.
ctxqv	Show a downsampled quickview of a CTX image.
fetch	Download a PDS product by ID.
hibrowse	Download a HiRISE browse JPEG from EXTRAS.
hifetch	Download a full HiRISE data product (EDR .IMG or RDR .JP2).
spicer	Show current SPICE data for a solar system body.

catalog_build

cli.catalog_build(
    force=typer.Option(False, '--force', help='Force rebuild from scratch'),
    validate_urls=typer.Option(False, '--validate-urls', help='Run URL validation after build'),
)

Build the PDS catalog database from pdr-tests definitions.

[source]

ctxqv

cli.ctxqv(
    imgid=typer.Argument(help='CTX product ID (short or full), e.g. J05_046771_1950'),
    stride=typer.Option(10, '--stride', '-s', help='Downsample factor'),
    save=typer.Option(None, '--save', '-o', help='Save to PNG instead of displaying'),
    stretch=typer.Option('1,99', '--stretch', '-p', help="Percentile stretch as 'low,high'. Use 'none' to disable."),
    edr=typer.Option(False, '--edr', help='Force raw EDR, skip calibrated files'),
)

Show a downsampled quickview of a CTX image.

Automatically uses the best available level: map-projected > calibrated > cube > raw EDR.

[source]

fetch

cli.fetch(
    key=typer.Argument(help='Dotted product key, e.g. mro.ctx.edr'),
    product_id=typer.Argument(help='Product identifier'),
    force=typer.Option(False, '--force', '-f', help='Re-download even if cached'),
    label_only=typer.Option(False, '--label-only', '-l', help='Download only the label file'),
    here=typer.Option(False, '--here', '-H', help='Download into current directory instead of planetarypy storage'),
)

Download a PDS product by ID.

Examples: plp fetch mro.ctx.edr P02_001916_2221_XI_42N027W plp fetch –here mro.ctx.edr P02_001916_2221_XI_42N027W

[source]

hibrowse

cli.hibrowse(
    product_id=typer.Argument(help='HiRISE product ID, e.g. PSP_003092_0985_RED or PSP_004238_1135_RED1_1'),
    annotated=typer.Option(True, '--annotated/--clean', '-a/-c', help='Annotated (default) or clean browse'),
    here=typer.Option(False, '--here', '-H', help='Download into current directory'),
    force=typer.Option(False, '--force', '-f', help='Re-download even if cached'),
)

Download a HiRISE browse JPEG from EXTRAS.

Bare observation IDs default to RDR RED browse.

Examples: plp hibrowse PSP_003092_0985_RED (annotated browse) plp hibrowse –clean PSP_003092_0985_RED (clean browse) plp hibrowse ESP_075422_2040_COLOR plp hibrowse PSP_004238_1135_RED1_1 (EDR CCD) plp hibrowse PSP_003092_0985 (defaults to RDR RED)

[source]

hifetch

cli.hifetch(
    product_id=typer.Argument(help='HiRISE product ID, e.g. PSP_003092_0985_RED or PSP_003092_0985_RED4_0'),
    here=typer.Option(False, '--here', '-H', help='Download into current directory'),
    force=typer.Option(False, '--force', '-f', help='Re-download even if cached'),
)

Download a full HiRISE data product (EDR .IMG or RDR .JP2).

Examples: plp hifetch PSP_003092_0985_RED (RDR JP2) plp hifetch PSP_003092_0985_COLOR (RDR JP2) plp hifetch PSP_003092_0985_RED4_0 (EDR IMG)

[source]

spicer

cli.spicer(
    body=typer.Argument(help='NAIF body name, e.g. Mars, Moon, Enceladus'),
    time=typer.Option(None, '--time', '-t', help='UTC time (default: now)'),
    lon=typer.Option(None, '--lon', help='Longitude [deg] for surface illumination'),
    lat=typer.Option(None, '--lat', help='Latitude [deg] for surface illumination'),
)

Show current SPICE data for a solar system body.

Without –lon/–lat, shows global properties (L_s, subsolar point, solar constant). With coordinates, adds surface illumination.

Examples: plp spicer Mars plp spicer Moon –time 2024-06-15T12:00:00 plp spicer Mars –lon 137.4 –lat -4.6

[source]