This API reference is not for the latest stable Salvus version.

`salvus.flow.executors.functions`

Utility site functions that don’t quite fit elsewhere.

Functions

`initialize_or_update_site()`

def initialize_or_update_site(
    site: salvus.flow.executors.base_executor.BaseExecutor,
    verbosity: int = 1,
    wait_for_initial_run_in_seconds: float = 3.0,
) -> None: ...

Initialize (or update) the site by testing if everything works as expected.

Parameters

site salvus.flow.executors.base_executor.BaseExecutor — The site to use.
verbosity int — Verbosity level.
wait_for_initial_run_in_seconds float — How long to wait for the job to finish before querying for the first time. 3 seconds is a good number for most cases, for testing this can be shortened.

Returns None

Exceptions

`SalvusSiteInitError`

Descriptive error class for site initialization errors.

Args: message: Error message. suggestion_to_fix: A suggestion on how to fix the error.