mat3ra-esse 2025.5.17.post1__py3-none-any.whl → 2025.5.17.post2__py3-none-any.whl

mat3ra/esse/models/{materials_category/defects/by_host/two_dimensional/configuration.py → material/reusable/slab/slab_configuration_with_termination.py}

@@ -1,5 +1,5 @@
 # generated by datamodel-codegen:
-#   filename:  materials_category/defects/by_host/two_dimensional/configuration.json
+#   filename:  material/reusable/slab/slab_configuration_with_termination.json
 #   version:   0.28.5
 
 from __future__ import annotations
@@ -131,13 +131,13 @@ class Value(Enum):
     Og = "Og"
 
 
-class Value11(Enum):
+class Value51(Enum):
     X = "X"
     Vac = "Vac"
 
 
 class AtomicElementSchema(BaseModel):
-    value: Union[Value, Value11]
+    value: Union[Value, Value51]
     """
     All elements, including extra elements
     """
@@ -285,30 +285,30 @@ class VolumeSchema(BaseModel):
     value: float
 
 
-class Name16(Enum):
+class Name205(Enum):
     density = "density"
 
 
-class Units13(Enum):
+class Units99(Enum):
     g_cm_3 = "g/cm^3"
 
 
 class DensitySchema(BaseModel):
     name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
-    units: Optional[Units13] = None
+    units: Optional[Units99] = None
     value: float
 
 
-class Units14(Enum):
+class Units100(Enum):
     angstrom = "angstrom"
 
 
 class ScalarSchema(BaseModel):
-    units: Optional[Units14] = None
+    units: Optional[Units100] = None
     value: float
 
 
-class Name17(Enum):
+class Name206(Enum):
     symmetry = "symmetry"
 
 
@@ -328,7 +328,7 @@ class SymmetrySchema(BaseModel):
     name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
 
 
-class Name18(Enum):
+class Name207(Enum):
     elemental_ratio = "elemental_ratio"
 
 
@@ -341,7 +341,7 @@ class ElementalRatio(BaseModel):
     """
 
 
-class Name19(Enum):
+class Name208(Enum):
     p_norm = "p-norm"
 
 
@@ -354,7 +354,7 @@ class PNorm(BaseModel):
     value: float
 
 
-class Name20(Enum):
+class Name209(Enum):
     inchi = "inchi"
 
 
@@ -363,7 +363,7 @@ class InChIRepresentationSchema(BaseModel):
     value: str
 
 
-class Name21(Enum):
+class Name210(Enum):
     inchi_key = "inchi_key"
 
 
@@ -442,7 +442,7 @@ class FileSourceSchema(BaseModel):
     """
 
 
-class Name22(Enum):
+class Name211(Enum):
     default = "default"
     atomsTooClose = "atomsTooClose"
     atomsOverlap = "atomsOverlap"
@@ -455,7 +455,7 @@ class Severity(Enum):
 
 
 class MaterialConsistencyCheckSchema(BaseModel):
-    name: Name22
+    name: Name211
     """
     Name of the consistency check that is performed, which is listed in an enum.
     """
@@ -530,21 +530,60 @@ class MaterialSchema(BaseModel):
     metadata: Optional[Dict[str, Any]] = None
 
 
-class TwoDimensionalDefectConfigurationSchema(BaseModel):
-    position_on_surface: List[float] = Field(..., max_length=2, min_length=2, title="coordinate 2d schema")
-    distance_z: confloat(ge=0.0)
+class SupercellMatrix2DSchemaItem(RootModel[List[int]]):
+    root: List[int]
+
+
+class SlabConfigurationSchema(BaseModel):
+    bulk: Optional[MaterialSchema] = Field(None, title="material schema")
+    miller_indices: Optional[List[int]] = Field([0, 0, 1], max_length=3, min_length=3, title="Miller Indices Schema")
+    """
+    Miller indices for crystallographic plane designation
+    """
+    number_of_layers: Optional[conint(ge=1)] = Field(1, title="Number of Layers Schema")
+    """
+    Number of atomic layers in a structural component
+    """
+    vacuum: Optional[confloat(ge=0.0)] = Field(5, title="Vacuum Thickness Schema")
+    """
+    Vacuum thickness in Angstroms
+    """
+    xy_supercell_matrix: Optional[List[SupercellMatrix2DSchemaItem]] = Field(
+        default_factory=lambda: [SupercellMatrix2DSchemaItem.model_validate(v) for v in [[1, 0], [0, 1]]],
+        max_length=2,
+        min_length=2,
+        title="Supercell Matrix 2D Schema",
+    )
+    """
+    Supercell matrix for xy plane transformations
     """
-    Distance from the surface in Angstroms
+    use_conventional_cell: Optional[bool] = Field(True, title="Use Conventional Cell")
     """
-    host: Optional[MaterialSchema] = None
+    Whether to use conventional cell when generating the slab.
     """
-    The base host for the defect
+    use_orthogonal_z: Optional[bool] = Field(True, title="Use Orthogonal Z")
     """
-    use_cartesian_coordinates: Optional[bool] = False
+    Whether to make vector c orthogonal to ab plane for the slab cell.
+    """
+
+
+class TerminationSchema(BaseModel):
+    chemical_elements: str = Field(..., title="Chemical Elements")
+    """
+    Chemical elements at the termination
+    """
+    space_group_symmetry_label: str = Field(..., title="Space Group Symmetry Label")
+    """
+    Space group symmetry designation for the termination
+    """
+
+
+class SlabWithTerminationConfigurationSchema(BaseModel):
+    slab_configuration: SlabConfigurationSchema = Field(..., title="Slab Configuration Schema")
     """
-    Whether to use Cartesian coordinates
+    Configuration for creating a slab from a bulk material
     """
-    isExternal: Optional[bool] = False
+    termination: TerminationSchema = Field(..., title="Termination Schema")
     """
-    Whether the defect is external to the host material
+    Defines a specific termination of a slab
     """

mat3ra/esse/models/{materials_category/defects/zero_dimensional/slab/configuration.py → material/reusable/slab/slab_with_termination.py}

@@ -1,5 +1,5 @@
 # generated by datamodel-codegen:
-#   filename:  materials_category/defects/zero_dimensional/slab/configuration.json
+#   filename:  material/reusable/slab/slab_with_termination.json
 #   version:   0.28.5
 
 from __future__ import annotations
@@ -10,10 +10,136 @@ from typing import Any, Dict, List, Literal, Optional, Union
 from pydantic import BaseModel, Field, RootModel, confloat, conint
 
 
+class Value(Enum):
+    H = "H"
+    He = "He"
+    Li = "Li"
+    Be = "Be"
+    B = "B"
+    C = "C"
+    N = "N"
+    O = "O"
+    F = "F"
+    Ne = "Ne"
+    Na = "Na"
+    Mg = "Mg"
+    Al = "Al"
+    Si = "Si"
+    P = "P"
+    S = "S"
+    Cl = "Cl"
+    Ar = "Ar"
+    K = "K"
+    Ca = "Ca"
+    Sc = "Sc"
+    Ti = "Ti"
+    V = "V"
+    Cr = "Cr"
+    Mn = "Mn"
+    Fe = "Fe"
+    Co = "Co"
+    Ni = "Ni"
+    Cu = "Cu"
+    Zn = "Zn"
+    Ga = "Ga"
+    Ge = "Ge"
+    As = "As"
+    Se = "Se"
+    Br = "Br"
+    Kr = "Kr"
+    Rb = "Rb"
+    Sr = "Sr"
+    Y = "Y"
+    Zr = "Zr"
+    Nb = "Nb"
+    Mo = "Mo"
+    Tc = "Tc"
+    Ru = "Ru"
+    Rh = "Rh"
+    Pd = "Pd"
+    Ag = "Ag"
+    Cd = "Cd"
+    In = "In"
+    Sn = "Sn"
+    Sb = "Sb"
+    Te = "Te"
+    I = "I"
+    Xe = "Xe"
+    Cs = "Cs"
+    Ba = "Ba"
+    La = "La"
+    Ce = "Ce"
+    Pr = "Pr"
+    Nd = "Nd"
+    Pm = "Pm"
+    Sm = "Sm"
+    Eu = "Eu"
+    Gd = "Gd"
+    Tb = "Tb"
+    Dy = "Dy"
+    Ho = "Ho"
+    Er = "Er"
+    Tm = "Tm"
+    Yb = "Yb"
+    Lu = "Lu"
+    Hf = "Hf"
+    Ta = "Ta"
+    W = "W"
+    Re = "Re"
+    Os = "Os"
+    Ir = "Ir"
+    Pt = "Pt"
+    Au = "Au"
+    Hg = "Hg"
+    Tl = "Tl"
+    Pb = "Pb"
+    Bi = "Bi"
+    Po = "Po"
+    At = "At"
+    Rn = "Rn"
+    Fr = "Fr"
+    Ra = "Ra"
+    Ac = "Ac"
+    Th = "Th"
+    Pa = "Pa"
+    U = "U"
+    Np = "Np"
+    Pu = "Pu"
+    Am = "Am"
+    Cm = "Cm"
+    Bk = "Bk"
+    Cf = "Cf"
+    Es = "Es"
+    Fm = "Fm"
+    Md = "Md"
+    No = "No"
+    Lr = "Lr"
+    Rf = "Rf"
+    Db = "Db"
+    Sg = "Sg"
+    Bh = "Bh"
+    Hs = "Hs"
+    Mt = "Mt"
+    Ds = "Ds"
+    Rg = "Rg"
+    Cn = "Cn"
+    Nh = "Nh"
+    Fl = "Fl"
+    Mc = "Mc"
+    Lv = "Lv"
+    Ts = "Ts"
+    Og = "Og"
+
+
+class Value53(Enum):
+    X = "X"
+    Vac = "Vac"
+
+
 class AtomicElementSchema(BaseModel):
-    value: str
+    value: Union[Value, Value53]
     """
-    value of this entry
+    All elements, including extra elements
     """
     id: int
     """
@@ -159,30 +285,30 @@ class VolumeSchema(BaseModel):
     value: float
 
 
-class Name48(Enum):
+class Name213(Enum):
     density = "density"
 
 
-class Units25(Enum):
+class Units102(Enum):
     g_cm_3 = "g/cm^3"
 
 
 class DensitySchema(BaseModel):
     name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
-    units: Optional[Units25] = None
+    units: Optional[Units102] = None
     value: float
 
 
-class Units26(Enum):
+class Units103(Enum):
     angstrom = "angstrom"
 
 
 class ScalarSchema(BaseModel):
-    units: Optional[Units26] = None
+    units: Optional[Units103] = None
     value: float
 
 
-class Name49(Enum):
+class Name214(Enum):
     symmetry = "symmetry"
 
 
@@ -202,7 +328,7 @@ class SymmetrySchema(BaseModel):
     name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
 
 
-class Name50(Enum):
+class Name215(Enum):
     elemental_ratio = "elemental_ratio"
 
 
@@ -215,7 +341,7 @@ class ElementalRatio(BaseModel):
     """
 
 
-class Name51(Enum):
+class Name216(Enum):
     p_norm = "p-norm"
 
 
@@ -228,7 +354,7 @@ class PNorm(BaseModel):
     value: float
 
 
-class Name52(Enum):
+class Name217(Enum):
     inchi = "inchi"
 
 
@@ -237,7 +363,7 @@ class InChIRepresentationSchema(BaseModel):
     value: str
 
 
-class Name53(Enum):
+class Name218(Enum):
     inchi_key = "inchi_key"
 
 
@@ -316,7 +442,7 @@ class FileSourceSchema(BaseModel):
     """
 
 
-class Name54(Enum):
+class Name219(Enum):
     default = "default"
     atomsTooClose = "atomsTooClose"
     atomsOverlap = "atomsOverlap"
@@ -329,7 +455,7 @@ class Severity(Enum):
 
 
 class MaterialConsistencyCheckSchema(BaseModel):
-    name: Name54
+    name: Name219
     """
     Name of the consistency check that is performed, which is listed in an enum.
     """
@@ -404,31 +530,64 @@ class MaterialSchema(BaseModel):
     metadata: Optional[Dict[str, Any]] = None
 
 
-class DefectType(Enum):
-    vacancy = "vacancy"
-    substitution = "substitution"
-    interstitial = "interstitial"
-    adatom = "adatom"
+class SupercellMatrix2DSchemaItem(RootModel[List[int]]):
+    root: List[int]
 
 
-class SlabPointDefectConfigurationSchema(BaseModel):
-    position_on_surface: List[float] = Field(..., max_length=2, min_length=2, title="coordinate 2d schema")
-    distance_z: confloat(ge=0.0)
+class SlabConfigurationSchema(BaseModel):
+    bulk: Optional[MaterialSchema] = Field(None, title="material schema")
+    miller_indices: Optional[List[int]] = Field([0, 0, 1], max_length=3, min_length=3, title="Miller Indices Schema")
     """
-    Distance from the surface in Angstroms
+    Miller indices for crystallographic plane designation
     """
-    number_of_added_layers: Optional[conint(ge=1)] = Field(1, title="Number of Layers Schema")
+    number_of_layers: Optional[conint(ge=1)] = Field(1, title="Number of Layers Schema")
     """
     Number of atomic layers in a structural component
     """
-    crystal: MaterialSchema = Field(..., title="material schema")
-    defect_type: DefectType
-    coordinate: List[float] = Field(..., max_length=3, min_length=3, title="coordinate 3d schema")
-    chemical_element: Optional[str] = None
+    vacuum: Optional[confloat(ge=0.0)] = Field(5, title="Vacuum Thickness Schema")
+    """
+    Vacuum thickness in Angstroms
+    """
+    xy_supercell_matrix: Optional[List[SupercellMatrix2DSchemaItem]] = Field(
+        default_factory=lambda: [SupercellMatrix2DSchemaItem.model_validate(v) for v in [[1, 0], [0, 1]]],
+        max_length=2,
+        min_length=2,
+        title="Supercell Matrix 2D Schema",
+    )
+    """
+    Supercell matrix for xy plane transformations
+    """
+    use_conventional_cell: Optional[bool] = Field(True, title="Use Conventional Cell")
+    """
+    Whether to use conventional cell
+    """
+    use_orthogonal_z: Optional[bool] = Field(False, title="Use Orthogonal Z")
+    """
+    Whether to make z-axis orthogonal
+    """
+    make_primitive: Optional[bool] = Field(False, title="Make Primitive")
+    """
+    Whether to make the slab primitive
+    """
+
+
+class TerminationSchema(BaseModel):
+    chemical_elements: str = Field(..., title="Chemical Elements")
+    """
+    Chemical elements at the termination
+    """
+    space_group_symmetry_label: str = Field(..., title="Space Group Symmetry Label")
+    """
+    Space group symmetry designation for the termination
+    """
+
+
+class SlabWithTerminationConfigurationSchema(BaseModel):
+    slab_configuration: SlabConfigurationSchema = Field(..., title="Slab Configuration Schema")
     """
-    The chemical element for substitution or interstitial defects
+    Configuration for creating a slab from a bulk material
     """
-    use_cartesian_coordinates: Optional[bool] = False
+    termination: TerminationSchema = Field(..., title="Termination Schema")
     """
-    Whether coordinates are in cartesian rather than fractional coordinates
+    Defines a specific termination of a slab
     """