numerous.image_tools.job module

class numerous.image_tools.job.ExitCode(value)

Bases: Enum

An enumeration.

COMPLETED = 10

ERROR = -100

HIBERNATING = 30

SOURCE_CLOSED = -20

SOURCE_COMPLETED = 11

SOURCE_EMPTY = -110

SOURCE_HIBERNATING = 31

SYSTEM_NOT_INITIALIZED = -120

TERMINATED = 20

TIMEOUT = -30

exception numerous.image_tools.job.HibernateJob

Bases: Exception

class numerous.image_tools.job.NumerousBaseJob

Bases: object

post_run(exit_code)

read_data(t)

run_job()

Return type:

ExitCode

serialize_states(t)

A method called when saving states. Returns: states, which must be JSON serializable, to be saved.

Return type:

Optional[Any]

class numerous.image_tools.job.NumerousSimulationJob

Bases: NumerousBaseJob

initialize_simulation_system()

A method that is called once model is initialized (after the first data is read). Can return the initial output to be saved.

Return type:

Optional[dict]

read_input(t)

run_job()

Return type:

ExitCode

step(t, dt)

A method that is called after each data read. Could be a step solver, or some other data manipulating function. Returns: tuple of next timestamp and outputs as a dict with tags to be saved

Return type:

tuple[float, dict]

write_output(t, output)

exception numerous.image_tools.job.TerminateJob

Bases: Exception