mat3ra-esse 2025.5.17.post1__py3-none-any.whl → 2025.6.5.post0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of mat3ra-esse might be problematic. Click here for more details.
- mat3ra/esse/data/examples.py +1 -1
- mat3ra/esse/data/schemas.py +1 -1
- mat3ra/esse/models/apse/file/applications/espresso/7.2/pw_x.py +6 -6
- mat3ra/esse/models/apse/materials/builders/slab/pymatgen/parameters.py +3 -3
- mat3ra/esse/models/coordinates_shape_enum.py +15 -0
- mat3ra/esse/models/core/primitive/array_of_3_integers.py +13 -0
- mat3ra/esse/models/core/reusable/axis_enum.py +13 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/__init__.py +31 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/base.py +21 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/box.py +24 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/cylinder.py +26 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/enum.py +15 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/plane.py +24 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/sphere.py +24 -0
- mat3ra/esse/models/core/reusable/coordinate_conditions/triangular_prism.py +27 -0
- mat3ra/esse/models/core/reusable/energy.py +2 -2
- mat3ra/esse/models/element.py +6 -6
- mat3ra/esse/models/material/__init__.py +14 -14
- mat3ra/esse/models/material/reusable/coordinate_conditions/base.py +21 -0
- mat3ra/esse/models/material/reusable/coordinate_conditions/box.py +24 -0
- mat3ra/esse/models/material/reusable/coordinate_conditions/cylinder.py +26 -0
- mat3ra/esse/models/material/reusable/coordinate_conditions/plane.py +24 -0
- mat3ra/esse/models/material/reusable/coordinate_conditions/sphere.py +24 -0
- mat3ra/esse/models/material/reusable/coordinate_conditions/triangular_prism.py +27 -0
- mat3ra/esse/models/material/reusable/slab/slab_configuration_with_termination.py +589 -0
- mat3ra/esse/models/material/reusable/slab/slab_with_termination.py +593 -0
- mat3ra/esse/models/material/reusable/slab/two_slabs_stack.py +618 -0
- mat3ra/esse/models/material/reusable/slab_configuration_with_termination.py +712 -0
- mat3ra/esse/models/material/reusable/stack/slab_configuration_with_termination.py +593 -0
- mat3ra/esse/models/material/reusable/stack/slab_in_stack.py +720 -0
- mat3ra/esse/models/material/reusable/stack/stack_of_slabs.py +737 -0
- mat3ra/esse/models/material/reusable/stack/stack_of_two_slabs.py +737 -0
- mat3ra/esse/models/material/reusable/supercell/supercell_matrix_2d.py +25 -0
- mat3ra/esse/models/material/reusable/supercell/supercell_matrix_3d.py +27 -0
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/adatom/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/layered/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/point/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/one_dimensional/terrace/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/{zero_dimensional/complex/pair.py → two_dimensional/grain_boundary_plane/configuration.py} +163 -497
- mat3ra/esse/models/materials_category/defects/two_dimensional/island/condition_json.py +28 -0
- mat3ra/esse/models/materials_category/defects/two_dimensional/island/configuration.py +163 -48
- mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/pair/configuration.py +130 -130
- mat3ra/esse/models/materials_category/defects/zero_dimensional/point/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/zero_dimensional/point/interstitial/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/zero_dimensional/point/substitution/configuration.py +14 -14
- mat3ra/esse/models/materials_category/defects/zero_dimensional/point/vacancy/configuration.py +14 -14
- mat3ra/esse/models/materials_category/multi_material/interfaces/configuration.py +737 -0
- mat3ra/esse/models/materials_category/{defects/slab/configuration.py → pristine_structures/three_dimensional/ideal_crystal.py} +142 -24
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab.py +730 -0
- mat3ra/esse/models/materials_category/single_material/two_dimensional/slab/configuration.py +17 -21
- mat3ra/esse/models/materials_category_components/entities/auxiliary/three_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/three_dimensional/supercell_matrix_3d.py +27 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/two_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/two_dimensional/miller_indices.py +16 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/two_dimensional/supercell_matrix_2d.py +25 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/two_dimensional/termination.py +144 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/crystal_site.py +13 -0
- mat3ra/esse/models/materials_category_components/entities/core/three_dimensional/__init__.py +3 -0
- mat3ra/esse/models/{materials_category/defects/zero_dimensional/slab/configuration.py → materials_category_components/entities/core/three_dimensional/crystal.py} +142 -46
- mat3ra/esse/models/materials_category_components/entities/core/three_dimensional/void.py +32 -0
- mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/vacuum.py +27 -0
- mat3ra/esse/models/materials_category_components/entities/core/zero_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/core/zero_dimensional/atom.py +134 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/repetitions.py +25 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_non_uniform.py +544 -0
- mat3ra/esse/models/{materials_category/defects/zero_dimensional/adatom/base_configuration.py → materials_category_components/entities/reusable/three_dimensional/strained_uniform.py} +147 -24
- mat3ra/esse/models/{materials_category/defects/zero_dimensional/adatom/configuration.py → materials_category_components/entities/reusable/three_dimensional/supercell.py} +150 -26
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/atomic_layers.py +683 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/atomic_layers_unique.py +683 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/atomic_layers_unique_repeated.py +687 -0
- mat3ra/esse/models/{materials_category/defects/by_host/two_dimensional/configuration.py → materials_category_components/entities/reusable/two_dimensional/crystal_lattice_planes.py} +23 -28
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_unit_cell.py +717 -0
- mat3ra/esse/models/materials_category_components/operations/core/combinations/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/operations/core/combinations/merge.py +583 -0
- mat3ra/esse/models/materials_category_components/operations/core/combinations/stack.py +555 -0
- mat3ra/esse/models/materials_category_components/operations/core/combinations/stack_component.py +554 -0
- mat3ra/esse/models/materials_category_components/operations/core/modifications/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/operations/core/modifications/repeat.py +27 -0
- mat3ra/esse/models/materials_category_components/operations/core/modifications/strain.py +19 -0
- mat3ra/esse/models/properties_directory/derived_properties.py +11 -11
- mat3ra/esse/models/properties_directory/non_scalar/average_potential_profile.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/band_structure.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +50 -50
- mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/formation_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/surface_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/total_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +2 -2
- mat3ra/esse/models/properties_directory/structural/basis/__init__.py +2 -2
- mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +4 -4
- mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +2 -2
- {mat3ra_esse-2025.5.17.post1.dist-info → mat3ra_esse-2025.6.5.post0.dist-info}/METADATA +1 -1
- {mat3ra_esse-2025.5.17.post1.dist-info → mat3ra_esse-2025.6.5.post0.dist-info}/RECORD +117 -65
- {mat3ra_esse-2025.5.17.post1.dist-info → mat3ra_esse-2025.6.5.post0.dist-info}/WHEEL +1 -1
- mat3ra/esse/models/materials_category/defects/enums/atom_placement_method.py +0 -22
- mat3ra/esse/models/materials_category/defects/enums/complex_defect_type.py +0 -18
- mat3ra/esse/models/materials_category/defects/enums/coordinates_shape.py +0 -21
- mat3ra/esse/models/materials_category/defects/enums/slab_defect_type.py +0 -19
- mat3ra/esse/models/materials_category/defects/enums.py +0 -13
- mat3ra/esse/models/materials_category/defects/two_dimensional/slab_grain_boundary/configuration.py +0 -1105
- mat3ra/esse/models/materials_category/defects/zero_dimensional/defect_pair/configuration.py +0 -1026
- mat3ra/esse/models/materials_category/defects/zero_dimensional/point/base_configuration.py +0 -30
- /mat3ra/esse/models/{materials_category/defects/by_host/two_dimensional → material/reusable/coordinate_conditions}/__init__.py +0 -0
- /mat3ra/esse/models/{materials_category/defects/slab → material/reusable/stack}/__init__.py +0 -0
- /mat3ra/esse/models/{materials_category/defects/two_dimensional/slab_grain_boundary → material/reusable/supercell}/__init__.py +0 -0
- /mat3ra/esse/models/materials_category/defects/{zero_dimensional/adatom → two_dimensional/grain_boundary_plane}/__init__.py +0 -0
- /mat3ra/esse/models/materials_category/{defects/zero_dimensional/complex → multi_material/interfaces}/__init__.py +0 -0
- /mat3ra/esse/models/materials_category/{defects/zero_dimensional/defect_pair → pristine_structures/three_dimensional}/__init__.py +0 -0
- /mat3ra/esse/models/materials_category/{defects/zero_dimensional/slab → pristine_structures/two_dimensional}/__init__.py +0 -0
- {mat3ra_esse-2025.5.17.post1.dist-info → mat3ra_esse-2025.6.5.post0.dist-info}/licenses/LICENSE.md +0 -0
- {mat3ra_esse-2025.5.17.post1.dist-info → mat3ra_esse-2025.6.5.post0.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# generated by datamodel-codegen:
|
|
2
|
+
# filename: materials_category_components/entities/core/two_dimensional/vacuum.json
|
|
3
|
+
# version: 0.28.5
|
|
4
|
+
|
|
5
|
+
from __future__ import annotations
|
|
6
|
+
|
|
7
|
+
from enum import Enum
|
|
8
|
+
from typing import Optional
|
|
9
|
+
|
|
10
|
+
from pydantic import BaseModel, Field, confloat
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class AxisEnum(Enum):
|
|
14
|
+
x = "x"
|
|
15
|
+
y = "y"
|
|
16
|
+
z = "z"
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class VacuumConfigurationSchema(BaseModel):
|
|
20
|
+
direction: AxisEnum = Field(..., title="Axis Enum")
|
|
21
|
+
"""
|
|
22
|
+
Enum for axis types
|
|
23
|
+
"""
|
|
24
|
+
size: Optional[confloat(ge=0.0)] = 10
|
|
25
|
+
"""
|
|
26
|
+
Size of the vacuum slab in angstroms
|
|
27
|
+
"""
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# generated by datamodel-codegen:
|
|
2
|
+
# filename: materials_category_components/entities/core/zero_dimensional/atom.json
|
|
3
|
+
# version: 0.28.5
|
|
4
|
+
|
|
5
|
+
from __future__ import annotations
|
|
6
|
+
|
|
7
|
+
from enum import Enum
|
|
8
|
+
|
|
9
|
+
from pydantic import BaseModel
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class ChemicalElement(Enum):
|
|
13
|
+
H = "H"
|
|
14
|
+
He = "He"
|
|
15
|
+
Li = "Li"
|
|
16
|
+
Be = "Be"
|
|
17
|
+
B = "B"
|
|
18
|
+
C = "C"
|
|
19
|
+
N = "N"
|
|
20
|
+
O = "O"
|
|
21
|
+
F = "F"
|
|
22
|
+
Ne = "Ne"
|
|
23
|
+
Na = "Na"
|
|
24
|
+
Mg = "Mg"
|
|
25
|
+
Al = "Al"
|
|
26
|
+
Si = "Si"
|
|
27
|
+
P = "P"
|
|
28
|
+
S = "S"
|
|
29
|
+
Cl = "Cl"
|
|
30
|
+
Ar = "Ar"
|
|
31
|
+
K = "K"
|
|
32
|
+
Ca = "Ca"
|
|
33
|
+
Sc = "Sc"
|
|
34
|
+
Ti = "Ti"
|
|
35
|
+
V = "V"
|
|
36
|
+
Cr = "Cr"
|
|
37
|
+
Mn = "Mn"
|
|
38
|
+
Fe = "Fe"
|
|
39
|
+
Co = "Co"
|
|
40
|
+
Ni = "Ni"
|
|
41
|
+
Cu = "Cu"
|
|
42
|
+
Zn = "Zn"
|
|
43
|
+
Ga = "Ga"
|
|
44
|
+
Ge = "Ge"
|
|
45
|
+
As = "As"
|
|
46
|
+
Se = "Se"
|
|
47
|
+
Br = "Br"
|
|
48
|
+
Kr = "Kr"
|
|
49
|
+
Rb = "Rb"
|
|
50
|
+
Sr = "Sr"
|
|
51
|
+
Y = "Y"
|
|
52
|
+
Zr = "Zr"
|
|
53
|
+
Nb = "Nb"
|
|
54
|
+
Mo = "Mo"
|
|
55
|
+
Tc = "Tc"
|
|
56
|
+
Ru = "Ru"
|
|
57
|
+
Rh = "Rh"
|
|
58
|
+
Pd = "Pd"
|
|
59
|
+
Ag = "Ag"
|
|
60
|
+
Cd = "Cd"
|
|
61
|
+
In = "In"
|
|
62
|
+
Sn = "Sn"
|
|
63
|
+
Sb = "Sb"
|
|
64
|
+
Te = "Te"
|
|
65
|
+
I = "I"
|
|
66
|
+
Xe = "Xe"
|
|
67
|
+
Cs = "Cs"
|
|
68
|
+
Ba = "Ba"
|
|
69
|
+
La = "La"
|
|
70
|
+
Ce = "Ce"
|
|
71
|
+
Pr = "Pr"
|
|
72
|
+
Nd = "Nd"
|
|
73
|
+
Pm = "Pm"
|
|
74
|
+
Sm = "Sm"
|
|
75
|
+
Eu = "Eu"
|
|
76
|
+
Gd = "Gd"
|
|
77
|
+
Tb = "Tb"
|
|
78
|
+
Dy = "Dy"
|
|
79
|
+
Ho = "Ho"
|
|
80
|
+
Er = "Er"
|
|
81
|
+
Tm = "Tm"
|
|
82
|
+
Yb = "Yb"
|
|
83
|
+
Lu = "Lu"
|
|
84
|
+
Hf = "Hf"
|
|
85
|
+
Ta = "Ta"
|
|
86
|
+
W = "W"
|
|
87
|
+
Re = "Re"
|
|
88
|
+
Os = "Os"
|
|
89
|
+
Ir = "Ir"
|
|
90
|
+
Pt = "Pt"
|
|
91
|
+
Au = "Au"
|
|
92
|
+
Hg = "Hg"
|
|
93
|
+
Tl = "Tl"
|
|
94
|
+
Pb = "Pb"
|
|
95
|
+
Bi = "Bi"
|
|
96
|
+
Po = "Po"
|
|
97
|
+
At = "At"
|
|
98
|
+
Rn = "Rn"
|
|
99
|
+
Fr = "Fr"
|
|
100
|
+
Ra = "Ra"
|
|
101
|
+
Ac = "Ac"
|
|
102
|
+
Th = "Th"
|
|
103
|
+
Pa = "Pa"
|
|
104
|
+
U = "U"
|
|
105
|
+
Np = "Np"
|
|
106
|
+
Pu = "Pu"
|
|
107
|
+
Am = "Am"
|
|
108
|
+
Cm = "Cm"
|
|
109
|
+
Bk = "Bk"
|
|
110
|
+
Cf = "Cf"
|
|
111
|
+
Es = "Es"
|
|
112
|
+
Fm = "Fm"
|
|
113
|
+
Md = "Md"
|
|
114
|
+
No = "No"
|
|
115
|
+
Lr = "Lr"
|
|
116
|
+
Rf = "Rf"
|
|
117
|
+
Db = "Db"
|
|
118
|
+
Sg = "Sg"
|
|
119
|
+
Bh = "Bh"
|
|
120
|
+
Hs = "Hs"
|
|
121
|
+
Mt = "Mt"
|
|
122
|
+
Ds = "Ds"
|
|
123
|
+
Rg = "Rg"
|
|
124
|
+
Cn = "Cn"
|
|
125
|
+
Nh = "Nh"
|
|
126
|
+
Fl = "Fl"
|
|
127
|
+
Mc = "Mc"
|
|
128
|
+
Lv = "Lv"
|
|
129
|
+
Ts = "Ts"
|
|
130
|
+
Og = "Og"
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
class AtomSchema(BaseModel):
|
|
134
|
+
chemical_element: ChemicalElement
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# generated by datamodel-codegen:
|
|
2
|
+
# filename: materials_category_components/entities/reusable/repetitions.json
|
|
3
|
+
# version: 0.28.5
|
|
4
|
+
|
|
5
|
+
from __future__ import annotations
|
|
6
|
+
|
|
7
|
+
from typing import List, Optional
|
|
8
|
+
|
|
9
|
+
from pydantic import Field, RootModel, conint
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class CrystalRepetitionsSchemaItem(RootModel[conint(ge=1)]):
|
|
13
|
+
root: conint(ge=1)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class CrystalRepetitionsSchema(RootModel[Optional[List[CrystalRepetitionsSchemaItem]]]):
|
|
17
|
+
root: Optional[List[CrystalRepetitionsSchemaItem]] = Field(
|
|
18
|
+
default_factory=lambda: [CrystalRepetitionsSchemaItem.model_validate(v) for v in [1, 1, 1]],
|
|
19
|
+
max_length=3,
|
|
20
|
+
min_length=3,
|
|
21
|
+
title="Crystal Repetitions Schema",
|
|
22
|
+
)
|
|
23
|
+
"""
|
|
24
|
+
Number of unit cells to repeat in each direction for a crystal structure.
|
|
25
|
+
"""
|