Translator for process node
Translator relative to resource ‘data’ and aiida class ~aiida.orm.nodes.data.data.Data
Bases: 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.
Return a list of objects which should be included in the hash.
Return a list of nodes that the process called
list of process nodes called by this process
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.
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
Return the checkpoint bundle set for the process
checkpoint bundle if it exists, None otherwise
Delete the checkpoint bundle set for the process
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
Return the exit message of the process
the exit message
Return the exit status of the process
the exit status, an integer exit code or None
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.
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
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
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
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
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
Return whether the process has terminated
Terminated means that the process has reached any terminal state.
True if the process has terminated, False otherwise
Return whether the node is valid for caching
True if this process node is valid to be used for caching, False otherwise
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
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.
Return whether the process is paused
True if the Calculation is marked as paused, False otherwise
Return the process class that was used to create this node.
ValueError – if no process type is defined, it is an invalid process type string or cannot be resolved
to load the corresponding class
Return the process label
the process label
Return the process state
the process state instance of ProcessState enum
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 the checkpoint bundle set for the process
state – string representation of the stepper state info
Set the exception of the process
exception – the exception message
Set the exit message of the process, if None nothing will be done
message – a string message
Set the exit status of the process
state – an integer exit code or None, which will be interpreted as zero
Set the process label
label – process label string
Set the process state
state – value or instance of ProcessState enum
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 the process type string.
process_type – the process type string identifying the class using this process node as storage.
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 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
alias of aiida.orm.nodes.process.process.ProcessNode
Get projectable properties specific for Process nodes
:return: dict of projectable properties and column_order list
Show the log report for one or multiple processes.