ManyBodyProtocols

pydantic model qcmanybody.models.ManyBodyProtocols[source]

Protocols regarding the manipulation of a ManyBody output data.

Show JSON schema

{
   "title": "ManyBodyProtocols",
   "description": "Protocols regarding the manipulation of a ManyBody output data.",
   "type": "object",
   "properties": {
      "component_results": {
         "description": "Which component results to preserve in a many body result; usually AtomicResults.",
         "default": "none",
         "allOf": [
            {
               "$ref": "#/definitions/ComponentResultsProtocolEnum"
            }
         ]
      }
   },
   "additionalProperties": false,
   "definitions": {
      "ComponentResultsProtocolEnum": {
         "title": "ComponentResultsProtocolEnum",
         "description": "Which component results to preserve in a many body result; usually AtomicResults.",
         "enum": [
            "all",
            "none"
         ],
         "type": "string"
      }
   }
}

Fields:

component_results (qcmanybody.models.v1.manybody_input_pydv1.ComponentResultsProtocolEnum)

field component_results: ComponentResultsProtocolEnum = ComponentResultsProtocolEnum.none: Which component results to preserve in a many body result; usually AtomicResults.

convert_v(target_version, /)[source]

Convert to instance of particular QCSchema version.

Parameters:: target_version (int)
Return type:: Union[‘qcmanybody.models.v1.ManyBodyProtocols’, ‘qcmanybody.models.v2.ManyBodyProtocols’]