aiida_mcp.plugins.calcjob module¶
Generic describe and submit helpers shared by calcjob plugins.
- aiida_mcp.plugins.calcjob.calcjob_available(entry_point: str) bool¶
Return whether a calcjob entry point is installed.
- Parameters:
entry_point (str) – The calcjob entry point name, e.g.
dlpoly.- Returns:
True if the entry point is installed.
- Return type:
bool
- aiida_mcp.plugins.calcjob.describe_calcjob(entry_point: str) dict[str, Any]¶
Describe the plugin-specific inputs, outputs and exit codes of a calcjob.
Ports and exit codes inherited unchanged from the base
CalcJobare left out, exceptcode, which every calcjob needs.- Parameters:
entry_point (str) – The calcjob entry point name, e.g.
dlpoly.- Returns:
The calcjob’s entry point, class, description, plugin-specific inputs/outputs/exit codes, and changed metadata option defaults.
- Return type:
dict[str, Any]
- Raises:
ToolError – If entry_point is not installed.
- aiida_mcp.plugins.calcjob.load_code(identifier: str | int) AbstractCode¶
Load a code by label or PK, raising a ToolError if that fails.
- Parameters:
identifier (str or int) – The code’s full label (e.g.
dl_poly@localhost) or PK.- Returns:
The loaded code.
- Return type:
orm.AbstractCode
- Raises:
ToolError – If no code matches identifier, or more than one does.
- aiida_mcp.plugins.calcjob.submit_calcjob(entry_point: str, inputs: dict[str, Any]) ProcessNode¶
Validate inputs against the calcjob spec, store the data nodes and submit.
Nothing is stored if validation fails.
- Parameters:
entry_point (str) – The calcjob entry point name, e.g.
dlpoly.inputs (dict[str, Any]) – The calcjob’s inputs, including
metadata. Unstored orm.Data values are stored before submission.
- Returns:
The submitted process node.
- Return type:
orm.ProcessNode
- Raises:
ToolError – If entry_point is not installed, or inputs fails validation.