spacr.host_pathogen_example

Deterministic synthetic Host–Pathogen project with independently known truth.

Functions

build_example(destination, *[, progress, cancelled])	Create a ready-to-run synthetic project, preserving existing user files.
example_folder()	Return the private cache directory for the synthetic example.
is_present(folder)	Recognize a complete generated project without replacing user modifications.
main([argv])	Build the sample from the command line without requiring Qt or network.

Module Contents

spacr.host_pathogen_example.build_example(destination, *, progress=None, cancelled=None)

Create a ready-to-run synthetic project, preserving existing user files.

Parameters:

• destination – new/empty project directory or this complete cached sample.

• progress – optional callable receiving completed and total field counts.

• cancelled – optional callable; True aborts before the next field/commit.

Returns:

absolute project Path. A complete cached copy is reused unchanged.

Raises:

• FileExistsError – a nonempty destination is not a complete sample.

• RuntimeError – generation was cancelled; no partial project is published.

spacr.host_pathogen_example.example_folder()

Return the private cache directory for the synthetic example.

spacr.host_pathogen_example.is_present(folder)

Recognize a complete generated project without replacing user modifications.

Parameters:

folder – candidate synthetic project directory.

Returns:

True when its manifest version, synthetic marker, listed files and nonempty measurement database are present. File contents are not compared with the original recipe, so user edits remain intact.

spacr.host_pathogen_example.main(argv=None)

Build the sample from the command line without requiring Qt or network.

Parameters:

argv – optional argument list; None reads the process arguments.

Returns:

zero after printing the generated or reused project directory.