CLI#

GeoPrior provides a family-based command-line interface built around one main dispatcher and a set of family-specific entry points.

This section is the best place to start when you want to understand how the CLI is organized, which command family fits your task, and where to look next for shared conventions or detailed command pages.

The Command-line interface (CLI) is organized into three public families:

  • Run commands execute staged workflows and research drivers.

  • Build commands materialize reusable artifacts such as tables, summaries, payloads, and derived datasets.

  • Plot commands render figures, maps, and publication-oriented diagnostics.

CLI families at a glance#

Run family

Use the run family when you want to execute workflows.

This includes staged preprocessing, training, tuning, inference, transfer evaluation, and supplementary run-side drivers such as sensitivity and SM3 workflows.

Run family
Build family

Use the build family when you want to materialize artifacts that can be reused later.

These commands create compact datasets, tables, payloads, validation products, summary records, and derived geospatial outputs.

Build family
Plot family

Use the plot family when you want to render visual outputs.

This includes forecasting figures, uncertainty panels, physics maps, transfer plots, hotspot analytics, and SM3 diagnostics.

Plot family

Start here#

Introduction

Start with the CLI mental model: the root dispatcher, family-specific entry points, aliases, and the overall public command surface.

Introduction
Shared conventions

Learn the repeated CLI patterns once: config installation, runtime overrides, shared output handling, and common data-loading behavior.

Shared conventions

How this section fits with the rest of the docs#

A simple way to use the documentation is:

  • start in the CLI section when you already know you want to run a command,

  • move to the User Guide when you want workflow context and stage-by-stage reasoning,

  • move to Examples when you want complete lessons with outputs, figures, and interpretation,

  • move to the API reference when you want importable Python interfaces.

The CLI pages therefore answer a practical question:

Which command family should I use, and where do I find the details for that task?

From here#

A good reading path is:

  1. Introduction

  2. Shared conventions

  3. one of Run family, Build family, or Plot family depending on your task