File: find_structure.py

package info (click to toggle)
python-emmet-core 0.84.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 77,220 kB
  • sloc: python: 16,355; makefile: 30
file content (38 lines) | stat: -rw-r--r-- 1,142 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
from emmet.core.mpid import MPID, MPculeID
from pydantic import Field, BaseModel
from typing import Optional


class FindStructure(BaseModel):
    """
    Class defining find structure return data
    """

    material_id: Optional[MPID] = Field(
        None,
        description="The ID of this material, used as a universal reference across property documents."
        "This comes in the form: mp-******.",
    )
    normalized_rms_displacement: Optional[float] = Field(
        None,
        description="Volume normalized root-mean squared displacement between the structures",
    )
    max_distance_paired_sites: Optional[float] = Field(
        None,
        description="Maximum distance between paired sites.",
    )


class FindMolecule(BaseModel):
    """
    Class defining find molecule return data
    """

    molecule_id: Optional[MPculeID] = Field(
        None,
        description="The ID of this molecule, used as a universal reference across property documents.",
    )
    rmsd: Optional[float] = Field(
        None,
        description="Root-mean-squared displacement of the molecule compared to a reference",
    )