job
¶
Background jobs for Simulator.start().
SimulationStatus
¶
SimulationJob
¶
Handle for a simulate() call running on a worker thread.
completed_steps and total_steps stay None until the backend
reports time points. QuTiP does not report them.
Attributes:
-
status(SimulationStatus) –pending,running,succeeded, orfailed. -
completed_steps(int | None) –Finished time points, or
Noneif this backend does not report them. -
total_steps(int | None) –Time points this run will report, or
None.
Source code in shadowsim/simulators/job.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | |
completed_steps
property
¶
Return how many time points have finished, or None.
total_steps
property
¶
Return how many time points this run reports, or None.
__init__
¶
__init__(simulator: Simulator) -> None
Bind a job to simulator without starting it.
Source code in shadowsim/simulators/job.py
result
¶
result(timeout: float | None = None) -> SimulationResult
Return the simulation result, waiting up to timeout seconds.
timeout=None waits until the job finishes. A finished successful
job returns its SimulationResult. A failed job raises the
exception from simulate().
Parameters:
-
timeout(float | None, default:None) –Seconds to wait.
Nonewaits until the job finishes.
Returns:
-
SimulationResult–The
SimulationResultfromsimulate().
Raises:
-
TimeoutError–The job is still pending or running when the wait ends.
-
Exception–Whatever
simulate()raised.