mat3ra-esse 2025.5.16.post1__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.

Files changed (52) hide show
  1. mat3ra/esse/data/examples.py +1 -1
  2. mat3ra/esse/data/schemas.py +1 -1
  3. mat3ra/esse/models/apse/file/applications/espresso/7.2/pw_x.py +6 -6
  4. mat3ra/esse/models/core/reusable/energy.py +2 -2
  5. mat3ra/esse/models/definitions/chemical_elements.py +13 -0
  6. mat3ra/esse/models/definitions/materials.py +13 -0
  7. mat3ra/esse/models/element.py +6 -6
  8. mat3ra/esse/models/material/__init__.py +14 -14
  9. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/__init__.py +3 -0
  10. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/adatom/__init__.py +3 -0
  11. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/adatom/configuration.py +672 -0
  12. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/configuration.py +550 -0
  13. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/layered/__init__.py +3 -0
  14. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/layered/configuration.py +549 -0
  15. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/point/__init__.py +3 -0
  16. mat3ra/esse/models/materials_category/defects/by_host/two_dimensional/point/configuration.py +550 -0
  17. mat3ra/esse/models/materials_category/defects/configuration.py +8 -1
  18. mat3ra/esse/models/materials_category/defects/one_dimensional/terrace/configuration.py +157 -19
  19. mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/__init__.py +3 -0
  20. mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/pair/__init__.py +3 -0
  21. mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/pair/configuration.py +1538 -0
  22. mat3ra/esse/models/materials_category/defects/zero_dimensional/complex/pair.py +1534 -0
  23. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/configuration.py +23 -23
  24. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/interstitial/__init__.py +3 -0
  25. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/interstitial/configuration.py +672 -0
  26. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/substitution/__init__.py +3 -0
  27. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/substitution/configuration.py +672 -0
  28. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/vacancy/__init__.py +3 -0
  29. mat3ra/esse/models/materials_category/defects/zero_dimensional/point/vacancy/configuration.py +672 -0
  30. mat3ra/esse/models/materials_category/single_material/two_dimensional/slab/configuration.py +14 -14
  31. mat3ra/esse/models/properties_directory/derived_properties.py +11 -11
  32. mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +2 -2
  33. mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +2 -2
  34. mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +2 -2
  35. mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +50 -50
  36. mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +2 -2
  37. mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +2 -2
  38. mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +2 -2
  39. mat3ra/esse/models/properties_directory/scalar/formation_energy.py +2 -2
  40. mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +2 -2
  41. mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +2 -2
  42. mat3ra/esse/models/properties_directory/scalar/surface_energy.py +2 -2
  43. mat3ra/esse/models/properties_directory/scalar/total_energy.py +2 -2
  44. mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +2 -2
  45. mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +2 -2
  46. mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +4 -4
  47. mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +2 -2
  48. {mat3ra_esse-2025.5.16.post1.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/METADATA +1 -1
  49. {mat3ra_esse-2025.5.16.post1.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/RECORD +52 -32
  50. {mat3ra_esse-2025.5.16.post1.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/WHEEL +0 -0
  51. {mat3ra_esse-2025.5.16.post1.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/licenses/LICENSE.md +0 -0
  52. {mat3ra_esse-2025.5.16.post1.dist-info → mat3ra_esse-2025.5.17.post1.dist-info}/top_level.txt +0 -0
@@ -10,12 +10,6 @@ from typing import Any, Dict, List, Literal, Optional, Union
10
10
  from pydantic import BaseModel, Field, RootModel, confloat, conint
11
11
 
12
12
 
13
- class PointDefectTypeEnum(Enum):
14
- vacancy = "vacancy"
15
- substitution = "substitution"
16
- interstitial = "interstitial"
17
-
18
-
19
13
  class ChemicalElement(Enum):
20
14
  H = "H"
21
15
  He = "He"
@@ -258,13 +252,13 @@ class Value(Enum):
258
252
  Og = "Og"
259
253
 
260
254
 
261
- class Value11(Enum):
255
+ class Value23(Enum):
262
256
  X = "X"
263
257
  Vac = "Vac"
264
258
 
265
259
 
266
260
  class AtomicElementSchema(BaseModel):
267
- value: Union[Value, Value11]
261
+ value: Union[Value, Value23]
268
262
  """
269
263
  All elements, including extra elements
270
264
  """
@@ -412,30 +406,30 @@ class VolumeSchema(BaseModel):
412
406
  value: float
413
407
 
414
408
 
415
- class Name16(Enum):
409
+ class Name64(Enum):
416
410
  density = "density"
417
411
 
418
412
 
419
- class Units13(Enum):
413
+ class Units31(Enum):
420
414
  g_cm_3 = "g/cm^3"
421
415
 
422
416
 
423
417
  class DensitySchema(BaseModel):
424
418
  name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
425
- units: Optional[Units13] = None
419
+ units: Optional[Units31] = None
426
420
  value: float
427
421
 
428
422
 
429
- class Units14(Enum):
423
+ class Units32(Enum):
430
424
  angstrom = "angstrom"
431
425
 
432
426
 
433
427
  class ScalarSchema(BaseModel):
434
- units: Optional[Units14] = None
428
+ units: Optional[Units32] = None
435
429
  value: float
436
430
 
437
431
 
438
- class Name17(Enum):
432
+ class Name65(Enum):
439
433
  symmetry = "symmetry"
440
434
 
441
435
 
@@ -455,7 +449,7 @@ class SymmetrySchema(BaseModel):
455
449
  name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
456
450
 
457
451
 
458
- class Name18(Enum):
452
+ class Name66(Enum):
459
453
  elemental_ratio = "elemental_ratio"
460
454
 
461
455
 
@@ -468,7 +462,7 @@ class ElementalRatio(BaseModel):
468
462
  """
469
463
 
470
464
 
471
- class Name19(Enum):
465
+ class Name67(Enum):
472
466
  p_norm = "p-norm"
473
467
 
474
468
 
@@ -481,7 +475,7 @@ class PNorm(BaseModel):
481
475
  value: float
482
476
 
483
477
 
484
- class Name20(Enum):
478
+ class Name68(Enum):
485
479
  inchi = "inchi"
486
480
 
487
481
 
@@ -490,7 +484,7 @@ class InChIRepresentationSchema(BaseModel):
490
484
  value: str
491
485
 
492
486
 
493
- class Name21(Enum):
487
+ class Name69(Enum):
494
488
  inchi_key = "inchi_key"
495
489
 
496
490
 
@@ -569,7 +563,7 @@ class FileSourceSchema(BaseModel):
569
563
  """
570
564
 
571
565
 
572
- class Name22(Enum):
566
+ class Name70(Enum):
573
567
  default = "default"
574
568
  atomsTooClose = "atomsTooClose"
575
569
  atomsOverlap = "atomsOverlap"
@@ -582,7 +576,7 @@ class Severity(Enum):
582
576
 
583
577
 
584
578
  class MaterialConsistencyCheckSchema(BaseModel):
585
- name: Name22
579
+ name: Name70
586
580
  """
587
581
  Name of the consistency check that is performed, which is listed in an enum.
588
582
  """
@@ -658,14 +652,20 @@ class MaterialSchema(BaseModel):
658
652
 
659
653
 
660
654
  class PointDefectConfigurationSchema(BaseModel):
661
- type: Optional[PointDefectTypeEnum] = Field(None, title="Point Defect Type Enum")
662
- coordinate: Optional[List[float]] = Field(None, max_length=3, min_length=3, title="coordinate 3d schema")
655
+ type: str
656
+ """
657
+ The type of point defect
658
+ """
659
+ coordinate: List[float] = Field(..., max_length=3, min_length=3, title="coordinate 3d schema")
663
660
  chemical_element: Optional[ChemicalElement] = None
664
661
  use_cartesian_coordinates: Optional[bool] = False
665
662
  """
666
663
  Whether coordinates are in cartesian rather than fractional coordinates
667
664
  """
668
- host: MaterialSchema = Field(..., title="material schema")
665
+ host: Optional[MaterialSchema] = None
666
+ """
667
+ The base host for the defect
668
+ """
669
669
  isExternal: Optional[bool] = False
670
670
  """
671
671
  Whether the defect is external to the host material
@@ -0,0 +1,3 @@
1
+ # generated by datamodel-codegen:
2
+ # filename: schema
3
+ # version: 0.28.5