aiida.restapi.translator.nodes.process.workflow package

Submodules

Translator for workchain node

class aiida.restapi.translator.nodes.process.workflow.workchain.WorkChainTranslator(**kwargs)

Bases: ProcessTranslator

Translator relative to resource ‘workchain’ and aiida class Process

class WorkChainNode(backend: 'StorageBackend' | None = None, user: User | None = None, computer: Computer | None = None, **kwargs: Any)

Bases: WorkflowNode

ORM class for all nodes representing the execution of a WorkChain.

STEPPER_STATE_INFO_KEY = 'stepper_state_info'

__abstractmethods__ = frozenset({})

__annotations__ = {'METADATA_INPUTS_KEY': <class 'str'>, '_CLS_COLLECTION': 'Type[CollectionType]', '__plugin_type_string': 'ClassVar[str]', '__qb_fields__': 'Sequence[QbField]', '__query_type_string': 'ClassVar[str]', '_hash_ignored_attributes': 'Tuple[str, ...]', '_logger': 'Optional[Logger]', '_updatable_attributes': 'Tuple[str, ...]', 'fields': 'QbFields'}

__module__ = 'aiida.orm.nodes.process.workflow.workchain'

__parameters__ = ()

__plugin_type_string: ClassVar[str]

__query_type_string: ClassVar[str]

_abc_impl = <_abc._abc_data object>

_logger: Logger | None = <Logger aiida.orm.nodes.process.workflow.workchain.WorkChainNode (WARNING)>

_updatable_attributes: Tuple[str, ...] = ('sealed', 'paused', 'checkpoints', 'exception', 'exit_message', 'exit_status', 'process_label', 'process_state', 'process_status', 'stepper_state_info')

fields: QbFields = {'attributes': 'QbDictField(attributes.*) -> Dict[str, Any]',  'computer_pk': 'QbNumericField(attributes.computer_pk) -> Optional[int]',  'ctime': 'QbNumericField(ctime) -> datetime',  'description': 'QbStrField(description) -> str',  'exception': 'QbStrField(attributes.exception) -> Optional[str]',  'exit_message': 'QbStrField(attributes.exit_message) -> Optional[str]',  'exit_status': 'QbNumericField(attributes.exit_status) -> Optional[int]',  'extras': 'QbDictField(extras.*) -> Dict[str, Any]',  'label': 'QbStrField(label) -> str',  'mtime': 'QbNumericField(mtime) -> datetime',  'node_type': 'QbStrField(node_type) -> str',  'paused': 'QbField(attributes.paused) -> bool',  'pk': 'QbNumericField(pk) -> int',  'process_label': 'QbStrField(attributes.process_label) -> Optional[str]',  'process_state': 'QbStrField(attributes.process_state) -> Optional[str]',  'process_status': 'QbStrField(attributes.process_status) -> Optional[str]',  'process_type': 'QbStrField(attributes.process_type) -> Optional[str]',  'repository_metadata': 'QbDictField(repository_metadata) -> Dict[str, Any]',  'sealed': 'QbField(attributes.sealed) -> bool',  'user_pk': 'QbNumericField(user_pk) -> int',  'uuid': 'QbStrField(uuid) -> str'}

set_stepper_state_info(stepper_state_info: str) → None

Set the stepper state info

Parameters:

state – string representation of the stepper state info

property stepper_state_info: str | None

Return the stepper state info

Returns:

string representation of the stepper state info

__annotations__ = {}

__label__ = 'workchain'

__module__ = 'aiida.restapi.translator.nodes.process.workflow.workchain'

_aiida_class

alias of WorkChainNode

_aiida_type = 'process.workflow.workchain.WorkChainNode'

_result_type = 'workchain'

static get_derived_properties(node)

Generic function extended for workchain. Currently it is not implemented.

Parameters:

node – node object

Returns:

empty dict

Translator for workfunction node

class aiida.restapi.translator.nodes.process.workflow.workfunction.WorkFunctionTranslator(**kwargs)

Bases: ProcessTranslator

Translator relative to resource ‘calcfunction’ and aiida class Calculation

class WorkFunctionNode(backend: 'StorageBackend' | None = None, user: User | None = None, computer: Computer | None = None, **kwargs: Any)

Bases: FunctionCalculationMixin, WorkflowNode

ORM class for all nodes representing the execution of a workfunction.

_CLS_NODE_LINKS

alias of WorkFunctionNodeLinks

__abstractmethods__ = frozenset({})

__annotations__ = {'METADATA_INPUTS_KEY': 'str', '_CLS_COLLECTION': 'Type[CollectionType]', '__plugin_type_string': 'ClassVar[str]', '__qb_fields__': 'Sequence[QbField]', '__query_type_string': 'ClassVar[str]', '_hash_ignored_attributes': 'Tuple[str, ...]', '_logger': 'Optional[Logger]', '_updatable_attributes': 'Tuple[str, ...]', 'fields': 'QbFields'}

__module__ = 'aiida.orm.nodes.process.workflow.workfunction'

__parameters__ = ()

__plugin_type_string: ClassVar[str]

__query_type_string: ClassVar[str]

_abc_impl = <_abc._abc_data object>

_logger: Logger | None = <Logger aiida.orm.nodes.process.workflow.workfunction.WorkFunctionNode (WARNING)>

fields: QbFields = {'attributes': 'QbDictField(attributes.*) -> Dict[str, Any]',  'computer_pk': 'QbNumericField(attributes.computer_pk) -> Optional[int]',  'ctime': 'QbNumericField(ctime) -> datetime',  'description': 'QbStrField(description) -> str',  'exception': 'QbStrField(attributes.exception) -> Optional[str]',  'exit_message': 'QbStrField(attributes.exit_message) -> Optional[str]',  'exit_status': 'QbNumericField(attributes.exit_status) -> Optional[int]',  'extras': 'QbDictField(extras.*) -> Dict[str, Any]',  'label': 'QbStrField(label) -> str',  'mtime': 'QbNumericField(mtime) -> datetime',  'node_type': 'QbStrField(node_type) -> str',  'paused': 'QbField(attributes.paused) -> bool',  'pk': 'QbNumericField(pk) -> int',  'process_label': 'QbStrField(attributes.process_label) -> Optional[str]',  'process_state': 'QbStrField(attributes.process_state) -> Optional[str]',  'process_status': 'QbStrField(attributes.process_status) -> Optional[str]',  'process_type': 'QbStrField(attributes.process_type) -> Optional[str]',  'repository_metadata': 'QbDictField(repository_metadata) -> Dict[str, Any]',  'sealed': 'QbField(attributes.sealed) -> bool',  'user_pk': 'QbNumericField(user_pk) -> int',  'uuid': 'QbStrField(uuid) -> str'}

__annotations__ = {}

__label__ = 'workfunction'

__module__ = 'aiida.restapi.translator.nodes.process.workflow.workfunction'

_aiida_class

alias of WorkFunctionNode

_aiida_type = 'process.workflow.workfunction.WorkFunctionNode'

_result_type = 'workfunction'

static get_derived_properties(node)

Generic function extended for workfunction. Currently it is not implemented.

Parameters:

node – node object

Returns:

empty dict