mat3ra-esse 2025.5.17.post0__py3-none-any.whl → 2025.5.17.post1__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/core/reusable/energy.py +2 -2
- mat3ra/esse/models/element.py +6 -6
- mat3ra/esse/models/material/__init__.py +14 -14
- 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/configuration.py +4 -0
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/layered/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/layered/configuration.py +549 -0
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/point/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/point/configuration.py +550 -0
- mat3ra/esse/models/materials_category/defects/configuration.py +4 -0
- mat3ra/esse/models/materials_category/defects/one_dimensional/terrace/configuration.py +157 -19
- mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/pair/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/pair/configuration.py +1538 -0
- 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/single_material/two_dimensional/slab/configuration.py +14 -14
- mat3ra/esse/models/properties_directory/derived_properties.py +11 -11
- 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/molecular_pattern.py +4 -4
- mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +2 -2
- {mat3ra_esse-2025.5.17.post0.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/METADATA +1 -1
- {mat3ra_esse-2025.5.17.post0.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/RECORD +43 -37
- {mat3ra_esse-2025.5.17.post0.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/WHEEL +0 -0
- {mat3ra_esse-2025.5.17.post0.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/licenses/LICENSE.md +0 -0
- {mat3ra_esse-2025.5.17.post0.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/top_level.txt +0 -0
|
@@ -1663,7 +1663,7 @@ class CardOption(Enum):
|
|
|
1663
1663
|
crystal_sg = "crystal_sg"
|
|
1664
1664
|
|
|
1665
1665
|
|
|
1666
|
-
class
|
|
1666
|
+
class Value39(BaseModel):
|
|
1667
1667
|
model_config = ConfigDict(
|
|
1668
1668
|
extra="forbid",
|
|
1669
1669
|
)
|
|
@@ -1693,7 +1693,7 @@ class AtomicPositionsSchema(BaseModel):
|
|
|
1693
1693
|
extra="forbid",
|
|
1694
1694
|
)
|
|
1695
1695
|
card_option: Optional[CardOption] = "alat"
|
|
1696
|
-
values: Optional[List[
|
|
1696
|
+
values: Optional[List[Value39]] = None
|
|
1697
1697
|
|
|
1698
1698
|
|
|
1699
1699
|
class CardOption5(Enum):
|
|
@@ -1707,7 +1707,7 @@ class CardOption5(Enum):
|
|
|
1707
1707
|
crystal_c = "crystal_c"
|
|
1708
1708
|
|
|
1709
1709
|
|
|
1710
|
-
class
|
|
1710
|
+
class Value40(BaseModel):
|
|
1711
1711
|
model_config = ConfigDict(
|
|
1712
1712
|
extra="forbid",
|
|
1713
1713
|
)
|
|
@@ -1756,7 +1756,7 @@ class KPointsSchema(BaseModel):
|
|
|
1756
1756
|
extra="forbid",
|
|
1757
1757
|
)
|
|
1758
1758
|
card_option: Optional[CardOption5] = None
|
|
1759
|
-
values: Optional[Union[List[
|
|
1759
|
+
values: Optional[Union[List[Value40], Values]] = None
|
|
1760
1760
|
|
|
1761
1761
|
|
|
1762
1762
|
class CardOption6(Enum):
|
|
@@ -1853,7 +1853,7 @@ class ParamType(Enum):
|
|
|
1853
1853
|
E3 = "E3"
|
|
1854
1854
|
|
|
1855
1855
|
|
|
1856
|
-
class
|
|
1856
|
+
class Value41(BaseModel):
|
|
1857
1857
|
model_config = ConfigDict(
|
|
1858
1858
|
extra="forbid",
|
|
1859
1859
|
)
|
|
@@ -1967,7 +1967,7 @@ class HubbardSchema(BaseModel):
|
|
|
1967
1967
|
)
|
|
1968
1968
|
card_option: Optional[CardOption7] = None
|
|
1969
1969
|
values: Optional[
|
|
1970
|
-
Union[List[Union[Values9, Values10]], List[
|
|
1970
|
+
Union[List[Union[Values9, Values10]], List[Value41], List[Union[Values11, Values12, Values13]]]
|
|
1971
1971
|
] = None
|
|
1972
1972
|
|
|
1973
1973
|
|
|
@@ -20,11 +20,11 @@ class Units(Enum):
|
|
|
20
20
|
eV_atom = "eV/atom"
|
|
21
21
|
|
|
22
22
|
|
|
23
|
-
class
|
|
23
|
+
class Units60(Enum):
|
|
24
24
|
eV_A_2 = "eV/A^2"
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
class EnergySchema(BaseModel):
|
|
28
28
|
name: str
|
|
29
|
-
units: Union[Units,
|
|
29
|
+
units: Union[Units, Units60]
|
|
30
30
|
value: float
|
mat3ra/esse/models/element.py
CHANGED
|
@@ -154,20 +154,20 @@ class AtomicRadius(BaseModel):
|
|
|
154
154
|
value: float
|
|
155
155
|
|
|
156
156
|
|
|
157
|
-
class
|
|
157
|
+
class Name127(Enum):
|
|
158
158
|
electronegativity = "electronegativity"
|
|
159
159
|
|
|
160
160
|
|
|
161
161
|
class Electronegativity(BaseModel):
|
|
162
|
-
name: Optional[
|
|
162
|
+
name: Optional[Name127] = None
|
|
163
163
|
value: float
|
|
164
164
|
|
|
165
165
|
|
|
166
|
-
class
|
|
166
|
+
class Name128(Enum):
|
|
167
167
|
ionization_potential = "ionization_potential"
|
|
168
168
|
|
|
169
169
|
|
|
170
|
-
class
|
|
170
|
+
class Units58(Enum):
|
|
171
171
|
kJ_mol = "kJ/mol"
|
|
172
172
|
eV = "eV"
|
|
173
173
|
J_mol = "J/mol"
|
|
@@ -178,8 +178,8 @@ class Units43(Enum):
|
|
|
178
178
|
|
|
179
179
|
|
|
180
180
|
class IonizationPotential(BaseModel):
|
|
181
|
-
name: Optional[
|
|
182
|
-
units: Optional[
|
|
181
|
+
name: Optional[Name128] = None
|
|
182
|
+
units: Optional[Units58] = None
|
|
183
183
|
value: float
|
|
184
184
|
|
|
185
185
|
|
|
@@ -131,13 +131,13 @@ class Value(Enum):
|
|
|
131
131
|
Og = "Og"
|
|
132
132
|
|
|
133
133
|
|
|
134
|
-
class
|
|
134
|
+
class Value37(Enum):
|
|
135
135
|
X = "X"
|
|
136
136
|
Vac = "Vac"
|
|
137
137
|
|
|
138
138
|
|
|
139
139
|
class AtomicElementSchema(BaseModel):
|
|
140
|
-
value: Union[Value,
|
|
140
|
+
value: Union[Value, Value37]
|
|
141
141
|
"""
|
|
142
142
|
All elements, including extra elements
|
|
143
143
|
"""
|
|
@@ -285,30 +285,30 @@ class VolumeSchema(BaseModel):
|
|
|
285
285
|
value: float
|
|
286
286
|
|
|
287
287
|
|
|
288
|
-
class
|
|
288
|
+
class Name149(Enum):
|
|
289
289
|
density = "density"
|
|
290
290
|
|
|
291
291
|
|
|
292
|
-
class
|
|
292
|
+
class Units75(Enum):
|
|
293
293
|
g_cm_3 = "g/cm^3"
|
|
294
294
|
|
|
295
295
|
|
|
296
296
|
class DensitySchema(BaseModel):
|
|
297
297
|
name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
|
|
298
|
-
units: Optional[
|
|
298
|
+
units: Optional[Units75] = None
|
|
299
299
|
value: float
|
|
300
300
|
|
|
301
301
|
|
|
302
|
-
class
|
|
302
|
+
class Units76(Enum):
|
|
303
303
|
angstrom = "angstrom"
|
|
304
304
|
|
|
305
305
|
|
|
306
306
|
class ScalarSchema(BaseModel):
|
|
307
|
-
units: Optional[
|
|
307
|
+
units: Optional[Units76] = None
|
|
308
308
|
value: float
|
|
309
309
|
|
|
310
310
|
|
|
311
|
-
class
|
|
311
|
+
class Name150(Enum):
|
|
312
312
|
symmetry = "symmetry"
|
|
313
313
|
|
|
314
314
|
|
|
@@ -328,7 +328,7 @@ class SymmetrySchema(BaseModel):
|
|
|
328
328
|
name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
|
|
329
329
|
|
|
330
330
|
|
|
331
|
-
class
|
|
331
|
+
class Name151(Enum):
|
|
332
332
|
elemental_ratio = "elemental_ratio"
|
|
333
333
|
|
|
334
334
|
|
|
@@ -341,7 +341,7 @@ class ElementalRatio(BaseModel):
|
|
|
341
341
|
"""
|
|
342
342
|
|
|
343
343
|
|
|
344
|
-
class
|
|
344
|
+
class Name152(Enum):
|
|
345
345
|
p_norm = "p-norm"
|
|
346
346
|
|
|
347
347
|
|
|
@@ -354,7 +354,7 @@ class PNorm(BaseModel):
|
|
|
354
354
|
value: float
|
|
355
355
|
|
|
356
356
|
|
|
357
|
-
class
|
|
357
|
+
class Name153(Enum):
|
|
358
358
|
inchi = "inchi"
|
|
359
359
|
|
|
360
360
|
|
|
@@ -363,7 +363,7 @@ class InChIRepresentationSchema(BaseModel):
|
|
|
363
363
|
value: str
|
|
364
364
|
|
|
365
365
|
|
|
366
|
-
class
|
|
366
|
+
class Name154(Enum):
|
|
367
367
|
inchi_key = "inchi_key"
|
|
368
368
|
|
|
369
369
|
|
|
@@ -442,7 +442,7 @@ class FileSourceSchema(BaseModel):
|
|
|
442
442
|
"""
|
|
443
443
|
|
|
444
444
|
|
|
445
|
-
class
|
|
445
|
+
class Name155(Enum):
|
|
446
446
|
default = "default"
|
|
447
447
|
atomsTooClose = "atomsTooClose"
|
|
448
448
|
atomsOverlap = "atomsOverlap"
|
|
@@ -455,7 +455,7 @@ class Severity(Enum):
|
|
|
455
455
|
|
|
456
456
|
|
|
457
457
|
class MaterialConsistencyCheckSchema(BaseModel):
|
|
458
|
-
name:
|
|
458
|
+
name: Name155
|
|
459
459
|
"""
|
|
460
460
|
Name of the consistency check that is performed, which is listed in an enum.
|
|
461
461
|
"""
|
mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/adatom/configuration.py
CHANGED
|
@@ -252,13 +252,13 @@ class Value(Enum):
|
|
|
252
252
|
Og = "Og"
|
|
253
253
|
|
|
254
254
|
|
|
255
|
-
class
|
|
255
|
+
class Value15(Enum):
|
|
256
256
|
X = "X"
|
|
257
257
|
Vac = "Vac"
|
|
258
258
|
|
|
259
259
|
|
|
260
260
|
class AtomicElementSchema(BaseModel):
|
|
261
|
-
value: Union[Value,
|
|
261
|
+
value: Union[Value, Value15]
|
|
262
262
|
"""
|
|
263
263
|
All elements, including extra elements
|
|
264
264
|
"""
|
|
@@ -406,30 +406,30 @@ class VolumeSchema(BaseModel):
|
|
|
406
406
|
value: float
|
|
407
407
|
|
|
408
408
|
|
|
409
|
-
class
|
|
409
|
+
class Name32(Enum):
|
|
410
410
|
density = "density"
|
|
411
411
|
|
|
412
412
|
|
|
413
|
-
class
|
|
413
|
+
class Units19(Enum):
|
|
414
414
|
g_cm_3 = "g/cm^3"
|
|
415
415
|
|
|
416
416
|
|
|
417
417
|
class DensitySchema(BaseModel):
|
|
418
418
|
name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
|
|
419
|
-
units: Optional[
|
|
419
|
+
units: Optional[Units19] = None
|
|
420
420
|
value: float
|
|
421
421
|
|
|
422
422
|
|
|
423
|
-
class
|
|
423
|
+
class Units20(Enum):
|
|
424
424
|
angstrom = "angstrom"
|
|
425
425
|
|
|
426
426
|
|
|
427
427
|
class ScalarSchema(BaseModel):
|
|
428
|
-
units: Optional[
|
|
428
|
+
units: Optional[Units20] = None
|
|
429
429
|
value: float
|
|
430
430
|
|
|
431
431
|
|
|
432
|
-
class
|
|
432
|
+
class Name33(Enum):
|
|
433
433
|
symmetry = "symmetry"
|
|
434
434
|
|
|
435
435
|
|
|
@@ -449,7 +449,7 @@ class SymmetrySchema(BaseModel):
|
|
|
449
449
|
name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
|
|
450
450
|
|
|
451
451
|
|
|
452
|
-
class
|
|
452
|
+
class Name34(Enum):
|
|
453
453
|
elemental_ratio = "elemental_ratio"
|
|
454
454
|
|
|
455
455
|
|
|
@@ -462,7 +462,7 @@ class ElementalRatio(BaseModel):
|
|
|
462
462
|
"""
|
|
463
463
|
|
|
464
464
|
|
|
465
|
-
class
|
|
465
|
+
class Name35(Enum):
|
|
466
466
|
p_norm = "p-norm"
|
|
467
467
|
|
|
468
468
|
|
|
@@ -475,7 +475,7 @@ class PNorm(BaseModel):
|
|
|
475
475
|
value: float
|
|
476
476
|
|
|
477
477
|
|
|
478
|
-
class
|
|
478
|
+
class Name36(Enum):
|
|
479
479
|
inchi = "inchi"
|
|
480
480
|
|
|
481
481
|
|
|
@@ -484,7 +484,7 @@ class InChIRepresentationSchema(BaseModel):
|
|
|
484
484
|
value: str
|
|
485
485
|
|
|
486
486
|
|
|
487
|
-
class
|
|
487
|
+
class Name37(Enum):
|
|
488
488
|
inchi_key = "inchi_key"
|
|
489
489
|
|
|
490
490
|
|
|
@@ -563,7 +563,7 @@ class FileSourceSchema(BaseModel):
|
|
|
563
563
|
"""
|
|
564
564
|
|
|
565
565
|
|
|
566
|
-
class
|
|
566
|
+
class Name38(Enum):
|
|
567
567
|
default = "default"
|
|
568
568
|
atomsTooClose = "atomsTooClose"
|
|
569
569
|
atomsOverlap = "atomsOverlap"
|
|
@@ -576,7 +576,7 @@ class Severity(Enum):
|
|
|
576
576
|
|
|
577
577
|
|
|
578
578
|
class MaterialConsistencyCheckSchema(BaseModel):
|
|
579
|
-
name:
|
|
579
|
+
name: Name38
|
|
580
580
|
"""
|
|
581
581
|
Name of the consistency check that is performed, which is listed in an enum.
|
|
582
582
|
"""
|
|
@@ -540,6 +540,10 @@ class TwoDimensionalDefectConfigurationSchema(BaseModel):
|
|
|
540
540
|
"""
|
|
541
541
|
The base host for the defect
|
|
542
542
|
"""
|
|
543
|
+
use_cartesian_coordinates: Optional[bool] = False
|
|
544
|
+
"""
|
|
545
|
+
Whether to use Cartesian coordinates
|
|
546
|
+
"""
|
|
543
547
|
isExternal: Optional[bool] = False
|
|
544
548
|
"""
|
|
545
549
|
Whether the defect is external to the host material
|