Translator for process node
aiida.restapi.translator.nodes.process.process.
ProcessTranslator
Bases: aiida.restapi.translator.nodes.node.NodeTranslator
aiida.restapi.translator.nodes.node.NodeTranslator
Translator relative to resource ‘data’ and aiida class ~aiida.orm.nodes.data.data.Data
ProcessNode
Bases: aiida.orm.utils.mixins.Sealable, aiida.orm.nodes.node.Node
aiida.orm.utils.mixins.Sealable
aiida.orm.nodes.node.Node
Base class for all nodes representing the execution of a process
This class and its subclasses serve as proxies in the database, for actual Process instances being run. The Process instance in memory will leverage an instance of this class (the exact sub class depends on the sub class of Process) to persist important information of its state to the database. This serves as a way for the user to inspect the state of the Process during its execution as well as a permanent record of its execution in the provenance graph, after the execution has terminated.
CHECKPOINT_KEY
EXCEPTION_KEY
EXIT_MESSAGE_KEY
EXIT_STATUS_KEY
PROCESS_LABEL_KEY
PROCESS_PAUSED_KEY
PROCESS_STATE_KEY
PROCESS_STATUS_KEY
__abstractmethods__
__module__
__str__
Return str(self).
_abc_impl
_get_objects_to_hash
Return a list of objects which should be included in the hash.
_hash_ignored_inputs
_logger
_plugin_type_string
_query_type_string
_unstorable_message
_updatable_attributes
called
Return a list of nodes that the process called
list of process nodes called by this process
called_descendants
Return a list of all nodes that have been called downstream of this process
This will recursively find all the called processes for this process and its children.
caller
Return the process node that called this process node, or None if it does not have a caller
process node that called this process node instance or None
checkpoint
Return the checkpoint bundle set for the process
checkpoint bundle if it exists, None otherwise
delete_checkpoint
Delete the checkpoint bundle set for the process
exception
Return the exception of the process or None if the process is not excepted.
If the process is marked as excepted yet there is no exception attribute, an empty string will be returned.
the exception message or None
exit_message
Return the exit message of the process
the exit message
exit_status
Return the exit status of the process
the exit status, an integer exit code or None
get_builder_restart
Return a ProcessBuilder that is ready to relaunch the process that created this node.
The process class will be set based on the process_type of this node and the inputs of the builder will be prepopulated with the inputs registered for this node. This functionality is very useful if a process has completed and you want to relaunch it with slightly different inputs.
~aiida.engine.processes.builder.ProcessBuilder instance
is_excepted
Return whether the process has excepted
Excepted means that during execution of the process, an exception was raised that was not caught.
True if during execution of the process an exception occurred, False otherwise
bool
is_failed
Return whether the process has failed
Failed means that the process terminated nominally but it had a non-zero exit status.
True if the process has failed, False otherwise
is_finished
Return whether the process has finished
Finished means that the process reached a terminal state nominally. Note that this does not necessarily mean successfully, but there were no exceptions and it was not killed.
True if the process has finished, False otherwise
is_finished_ok
Return whether the process has finished successfully
Finished successfully means that it terminated nominally and had a zero exit status.
True if the process has finished successfully, False otherwise
is_killed
Return whether the process was killed
Killed means the process was killed directly by the user or by the calling process being killed.
True if the process was killed, False otherwise
is_terminated
Return whether the process has terminated
Terminated means that the process has reached any terminal state.
True if the process has terminated, False otherwise
is_valid_cache
Return whether the node is valid for caching
True if this process node is valid to be used for caching, False otherwise
logger
Get the logger of the Calculation object, so that it also logs to the DB.
LoggerAdapter object, that works like a logger, but also has the ‘extra’ embedded
pause
Mark the process as paused by setting the corresponding attribute.
This serves only to reflect that the corresponding Process is paused and so this method should not be called by anyone but the Process instance itself.
paused
Return whether the process is paused
True if the Calculation is marked as paused, False otherwise
process_class
Return the process class that was used to create this node.
Process class
ValueError – if no process type is defined, it is an invalid process type string or cannot be resolved to load the corresponding class
process_label
Return the process label
the process label
process_state
Return the process state
the process state instance of ProcessState enum
process_status
Return the process status
The process status is a generic status message e.g. the reason it might be paused or when it is being killed
the process status
set_checkpoint
Set the checkpoint bundle set for the process
state – string representation of the stepper state info
set_exception
Set the exception of the process
exception – the exception message
set_exit_message
Set the exit message of the process, if None nothing will be done
message – a string message
set_exit_status
Set the exit status of the process
state – an integer exit code or None, which will be interpreted as zero
set_process_label
Set the process label
label – process label string
set_process_state
Set the process state
state – value or instance of ProcessState enum
set_process_status
Set the process status
The process status is a generic status message e.g. the reason it might be paused or when it is being killed. If status is None, the corresponding attribute will be deleted.
status – string process status
set_process_type
Set the process type string.
process_type – the process type string identifying the class using this process node as storage.
unpause
Mark the process as unpaused by removing the corresponding attribute.
This serves only to reflect that the corresponding Process is unpaused and so this method should not be called by anyone but the Process instance itself.
validate_incoming
Validate adding a link of the given type from a given node to ourself.
Adding an input link to a ProcessNode once it is stored is illegal because this should be taken care of by the engine in one go. If a link is being added after the node is stored, it is most likely not by the engine and it should not be allowed.
source – the node from which the link is coming
link_type – the link type
link_label – the link label
TypeError – if source is not a Node instance or link_type is not a LinkType enum
ValueError – if the proposed link is invalid
__label__
_aiida_class
alias of aiida.orm.nodes.process.process.ProcessNode
aiida.orm.nodes.process.process.ProcessNode
_aiida_type
_result_type
get_projectable_properties
Get projectable properties specific for Process nodes :return: dict of projectable properties and column_order list
get_report
Show the log report for one or multiple processes.