mat3ra-esse 2025.7.29.post0__py3-none-any.whl → 2025.8.6.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 (65) 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/element.py +6 -6
  6. mat3ra/esse/models/material/__init__.py +14 -14
  7. mat3ra/esse/models/materials_category/compound_pristine_structures/two_dimensional/interface/configuration.py +549 -2319
  8. mat3ra/esse/models/materials_category/defective_structures/one_dimensional/grain_boundary_linear/configuration.py +537 -2307
  9. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/adatom/configuration.py +206 -190
  10. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/grain_boundary_planar/configuration.py +56 -1826
  11. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/island/configuration.py +331 -311
  12. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/terrace/configuration.py +331 -311
  13. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/interstitial.py +72 -72
  14. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/substitutional.py +72 -72
  15. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/vacancy.py +14 -14
  16. mat3ra/esse/models/materials_category/pristine_structures/three_dimensional/ideal_crystal.py +14 -14
  17. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanoribbon.py +150 -134
  18. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanotape.py +86 -74
  19. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab.py +84 -72
  20. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell.py +84 -72
  21. mat3ra/esse/models/materials_category/processed_structures/two_dimensional/passivation/configuration.py +70 -70
  22. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/crystal_site.py +14 -14
  23. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/point_defect_site.py +14 -14
  24. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/void_region.py +14 -14
  25. mat3ra/esse/models/materials_category_components/entities/core/three_dimensional/crystal.py +14 -14
  26. mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/vacuum.py +14 -14
  27. mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines.py +14 -14
  28. mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated.py +16 -16
  29. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/crystal_lattice_base.py +14 -14
  30. mat3ra/esse/models/materials_category_components/entities/reusable/{repetitions.py → three_dimensional/repetitions.py} +1 -1
  31. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_non_uniform.py +14 -14
  32. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_uniform.py +14 -14
  33. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/supercell.py +14 -14
  34. mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/crystal_lattice_planes.py +14 -14
  35. mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_stack_configuration.py +148 -132
  36. mat3ra/esse/models/materials_category_components/operations/core/combinations/stack.py +14 -2
  37. mat3ra/esse/models/materials_category_components/operations/core/modifications/perturb.py +14 -14
  38. mat3ra/esse/models/properties_directory/derived_properties.py +11 -11
  39. mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +2 -2
  40. mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +2 -2
  41. mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +2 -2
  42. mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +50 -50
  43. mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +2 -2
  44. mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +2 -2
  45. mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +2 -2
  46. mat3ra/esse/models/properties_directory/scalar/formation_energy.py +2 -2
  47. mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +2 -2
  48. mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +2 -2
  49. mat3ra/esse/models/properties_directory/scalar/surface_energy.py +2 -2
  50. mat3ra/esse/models/properties_directory/scalar/total_energy.py +2 -2
  51. mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +2 -2
  52. mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +2 -2
  53. mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +4 -4
  54. mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +2 -2
  55. mat3ra/esse/models/software/template.py +4 -0
  56. mat3ra/esse/models/software_directory/modeling/unit/execution.py +4 -0
  57. mat3ra/esse/models/software_directory/scripting/unit/execution.py +4 -0
  58. mat3ra/esse/models/workflow/unit/input/_input.py +4 -0
  59. mat3ra/esse/models/workflow/unit/input/_inputItem.py +4 -0
  60. {mat3ra_esse-2025.7.29.post0.dist-info → mat3ra_esse-2025.8.6.post1.dist-info}/METADATA +1 -1
  61. {mat3ra_esse-2025.7.29.post0.dist-info → mat3ra_esse-2025.8.6.post1.dist-info}/RECORD +64 -65
  62. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell_with_gap.py +0 -1151
  63. {mat3ra_esse-2025.7.29.post0.dist-info → mat3ra_esse-2025.8.6.post1.dist-info}/WHEEL +0 -0
  64. {mat3ra_esse-2025.7.29.post0.dist-info → mat3ra_esse-2025.8.6.post1.dist-info}/licenses/LICENSE.md +0 -0
  65. {mat3ra_esse-2025.7.29.post0.dist-info → mat3ra_esse-2025.8.6.post1.dist-info}/top_level.txt +0 -0
@@ -131,13 +131,13 @@ class Value(Enum):
131
131
  Og = "Og"
132
132
 
133
133
 
134
- class Value146(Enum):
134
+ class Value122(Enum):
135
135
  X = "X"
136
136
  Vac = "Vac"
137
137
 
138
138
 
139
139
  class AtomicElementSchema(BaseModel):
140
- value: Union[Value, Value146]
140
+ value: Union[Value, Value122]
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 Name584(Enum):
288
+ class Name488(Enum):
289
289
  density = "density"
290
290
 
291
291
 
292
- class Units234(Enum):
292
+ class Units198(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[Units234] = None
298
+ units: Optional[Units198] = None
299
299
  value: float
300
300
 
301
301
 
302
- class Units235(Enum):
302
+ class Units199(Enum):
303
303
  angstrom = "angstrom"
304
304
 
305
305
 
306
306
  class ScalarSchema(BaseModel):
307
- units: Optional[Units235] = None
307
+ units: Optional[Units199] = None
308
308
  value: float
309
309
 
310
310
 
311
- class Name585(Enum):
311
+ class Name489(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 Name586(Enum):
331
+ class Name490(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 Name587(Enum):
344
+ class Name491(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 Name588(Enum):
357
+ class Name492(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 Name589(Enum):
366
+ class Name493(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 Name590(Enum):
445
+ class Name494(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: Name590
458
+ name: Name494
459
459
  """
460
460
  Name of the consistency check that is performed, which is listed in an enum.
461
461
  """
@@ -530,7 +530,7 @@ class CrystalSchema(BaseModel):
530
530
  metadata: Optional[Dict[str, Any]] = None
531
531
 
532
532
 
533
- class Value147(Enum):
533
+ class Value123(Enum):
534
534
  H = "H"
535
535
  He = "He"
536
536
  Li = "Li"
@@ -651,13 +651,13 @@ class Value147(Enum):
651
651
  Og = "Og"
652
652
 
653
653
 
654
- class Value148(Enum):
654
+ class Value124(Enum):
655
655
  X = "X"
656
656
  Vac = "Vac"
657
657
 
658
658
 
659
- class AtomicElementSchema72(BaseModel):
660
- value: Union[Value147, Value148]
659
+ class AtomicElementSchema60(BaseModel):
660
+ value: Union[Value123, Value124]
661
661
  """
662
662
  All elements, including extra elements
663
663
  """
@@ -667,8 +667,8 @@ class AtomicElementSchema72(BaseModel):
667
667
  """
668
668
 
669
669
 
670
- class BasisSchema70(BaseModel):
671
- elements: List[AtomicElementSchema72] = Field(..., title="atomic elements schema")
670
+ class BasisSchema58(BaseModel):
671
+ elements: List[AtomicElementSchema60] = Field(..., title="atomic elements schema")
672
672
  """
673
673
  atomic elements schema
674
674
  """
@@ -683,7 +683,7 @@ class BasisSchema70(BaseModel):
683
683
  """
684
684
 
685
685
 
686
- class LatticeVectorsSchema69(BaseModel):
686
+ class LatticeVectorsSchema57(BaseModel):
687
687
  a: List[float] = Field(..., max_length=3, min_length=3, title="vector 3d schema")
688
688
  b: List[float] = Field(..., max_length=3, min_length=3, title="vector 3d schema")
689
689
  c: List[float] = Field(..., max_length=3, min_length=3, title="vector 3d schema")
@@ -694,12 +694,12 @@ class LatticeVectorsSchema69(BaseModel):
694
694
  units: Optional[LatticeVectorsUnitsEnum] = Field("angstrom", title="lattice vectors units enum")
695
695
 
696
696
 
697
- class LatticeUnitsSchema69(BaseModel):
697
+ class LatticeUnitsSchema57(BaseModel):
698
698
  length: Optional[LatticeUnitsLengthEnum] = Field("angstrom", title="lattice units length enum")
699
699
  angle: Optional[LatticeUnitsAngleEnum] = Field("degree", title="lattice units angle enum")
700
700
 
701
701
 
702
- class LatticeSchema69(BaseModel):
702
+ class LatticeSchema57(BaseModel):
703
703
  a: float
704
704
  """
705
705
  length of the first lattice vector
@@ -724,56 +724,56 @@ class LatticeSchema69(BaseModel):
724
724
  """
725
725
  angle between first and third lattice vector
726
726
  """
727
- vectors: Optional[LatticeVectorsSchema69] = Field(None, title="lattice vectors schema")
727
+ vectors: Optional[LatticeVectorsSchema57] = Field(None, title="lattice vectors schema")
728
728
  type: Optional[LatticeTypeEnum] = Field("TRI", title="lattice type enum")
729
- units: Optional[LatticeUnitsSchema69] = Field(
730
- default_factory=lambda: LatticeUnitsSchema69.model_validate({"length": "angstrom", "angle": "degree"}),
729
+ units: Optional[LatticeUnitsSchema57] = Field(
730
+ default_factory=lambda: LatticeUnitsSchema57.model_validate({"length": "angstrom", "angle": "degree"}),
731
731
  title="Lattice units schema",
732
732
  )
733
733
 
734
734
 
735
- class Name591(Enum):
735
+ class Name495(Enum):
736
736
  volume = "volume"
737
737
 
738
738
 
739
- class Units236(Enum):
739
+ class Units200(Enum):
740
740
  angstrom_3 = "angstrom^3"
741
741
 
742
742
 
743
- class VolumeSchema70(BaseModel):
743
+ class VolumeSchema58(BaseModel):
744
744
  name: Literal["0#-datamodel-code-generator-#-object-#-special-#"]
745
- units: Optional[Units236] = None
745
+ units: Optional[Units200] = None
746
746
  value: float
747
747
 
748
748
 
749
- class Name592(Enum):
749
+ class Name496(Enum):
750
750
  density = "density"
751
751
 
752
752
 
753
- class Units237(Enum):
753
+ class Units201(Enum):
754
754
  g_cm_3 = "g/cm^3"
755
755
 
756
756
 
757
- class DensitySchema71(BaseModel):
757
+ class DensitySchema59(BaseModel):
758
758
  name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
759
- units: Optional[Units237] = None
759
+ units: Optional[Units201] = None
760
760
  value: float
761
761
 
762
762
 
763
- class Units238(Enum):
763
+ class Units202(Enum):
764
764
  angstrom = "angstrom"
765
765
 
766
766
 
767
- class ScalarSchema71(BaseModel):
768
- units: Optional[Units238] = None
767
+ class ScalarSchema59(BaseModel):
768
+ units: Optional[Units202] = None
769
769
  value: float
770
770
 
771
771
 
772
- class Name593(Enum):
772
+ class Name497(Enum):
773
773
  symmetry = "symmetry"
774
774
 
775
775
 
776
- class SymmetrySchema70(BaseModel):
776
+ class SymmetrySchema58(BaseModel):
777
777
  pointGroupSymbol: Optional[str] = None
778
778
  """
779
779
  point group symbol in Schoenflies notation
@@ -782,18 +782,18 @@ class SymmetrySchema70(BaseModel):
782
782
  """
783
783
  space group symbol in Hermann–Mauguin notation
784
784
  """
785
- tolerance: Optional[ScalarSchema71] = Field(None, title="scalar schema")
785
+ tolerance: Optional[ScalarSchema59] = Field(None, title="scalar schema")
786
786
  """
787
787
  tolerance used for symmetry calculation
788
788
  """
789
789
  name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
790
790
 
791
791
 
792
- class Name594(Enum):
792
+ class Name498(Enum):
793
793
  elemental_ratio = "elemental_ratio"
794
794
 
795
795
 
796
- class ElementalRatio71(BaseModel):
796
+ class ElementalRatio59(BaseModel):
797
797
  name: Literal["3#-datamodel-code-generator-#-object-#-special-#"]
798
798
  value: confloat(ge=0.0, le=1.0)
799
799
  element: Optional[str] = None
@@ -802,11 +802,11 @@ class ElementalRatio71(BaseModel):
802
802
  """
803
803
 
804
804
 
805
- class Name595(Enum):
805
+ class Name499(Enum):
806
806
  p_norm = "p-norm"
807
807
 
808
808
 
809
- class PNorm70(BaseModel):
809
+ class PNorm58(BaseModel):
810
810
  name: Literal["4#-datamodel-code-generator-#-object-#-special-#"]
811
811
  degree: Optional[int] = None
812
812
  """
@@ -815,56 +815,56 @@ class PNorm70(BaseModel):
815
815
  value: float
816
816
 
817
817
 
818
- class Name596(Enum):
818
+ class Name500(Enum):
819
819
  inchi = "inchi"
820
820
 
821
821
 
822
- class InChIRepresentationSchema71(BaseModel):
822
+ class InChIRepresentationSchema59(BaseModel):
823
823
  name: Literal["5#-datamodel-code-generator-#-object-#-special-#"]
824
824
  value: str
825
825
 
826
826
 
827
- class Name597(Enum):
827
+ class Name501(Enum):
828
828
  inchi_key = "inchi_key"
829
829
 
830
830
 
831
- class InChIKeyRepresentationSchema71(BaseModel):
831
+ class InChIKeyRepresentationSchema59(BaseModel):
832
832
  name: Literal["6#-datamodel-code-generator-#-object-#-special-#"]
833
833
  value: str
834
834
 
835
835
 
836
- class DerivedPropertiesSchema71(
836
+ class DerivedPropertiesSchema59(
837
837
  RootModel[
838
838
  Union[
839
- VolumeSchema70,
840
- DensitySchema71,
841
- SymmetrySchema70,
842
- ElementalRatio71,
843
- PNorm70,
844
- InChIRepresentationSchema71,
845
- InChIKeyRepresentationSchema71,
839
+ VolumeSchema58,
840
+ DensitySchema59,
841
+ SymmetrySchema58,
842
+ ElementalRatio59,
843
+ PNorm58,
844
+ InChIRepresentationSchema59,
845
+ InChIKeyRepresentationSchema59,
846
846
  ]
847
847
  ]
848
848
  ):
849
849
  root: Union[
850
- VolumeSchema70,
851
- DensitySchema71,
852
- SymmetrySchema70,
853
- ElementalRatio71,
854
- PNorm70,
855
- InChIRepresentationSchema71,
856
- InChIKeyRepresentationSchema71,
850
+ VolumeSchema58,
851
+ DensitySchema59,
852
+ SymmetrySchema58,
853
+ ElementalRatio59,
854
+ PNorm58,
855
+ InChIRepresentationSchema59,
856
+ InChIKeyRepresentationSchema59,
857
857
  ] = Field(..., discriminator="name")
858
858
 
859
859
 
860
- class Name598(Enum):
860
+ class Name502(Enum):
861
861
  default = "default"
862
862
  atomsTooClose = "atomsTooClose"
863
863
  atomsOverlap = "atomsOverlap"
864
864
 
865
865
 
866
- class MaterialConsistencyCheckSchema70(BaseModel):
867
- name: Name598
866
+ class MaterialConsistencyCheckSchema58(BaseModel):
867
+ name: Name502
868
868
  """
869
869
  Name of the consistency check that is performed, which is listed in an enum.
870
870
  """
@@ -882,7 +882,7 @@ class MaterialConsistencyCheckSchema70(BaseModel):
882
882
  """
883
883
 
884
884
 
885
- class CrystalSchema67(BaseModel):
885
+ class CrystalSchema55(BaseModel):
886
886
  formula: Optional[str] = None
887
887
  """
888
888
  reduced chemical formula
@@ -891,9 +891,9 @@ class CrystalSchema67(BaseModel):
891
891
  """
892
892
  chemical formula based on the number of atoms of each element in the supercell
893
893
  """
894
- basis: BasisSchema70 = Field(..., title="basis schema")
895
- lattice: LatticeSchema69 = Field(..., title="lattice schema")
896
- derivedProperties: Optional[List[DerivedPropertiesSchema71]] = Field(None, title="derived properties schema")
894
+ basis: BasisSchema58 = Field(..., title="basis schema")
895
+ lattice: LatticeSchema57 = Field(..., title="lattice schema")
896
+ derivedProperties: Optional[List[DerivedPropertiesSchema59]] = Field(None, title="derived properties schema")
897
897
  external: Optional[DatabaseSourceSchema] = Field(None, title="database source schema")
898
898
  """
899
899
  information about a database source
@@ -914,7 +914,7 @@ class CrystalSchema67(BaseModel):
914
914
  """
915
915
  Whether to work in the finite molecular picture (usually with atomic orbital basis)
916
916
  """
917
- consistencyChecks: Optional[List[MaterialConsistencyCheckSchema70]] = None
917
+ consistencyChecks: Optional[List[MaterialConsistencyCheckSchema58]] = None
918
918
  field_id: Optional[str] = Field(None, alias="_id")
919
919
  """
920
920
  entity identity
@@ -1077,7 +1077,7 @@ class VacancySchema(BaseModel):
1077
1077
 
1078
1078
 
1079
1079
  class PointDefectSiteSchema(BaseModel):
1080
- crystal: CrystalSchema67 = Field(..., title="Crystal Schema")
1080
+ crystal: CrystalSchema55 = Field(..., title="Crystal Schema")
1081
1081
  """
1082
1082
  A crystal structure, referencing the base material schema
1083
1083
  """