mat3ra-esse 2025.8.14.post0__py3-none-any.whl → 2025.10.8.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.

Files changed (136) hide show
  1. mat3ra/esse/data/examples.py +1 -1
  2. mat3ra/esse/data/schemas.py +1 -1
  3. mat3ra/esse/models/core/abstract/_2d_data.py +2 -2
  4. mat3ra/esse/models/core/abstract/_2d_plot.py +2 -6
  5. mat3ra/esse/models/core/primitive/_1d_data_series.py +3 -3
  6. mat3ra/esse/models/core/primitive/axis_3d_names_enum.py +13 -0
  7. mat3ra/esse/models/core/reference/__init__.py +8 -8
  8. mat3ra/esse/models/core/reference/exabyte.py +2 -8
  9. mat3ra/esse/models/core/reference/experiment/__init__.py +2 -2
  10. mat3ra/esse/models/core/reusable/coordinate_conditions/__init__.py +1 -78
  11. mat3ra/esse/models/core/reusable/coordinate_conditions/index.py +80 -0
  12. mat3ra/esse/models/core/reusable/hubbard_parameters.py +48 -0
  13. mat3ra/esse/models/core/reusable/kpoint.py +16 -0
  14. mat3ra/esse/models/core/reusable/repetition.py +14 -0
  15. mat3ra/esse/models/definitions/material.py +13 -0
  16. mat3ra/esse/models/element.py +10 -8
  17. mat3ra/esse/models/job/__init__.py +62 -62
  18. mat3ra/esse/models/material/__init__.py +12 -12
  19. mat3ra/esse/models/materials_category/compound_pristine_structures/two_dimensional/interface/configuration.py +80 -80
  20. mat3ra/esse/models/materials_category/defective_structures/one_dimensional/grain_boundary_linear/configuration.py +80 -80
  21. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/adatom/configuration.py +35 -35
  22. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/grain_boundary_planar/configuration.py +80 -80
  23. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/island/configuration.py +53 -53
  24. mat3ra/esse/models/materials_category/defective_structures/two_dimensional/terrace/configuration.py +53 -53
  25. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/interstitial.py +29 -29
  26. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/substitutional.py +32 -32
  27. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/vacancy.py +12 -12
  28. mat3ra/esse/models/materials_category/pristine_structures/three_dimensional/ideal_crystal.py +12 -12
  29. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanoribbon.py +52 -52
  30. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanotape.py +32 -32
  31. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab.py +32 -32
  32. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell.py +32 -32
  33. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell_with_gap.py +1151 -0
  34. mat3ra/esse/models/materials_category/processed_structures/two_dimensional/passivation/configuration.py +17 -17
  35. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/crystal_site.py +8 -8
  36. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/point_defect_site.py +12 -12
  37. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/void_region.py +12 -12
  38. mat3ra/esse/models/materials_category_components/entities/core/three_dimensional/crystal.py +8 -8
  39. mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/vacuum.py +12 -12
  40. mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines.py +8 -8
  41. mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated.py +8 -8
  42. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/crystal_lattice_base.py +8 -8
  43. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_non_uniform.py +12 -12
  44. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_uniform.py +12 -12
  45. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/supercell.py +12 -12
  46. mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/crystal_lattice_planes.py +8 -8
  47. mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_stack_configuration.py +52 -52
  48. mat3ra/esse/models/materials_category_components/operations/core/modifications/perturb.py +12 -12
  49. mat3ra/esse/models/methods_directory/physical/psp/__init__.py +2 -2
  50. mat3ra/esse/models/methods_directory/physical/psp/file.py +2 -2
  51. mat3ra/esse/models/methods_directory/physical/psp/file_data_item.py +2 -2
  52. mat3ra/esse/models/properties_directory/derived_properties.py +6 -6
  53. mat3ra/esse/models/properties_directory/elemental/atomic_radius.py +1 -1
  54. mat3ra/esse/models/properties_directory/elemental/electronegativity.py +1 -2
  55. mat3ra/esse/models/properties_directory/elemental/ionization_potential.py +3 -4
  56. mat3ra/esse/models/properties_directory/jupyter_notebook_endpoint.py +20 -0
  57. mat3ra/esse/models/properties_directory/non_scalar/average_potential_profile.py +4 -8
  58. mat3ra/esse/models/properties_directory/non_scalar/band_gaps.py +2 -2
  59. mat3ra/esse/models/properties_directory/non_scalar/band_structure.py +5 -9
  60. mat3ra/esse/models/properties_directory/non_scalar/charge_density_profile.py +4 -8
  61. mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +5 -8
  62. mat3ra/esse/models/properties_directory/non_scalar/dielectric_tensor.py +2 -2
  63. mat3ra/esse/models/properties_directory/non_scalar/file_content.py +2 -2
  64. mat3ra/esse/models/properties_directory/non_scalar/final_structure.py +22 -0
  65. mat3ra/esse/models/properties_directory/non_scalar/hubbard_u.py +4 -4
  66. mat3ra/esse/models/properties_directory/non_scalar/hubbard_v.py +3 -4
  67. mat3ra/esse/models/properties_directory/non_scalar/hubbard_v_nn.py +3 -4
  68. mat3ra/esse/models/properties_directory/non_scalar/is_relaxed.py +22 -0
  69. mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +10 -14
  70. mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +10 -14
  71. mat3ra/esse/models/properties_directory/non_scalar/potential_profile.py +8 -12
  72. mat3ra/esse/models/properties_directory/non_scalar/reaction_energy_profile.py +8 -12
  73. mat3ra/esse/models/properties_directory/non_scalar/stress_tensor.py +5 -7
  74. mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +64 -51
  75. mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +10 -14
  76. mat3ra/esse/models/properties_directory/non_scalar/workflow.py +2234 -0
  77. mat3ra/esse/models/properties_directory/reusable/hubbard_parameters.py +48 -0
  78. mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +1 -1
  79. mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +1 -1
  80. mat3ra/esse/models/properties_directory/scalar/formation_energy.py +1 -1
  81. mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +3 -3
  82. mat3ra/esse/models/properties_directory/scalar/pressure.py +3 -4
  83. mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +3 -3
  84. mat3ra/esse/models/properties_directory/scalar/surface_energy.py +3 -3
  85. mat3ra/esse/models/properties_directory/scalar/total_energy.py +3 -3
  86. mat3ra/esse/models/properties_directory/scalar/total_force.py +3 -4
  87. mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +3 -3
  88. mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +3 -3
  89. mat3ra/esse/models/properties_directory/structural/atomic_forces.py +5 -5
  90. mat3ra/esse/models/properties_directory/structural/basis/atomic_constraints_property.py +3 -3
  91. mat3ra/esse/models/properties_directory/structural/basis/boundary_conditions.py +30 -0
  92. mat3ra/esse/models/properties_directory/structural/basis/predicted_properties.py +82 -0
  93. mat3ra/esse/models/properties_directory/structural/lattice/units/__init__.py +23 -1
  94. mat3ra/esse/models/properties_directory/structural/magnetic_moments.py +5 -5
  95. mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +5 -5
  96. mat3ra/esse/models/properties_directory/structural/patterns/functional_group.py +1 -1
  97. mat3ra/esse/models/properties_directory/structural/patterns/ring.py +1 -1
  98. mat3ra/esse/models/properties_directory/structural/patterns/special_bond.py +1 -1
  99. mat3ra/esse/models/properties_directory/workflow/convergence/electronic.py +4 -4
  100. mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +6 -6
  101. mat3ra/esse/models/property/base.py +1492 -14
  102. mat3ra/esse/models/property/holder.py +3568 -0
  103. mat3ra/esse/models/property/meta_holder/Reusable_schema_for_energy_value_with_unit_corresponding_to_a_specific_accuracy_level__e/g.py +31 -0
  104. mat3ra/esse/models/property/meta_holder.py +140 -0
  105. mat3ra/esse/models/property/proto_holder.py +86 -0
  106. mat3ra/esse/models/property/raw.py +27 -11
  107. mat3ra/esse/models/property/source.py +24 -1
  108. mat3ra/esse/models/workflow/__init__.py +54 -54
  109. mat3ra/esse/models/workflow/base_flow.py +4 -4
  110. mat3ra/esse/models/workflow/subworkflow/__init__.py +7 -7
  111. mat3ra/esse/models/workflow/subworkflow/unit.py +10 -10
  112. mat3ra/esse/models/workflow/unit/__init__.py +12 -12
  113. mat3ra/esse/models/workflow/unit/io/__init__.py +4 -4
  114. mat3ra/esse/models/workflow/unit/io/db.py +2 -2
  115. mat3ra/esse/models/workflow/unit/io/object_storage.py +1 -1
  116. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/METADATA +1 -1
  117. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/RECORD +122 -118
  118. mat3ra/esse/models/property/meta.py +0 -200
  119. mat3ra/esse/models/software_directory/ml/exabyteml.py +0 -28
  120. mat3ra/esse/models/software_directory/ml/unit/execution/__init__.py +0 -879
  121. mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/__init__.py +0 -3
  122. mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/cross_validate.py +0 -293
  123. mat3ra/esse/models/software_directory/ml/unit/execution/initialize.py +0 -293
  124. mat3ra/esse/models/software_directory/ml/unit/execution/score.py +0 -286
  125. mat3ra/esse/models/software_directory/ml/unit/execution/train.py +0 -297
  126. mat3ra/esse/models/software_directory/ml/unit/processing/__init__.py +0 -276
  127. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/__init__.py +0 -167
  128. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/manipulation.py +0 -144
  129. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/scale_and_reduce.py +0 -163
  130. mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/__init__.py +0 -148
  131. mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/filter_based.py +0 -144
  132. /mat3ra/esse/models/{software_directory/ml → properties_directory/reusable}/__init__.py +0 -0
  133. /mat3ra/esse/models/{software_directory/ml/unit → property/meta_holder/Reusable_schema_for_energy_value_with_unit_corresponding_to_a_specific_accuracy_level__e}/__init__.py +0 -0
  134. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/WHEEL +0 -0
  135. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/licenses/LICENSE.md +0 -0
  136. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/top_level.txt +0 -0
@@ -419,7 +419,7 @@ class VolumeSchema(BaseModel):
419
419
  value: float
420
420
 
421
421
 
422
- class Name160(Enum):
422
+ class Name161(Enum):
423
423
  density = "density"
424
424
 
425
425
 
@@ -442,7 +442,7 @@ class ScalarSchema(BaseModel):
442
442
  value: float
443
443
 
444
444
 
445
- class Name161(Enum):
445
+ class Name162(Enum):
446
446
  symmetry = "symmetry"
447
447
 
448
448
 
@@ -462,7 +462,7 @@ class SymmetrySchema(BaseModel):
462
462
  name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
463
463
 
464
464
 
465
- class Name162(Enum):
465
+ class Name163(Enum):
466
466
  elemental_ratio = "elemental_ratio"
467
467
 
468
468
 
@@ -475,7 +475,7 @@ class ElementalRatio(BaseModel):
475
475
  """
476
476
 
477
477
 
478
- class Name163(Enum):
478
+ class Name164(Enum):
479
479
  p_norm = "p-norm"
480
480
 
481
481
 
@@ -488,7 +488,7 @@ class PNorm(BaseModel):
488
488
  value: float
489
489
 
490
490
 
491
- class Name164(Enum):
491
+ class Name165(Enum):
492
492
  inchi = "inchi"
493
493
 
494
494
 
@@ -497,7 +497,7 @@ class InChIRepresentationSchema(BaseModel):
497
497
  value: str
498
498
 
499
499
 
500
- class Name165(Enum):
500
+ class Name166(Enum):
501
501
  inchi_key = "inchi_key"
502
502
 
503
503
 
@@ -576,7 +576,7 @@ class FileSourceSchema(BaseModel):
576
576
  """
577
577
 
578
578
 
579
- class Name166(Enum):
579
+ class Name167(Enum):
580
580
  default = "default"
581
581
  atomsTooClose = "atomsTooClose"
582
582
  atomsOverlap = "atomsOverlap"
@@ -589,7 +589,7 @@ class Severity(Enum):
589
589
 
590
590
 
591
591
  class MaterialConsistencyCheckSchema(BaseModel):
592
- name: Name166
592
+ name: Name167
593
593
  """
594
594
  Name of the consistency check that is performed, which is listed in an enum.
595
595
  """
@@ -895,7 +895,7 @@ class LatticeSchema20(BaseModel):
895
895
  )
896
896
 
897
897
 
898
- class Name167(Enum):
898
+ class Name168(Enum):
899
899
  volume = "volume"
900
900
 
901
901
 
@@ -909,7 +909,7 @@ class VolumeSchema20(BaseModel):
909
909
  value: float
910
910
 
911
911
 
912
- class Name168(Enum):
912
+ class Name169(Enum):
913
913
  density = "density"
914
914
 
915
915
 
@@ -932,7 +932,7 @@ class ScalarSchema21(BaseModel):
932
932
  value: float
933
933
 
934
934
 
935
- class Name169(Enum):
935
+ class Name170(Enum):
936
936
  symmetry = "symmetry"
937
937
 
938
938
 
@@ -952,7 +952,7 @@ class SymmetrySchema20(BaseModel):
952
952
  name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
953
953
 
954
954
 
955
- class Name170(Enum):
955
+ class Name171(Enum):
956
956
  elemental_ratio = "elemental_ratio"
957
957
 
958
958
 
@@ -965,7 +965,7 @@ class ElementalRatio20(BaseModel):
965
965
  """
966
966
 
967
967
 
968
- class Name171(Enum):
968
+ class Name172(Enum):
969
969
  p_norm = "p-norm"
970
970
 
971
971
 
@@ -978,7 +978,7 @@ class PNorm20(BaseModel):
978
978
  value: float
979
979
 
980
980
 
981
- class Name172(Enum):
981
+ class Name173(Enum):
982
982
  inchi = "inchi"
983
983
 
984
984
 
@@ -987,7 +987,7 @@ class InChIRepresentationSchema20(BaseModel):
987
987
  value: str
988
988
 
989
989
 
990
- class Name173(Enum):
990
+ class Name174(Enum):
991
991
  inchi_key = "inchi_key"
992
992
 
993
993
 
@@ -1020,14 +1020,14 @@ class DerivedPropertiesSchema20(
1020
1020
  ] = Field(..., discriminator="name")
1021
1021
 
1022
1022
 
1023
- class Name174(Enum):
1023
+ class Name175(Enum):
1024
1024
  default = "default"
1025
1025
  atomsTooClose = "atomsTooClose"
1026
1026
  atomsOverlap = "atomsOverlap"
1027
1027
 
1028
1028
 
1029
1029
  class MaterialConsistencyCheckSchema20(BaseModel):
1030
- name: Name174
1030
+ name: Name175
1031
1031
  """
1032
1032
  Name of the consistency check that is performed, which is listed in an enum.
1033
1033
  """
@@ -1344,7 +1344,7 @@ class LatticeSchema21(BaseModel):
1344
1344
  )
1345
1345
 
1346
1346
 
1347
- class Name175(Enum):
1347
+ class Name176(Enum):
1348
1348
  volume = "volume"
1349
1349
 
1350
1350
 
@@ -1358,7 +1358,7 @@ class VolumeSchema21(BaseModel):
1358
1358
  value: float
1359
1359
 
1360
1360
 
1361
- class Name176(Enum):
1361
+ class Name177(Enum):
1362
1362
  density = "density"
1363
1363
 
1364
1364
 
@@ -1381,7 +1381,7 @@ class ScalarSchema22(BaseModel):
1381
1381
  value: float
1382
1382
 
1383
1383
 
1384
- class Name177(Enum):
1384
+ class Name178(Enum):
1385
1385
  symmetry = "symmetry"
1386
1386
 
1387
1387
 
@@ -1401,7 +1401,7 @@ class SymmetrySchema21(BaseModel):
1401
1401
  name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
1402
1402
 
1403
1403
 
1404
- class Name178(Enum):
1404
+ class Name179(Enum):
1405
1405
  elemental_ratio = "elemental_ratio"
1406
1406
 
1407
1407
 
@@ -1414,7 +1414,7 @@ class ElementalRatio21(BaseModel):
1414
1414
  """
1415
1415
 
1416
1416
 
1417
- class Name179(Enum):
1417
+ class Name180(Enum):
1418
1418
  p_norm = "p-norm"
1419
1419
 
1420
1420
 
@@ -1427,7 +1427,7 @@ class PNorm21(BaseModel):
1427
1427
  value: float
1428
1428
 
1429
1429
 
1430
- class Name180(Enum):
1430
+ class Name181(Enum):
1431
1431
  inchi = "inchi"
1432
1432
 
1433
1433
 
@@ -1436,7 +1436,7 @@ class InChIRepresentationSchema21(BaseModel):
1436
1436
  value: str
1437
1437
 
1438
1438
 
1439
- class Name181(Enum):
1439
+ class Name182(Enum):
1440
1440
  inchi_key = "inchi_key"
1441
1441
 
1442
1442
 
@@ -1469,14 +1469,14 @@ class DerivedPropertiesSchema21(
1469
1469
  ] = Field(..., discriminator="name")
1470
1470
 
1471
1471
 
1472
- class Name182(Enum):
1472
+ class Name183(Enum):
1473
1473
  default = "default"
1474
1474
  atomsTooClose = "atomsTooClose"
1475
1475
  atomsOverlap = "atomsOverlap"
1476
1476
 
1477
1477
 
1478
1478
  class MaterialConsistencyCheckSchema21(BaseModel):
1479
- name: Name182
1479
+ name: Name183
1480
1480
  """
1481
1481
  Name of the consistency check that is performed, which is listed in an enum.
1482
1482
  """
@@ -1899,7 +1899,7 @@ class LatticeSchema22(BaseModel):
1899
1899
  )
1900
1900
 
1901
1901
 
1902
- class Name183(Enum):
1902
+ class Name184(Enum):
1903
1903
  volume = "volume"
1904
1904
 
1905
1905
 
@@ -1913,7 +1913,7 @@ class VolumeSchema22(BaseModel):
1913
1913
  value: float
1914
1914
 
1915
1915
 
1916
- class Name184(Enum):
1916
+ class Name185(Enum):
1917
1917
  density = "density"
1918
1918
 
1919
1919
 
@@ -1936,7 +1936,7 @@ class ScalarSchema23(BaseModel):
1936
1936
  value: float
1937
1937
 
1938
1938
 
1939
- class Name185(Enum):
1939
+ class Name186(Enum):
1940
1940
  symmetry = "symmetry"
1941
1941
 
1942
1942
 
@@ -1956,7 +1956,7 @@ class SymmetrySchema22(BaseModel):
1956
1956
  name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
1957
1957
 
1958
1958
 
1959
- class Name186(Enum):
1959
+ class Name187(Enum):
1960
1960
  elemental_ratio = "elemental_ratio"
1961
1961
 
1962
1962
 
@@ -1969,7 +1969,7 @@ class ElementalRatio22(BaseModel):
1969
1969
  """
1970
1970
 
1971
1971
 
1972
- class Name187(Enum):
1972
+ class Name188(Enum):
1973
1973
  p_norm = "p-norm"
1974
1974
 
1975
1975
 
@@ -1982,7 +1982,7 @@ class PNorm22(BaseModel):
1982
1982
  value: float
1983
1983
 
1984
1984
 
1985
- class Name188(Enum):
1985
+ class Name189(Enum):
1986
1986
  inchi = "inchi"
1987
1987
 
1988
1988
 
@@ -1991,7 +1991,7 @@ class InChIRepresentationSchema22(BaseModel):
1991
1991
  value: str
1992
1992
 
1993
1993
 
1994
- class Name189(Enum):
1994
+ class Name190(Enum):
1995
1995
  inchi_key = "inchi_key"
1996
1996
 
1997
1997
 
@@ -2024,14 +2024,14 @@ class DerivedPropertiesSchema22(
2024
2024
  ] = Field(..., discriminator="name")
2025
2025
 
2026
2026
 
2027
- class Name190(Enum):
2027
+ class Name191(Enum):
2028
2028
  default = "default"
2029
2029
  atomsTooClose = "atomsTooClose"
2030
2030
  atomsOverlap = "atomsOverlap"
2031
2031
 
2032
2032
 
2033
2033
  class MaterialConsistencyCheckSchema22(BaseModel):
2034
- name: Name190
2034
+ name: Name191
2035
2035
  """
2036
2036
  Name of the consistency check that is performed, which is listed in an enum.
2037
2037
  """