API: vaft.cli
Generated from each module's __all__ by python -m vaft._api_catalog:
25 published objects in 20 modules.
Signatures and summaries are read from the source; nothing here is written by hand.
All API pages
vaft.cli.compare_ods | |
|---|---|
main | function |
vaft.cli.corrective_worker | |
main | function |
vaft.cli.export | |
main | function |
vaft.cli.filedb | |
main | function |
vaft.cli.gui | |
main | function |
vaft.cli.help | |
main | function |
vaft.cli.hsds | |
configure | function |
main | function |
vaft.cli.maintenance | |
main | function |
vaft.cli.mcp | |
main | function |
vaft.cli.pipeline_worker | |
main | function |
vaft.cli.plot | |
main | function |
vaft.cli.raw_legacy_import | |
convert_shot | function |
import_shot | function |
legacy_field_entry | function |
load_pulse_datetimes | function |
main | function |
read_legacy_csv | function |
vaft.cli.raw_redump | |
main | function |
vaft.cli.raw_upgrade | |
main | function |
vaft.cli.setup | |
main | function |
vaft.cli.shotlog | |
main | function |
vaft.cli.summary | |
main | function |
vaft.cli.sxr_pack | |
main | function |
vaft.cli.vest_upstream | |
main | function |
No object matches.
vaft.cli.compare_ods
Compare local ODS products using the versioned VAFT parity policy.
vaft.cli.corrective_worker
Watch the Thomson/CES uploads and run the corrective pipeline on them (issue #1842).
vaft.cli.export
vaft export: write one database shot as portable local files.
vaft.cli.filedb
Command-line interface for canonical and legacy FileDB operations.
vaft.cli.gui
Launch the VAFT browser GUI.
vaft.cli.help
vaft help [topic] [item]: what VAFT can do, its defaults, and setup status.
vaft.cli.hsds
Configure HSDS (h5pyd) credentials without echoing secrets.
configure
function
source
configure(arguments: argparse.Namespace, *, ask: Callable[[str], str] | None = None, ask_secret: Callable[[str], str] | None = None, stdin: Iterable[str] | None = None, out=None) -> intmain
function
source
main(argv: Iterable[str] | None = None) -> intvaft.cli.maintenance
Maintenance of already-published HSDS shots.
vaft.cli.mcp
vaft mcp: serve VAFT’s read-only discovery tools to an MCP client over stdio (#1423).
vaft.cli.pipeline_worker
Poll VEST SQL for new shots and run the routine pipeline on them (issue #58).
vaft.cli.plot
vaft plot: render a canonical plot, or several composed, from shots, samples or files.
vaft.cli.raw_legacy_import
Import pre-SQL VEST shots (per-field CSV folders) into a FileDB raw tree.
convert_shot
function
source
convert_shot(shot: int, shot_dir: Path, *, pulse_datetime: str | None, timebase_policy: str) -> tuple[dict, dict] | NoneReturn (payload, legacy_info) for one legacy shot, or None if empty.
import_shot
function
source
import_shot(shot: int, legacy_root: str, filedb_root: str, pulse_datetime: str | None, timebase_policy: str, force: bool) -> tuple[int, str]Convert and atomically write one shot; returns (shot, status).
legacy_field_entry
function
source
legacy_field_entry(time: np.ndarray, data: np.ndarray, *, time_offset: float = 0.0) -> dictBuild one canonical archive field entry from a legacy time/value pair.
load_pulse_datetimes
function
source
load_pulse_datetimes(legacy_root: Path) -> dict[int, str]Map shot number to ISO pulse time from the legacy shot lists.
main
function
source
main(argv: Iterable[str] | None = None) -> intread_legacy_csv
function
source
read_legacy_csv(path: Path) -> tuple[np.ndarray, np.ndarray]Return (time, value) from one headerless two-column legacy CSV.
vaft.cli.raw_redump
Serial, restartable VEST raw-DAQ exports for an on-disk FileDB.
vaft.cli.raw_upgrade
In-place timebase upgrade for legacy FileDB raw archives.
vaft.cli.setup
vaft setup [profile]: report or prepare the runtime environment.
vaft.cli.shotlog
Archive the VEST ShotLog in FileDB and extract per-shot records (#995).
vaft.cli.summary
Preset summary materialization command.
vaft.cli.sxr_pack
Pack a soft X-ray archive’s digitizer CSVs into lossless HDF5 containers.
vaft.cli.vest_upstream
Run the raw, static, diagnostics, and eddy VEST OMAS stages.