ManyBodyProtocols

pydantic model qcmanybody.models.v2.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": {
      "schema_name": {
         "const": "qcschema_many_body_protocols",
         "default": "qcschema_many_body_protocols",
         "title": "Schema Name",
         "type": "string"
      },
      "cluster_results": {
         "$ref": "#/$defs/ClusterResultsProtocolEnum",
         "default": "none"
      }
   },
   "$defs": {
      "ClusterResultsProtocolEnum": {
         "description": "Which component results to preserve in a many body result; usually AtomicResults.",
         "enum": [
            "all",
            "none"
         ],
         "title": "ClusterResultsProtocolEnum",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Fields:

cluster_results (qcmanybody.models.v2.many_body.ClusterResultsProtocolEnum)
schema_name (Literal['qcschema_many_body_protocols'])

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

field schema_name: Literal['qcschema_many_body_protocols'] = 'qcschema_many_body_protocols'

convert_v(target_version, /) → ManyBodyProtocols | ManyBodyProtocols[source]

Convert to instance of particular QCSchema version.

Return type:: Union[ManyBodyProtocols, ManyBodyProtocols]
Parameters:: target_version (int)