Skip to content

enums

utils.enums

EntityState

Bases: Enum

Job and task state types

Source code in yaptide/utils/enums.py 
17
18
19
20
21
22
23
24
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
class EntityState(Enum):
    """Job and task state types"""

    UNKNOWN = "UNKNOWN"
    """
    This state is used only for jobs which are not yet submitted but was created in the database.
    Jobs in this state cannot be canceled.
    """
    PENDING = "PENDING"
    """
    Jobs and tasks in this state are waiting for execution.
    """
    RUNNING = "RUNNING"
    """
    Jobs and tasks in this state are currently running.
    """
    MERGING_QUEUED = "MERGING_QUEUED"
    """
    All the tasks completed they work.
    The process to merge their output is queued and waiting for execution.
    """
    MERGING_RUNNING = "MERGING_RUNNING"
    """
    Merging process started its execution and is aggregating the simulation results.
    """
    CANCELED = "CANCELED"
    """
    Jobs and tasks in this state are canceled.
    Jobs and tasks in this state cannot be canceled.
    """
    COMPLETED = "COMPLETED"
    """
    Jobs and tasks in this state are completed.
    Jobs and tasks in this state cannot be canceled.
    """
    FAILED = "FAILED"
    """
    Jobs and tasks in this state are failed.
    Jobs and tasks in this state cannot be canceled.
    """

CANCELED class-attribute instance-attribute 

CANCELED = 'CANCELED'

Jobs and tasks in this state are canceled. Jobs and tasks in this state cannot be canceled.

COMPLETED class-attribute instance-attribute 

COMPLETED = 'COMPLETED'

Jobs and tasks in this state are completed. Jobs and tasks in this state cannot be canceled.

FAILED class-attribute instance-attribute 

FAILED = 'FAILED'

Jobs and tasks in this state are failed. Jobs and tasks in this state cannot be canceled.

MERGING_QUEUED class-attribute instance-attribute 

MERGING_QUEUED = 'MERGING_QUEUED'

All the tasks completed they work. The process to merge their output is queued and waiting for execution.

MERGING_RUNNING class-attribute instance-attribute 

MERGING_RUNNING = 'MERGING_RUNNING'

Merging process started its execution and is aggregating the simulation results.

PENDING class-attribute instance-attribute 

PENDING = 'PENDING'

Jobs and tasks in this state are waiting for execution.

RUNNING class-attribute instance-attribute 

RUNNING = 'RUNNING'

Jobs and tasks in this state are currently running.

UNKNOWN class-attribute instance-attribute 

UNKNOWN = 'UNKNOWN'

This state is used only for jobs which are not yet submitted but was created in the database. Jobs in this state cannot be canceled.

InputType

Bases: Enum

Input type specification

Source code in yaptide/utils/enums.py 
59
60
61
62
63
64
65
66
67
68
69
class InputType(Enum):
    """Input type specification"""

    EDITOR = "EDITOR"
    """
    Simulation was submitted with the usage of UI editor json.
    """
    FILES = "FILES"
    """
    Simulation was submitted with the usage of input files in the format expected by the simulator.
    """

EDITOR class-attribute instance-attribute 

EDITOR = 'EDITOR'

Simulation was submitted with the usage of UI editor json.

FILES class-attribute instance-attribute 

FILES = 'FILES'

Simulation was submitted with the usage of input files in the format expected by the simulator.

PlatformType

Bases: Enum

Platform specification

Source code in yaptide/utils/enums.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
class PlatformType(Enum):
    """Platform specification"""

    DIRECT = "DIRECT"
    """
    Simulation run with Celery directly on the server.
    """
    BATCH = "BATCH"
    """
    Simulation run on the cluster with Slurm.
    """

BATCH class-attribute instance-attribute 

BATCH = 'BATCH'

Simulation run on the cluster with Slurm.

DIRECT class-attribute instance-attribute 

DIRECT = 'DIRECT'

Simulation run with Celery directly on the server.

SimulationType

Bases: Enum

Simulation type specification

Source code in yaptide/utils/enums.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class SimulationType(Enum):
    """Simulation type specification"""

    SHIELDHIT = "shieldhit"
    """
    Simulation run with SHIELD-HIT12A.
    """
    TOPAS = "topas"
    """
    Simulation run with TOPAS.
    """
    FLUKA = "fluka"
    """
    Simulation run with FLUKA.
    """
    DUMMY = "dummy"
    """
    Simulation run with dummy simulator.
    """

DUMMY class-attribute instance-attribute 

DUMMY = 'dummy'

Simulation run with dummy simulator.

FLUKA class-attribute instance-attribute 

FLUKA = 'fluka'

Simulation run with FLUKA.

SHIELDHIT class-attribute instance-attribute 

SHIELDHIT = 'shieldhit'

Simulation run with SHIELD-HIT12A.

TOPAS class-attribute instance-attribute 

TOPAS = 'topas'

Simulation run with TOPAS.