Command-Line Interface#

Adapt command-line interface.

Entry point: adapt

Typical use: make a directory, work inside it, and let that directory be the repository. adapt config writes config.yaml there with base_dir pointing at itself, and the other commands pick it up from the working directory — so no paths need to be passed:

mkdir my_case && cd my_case
adapt config                        # skip if you already have a config.yaml
adapt run-nexrad --radar KLOT
adapt dashboard                     # second terminal; repo is selectable in the GUI

Everything is overridable when you want it to be — a config file elsewhere, a different output root, a repository other than the working directory:

adapt run-nexrad /path/to/config.yaml --radar KDIX --base-dir /data/radar \
    --start-time 2025-03-05T15:00:00Z --end-time 2025-03-05T18:00:00Z
adapt dashboard --repo /data/radar

The config file itself is optional: with none, ParamConfig expert defaults are used. Any value from it can be overridden with CLI flags. See adapt <command> --help for the full set.

adapt.cli.main()#

Top-level CLI dispatcher.

Return type:

None