COMPS.Data.CommissionableEntity module#

class COMPS.Data.CommissionableEntity.CommissionableEntity[source]#

Bases: object

commission()[source]#

Commission an entity.

If called on a Suite/Experiment, this attempts to commission all contained Simulations currently in SimulationState.Created. If called on a Simulation, this attempts to commission that Simulation. Only applicable if it is currently in SimulationState.Created. If called on a WorkItem, this attempts to commission that WorkItem. Only applicable if it is currently in WorkItemState.Created.

cancel()[source]#

Cancel a running entity.

If called on a Suite/Experiment, this attempts to cancel all contained Simulations currently in an ‘active’ state:

  • SimulationState.CommissionRequested

  • SimulationState.Provisioning

  • SimulationState.Commissioned

  • SimulationState.Running

  • SimulationState.Retry

If called on a Simulation, this attempts to commission that Simulation. Only applicable if it is currently in an ‘active’ state; see above. If called on a WorkItem, this attempts to commission that WorkItem. Only applicable if it is currently in an ‘active’ state:

  • WorkItemState.CommissionRequested

  • WorkItemState.Commissioned

  • WorkItemState.Validating

  • WorkItemState.Running

  • WorkItemState.Waiting

  • WorkItemState.ResumeRequested

  • WorkItemState.Resumed

delete(expire_now=False)[source]#

“Soft-delete” this entity.

This entity record and all associated files, etc, will be marked for deletion in COMPS. They will remain for some period of time before being permanently deleted, but will no longer be returned by the COMPS service or visible in the UI.

If called on a Suite/Experiment, this delete also applies to all contained Experiments/Simulations.

Parameters:

expire_now – If this is set to True, this entity will be eligible for permanent deletion immediately (though depending on deletion activity in the system, it may still be a while before it’s fully deleted).