Command-Line Interface

QUBE installs console scripts with the package, so they are on PATH after pip install qube-qml — no repository checkout required.

Command

Does

qube-fisher-run

Builds the Fisher matrix and stops.

qube-spectra-run

Estimates QML power spectra end to end.

qube-run

Alias for qube-spectra-run.

qube-memory-budget

Predicts peak memory for a configuration without running it.

Both pipeline commands take an optional configuration path and fall back to the packaged TEB_defaults.yaml:

qube-run                                  # packaged default config
qube-run config.yaml                      # explicit config
qube-spectra-run config.yaml --mode convolved --out spectra.txt
qube-fisher-run config.yaml

Because a console script is an ordinary executable, MPI works without a python prefix:

mpirun -n 8 qube-spectra-run config.yaml
mpirun -n 16 qube-fisher-run config.yaml

Why two commands

Spectra builds its own Fisher internally, so qube-run is the whole pipeline in one step. qube-fisher-run exists for the cases where you want F on its own:

  • the two-job cluster workflow, where one job computes the Fisher matrix and a later job reuses it through the out* files (see ../../adr on the Fisher → Spectra handoff);

  • reusing a single Fisher across many map sets, since F does not depend on the data.

Persistence is opt-in

Nothing is written unless you ask for it. qube-fisher-run persists the matrix only when outfilefisher is set in the configuration, and qube-spectra-run writes the spectra only when --out is given. Both commands warn on completion when the result they just computed is about to be discarded.

Command-line entry points for the QUBE pipeline.

qube-fisher-run builds the Fisher matrix and stops; qube-spectra-run (alias qube-run) estimates QML power spectra end to end, building its own Fisher. Both run unmodified under MPI.

Persistence is opt-in (ADR-0015): a run whose output path is unset computes the result and discards it, so both entry points warn rather than exit quietly.

qube.cli.DEFAULT_CONFIG = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/cosmoforge/checkouts/stable/src/cosmoforge.qube/qube/TEB_defaults.yaml')

Packaged config used when no path is given on the command line. Resolved relative to this file so the entry points work from any working directory.

qube.cli.fisher_main()[source]

Entry point for qube-fisher-run.

Return type:

None

qube.cli.spectra_main()[source]

Entry point for qube-spectra-run and its qube-run alias.

Return type:

None