Skip to content

verify

yousleep-verify: check an analysis image the way the platform will.

yousleep-verify --image ghcr.io/example/my-analysis:1.0.0 --config my-analysis.yaml

Synthesises a recording that satisfies the configuration, writes the manifest the platform would write, runs the image twice under the platform's confinement (no network, no capabilities, read-only root, unprivileged user, the declared cores and memory), and checks the events document: well-formed, only declared labels, only channels the manifest named, probability and value only where declared, within the recording, and the same on both runs. With --expected it also compares against a document recorded earlier (--record writes it). The first run's peak memory is reported beside the memory claimed for it. Exit status 0 when every required check passes.

yousleep-verify --meter --image ghcr.io/example/my-analysis:1.0.0 --config my-analysis.yaml

measures the peak memory on recordings of 1 to 48 hours (24 with --quick) at several sample rates and channel counts, and compares it with the memory the configuration claims for each. Exit status 0 when every point has the required headroom. --propose prints memory terms fitted to the peaks.

main(argv=None)

Entry point of yousleep-verify.

package_version()

Return the installed package version, for --version.