stanza.cli

Stanza CLI - Command-line interface for Stanza experiment framework.

Module Contents

Functions

API

1
stanza.cli.cli() -> None

Stanza - Build tune up sequences for quantum computers fast.

Easy to code. Easy to run.

1
stanza.cli.init(
2
    path: pathlib.Path | None, name: str | None
3
) -> None

Initialize a new timestamped experiment session directory.

Creates a directory like: 20251020100010_data/

All experiment data from routines will be logged inside this directory.

Examples:

stanza init

stanza init —name my_experiment

stanza init —path /data/experiments

1
stanza.cli.status() -> None

Show current active session information.

1
stanza.cli._get_config_file() -> pathlib.Path

Get path to live plot config file.

1
stanza.cli._read_config() -> dict[str, typing.Any]

Read live plot config, return empty dict if not found.

1
stanza.cli._write_config(config: dict[str, typing.Any]) -> None

Write live plot config.

1
stanza.cli.live_plot() -> None

Manage live plotting.

1
stanza.cli.enable_live_plot(
2
    backend: str, port: int
3
) -> None

Enable live plotting configuration.

1
stanza.cli.disable_live_plot() -> None

Disable live plotting configuration.

1
stanza.cli.live_plot_status() -> None

Show live plotting configuration.

1
stanza.cli.main() -> None

Entry point for CLI.