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
@@ -54,7 +54,7 @@ class DataIODatabaseInputOutputSchema(BaseModel):
54
54
  """
55
55
 
56
56
 
57
- class DataIODatabaseInputOutputSchema15(BaseModel):
57
+ class DataIODatabaseInputOutputSchema19(BaseModel):
58
58
  model_config = ConfigDict(
59
59
  extra="allow",
60
60
  )
@@ -62,7 +62,7 @@ class DataIODatabaseInputOutputSchema15(BaseModel):
62
62
  """
63
63
  db collection name
64
64
  """
65
- draft: Optional[bool] = True
65
+ draft: bool
66
66
  """
67
67
  whether the result should be saved as draft
68
68
  """
@@ -100,7 +100,7 @@ class ObjectStorageIoSchema(BaseModel):
100
100
  extra="allow",
101
101
  )
102
102
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
103
- overwrite: Optional[bool] = False
103
+ overwrite: Optional[bool] = None
104
104
  """
105
105
  if a file with the same filename already exists, whether to overwrite the old file
106
106
  """
@@ -152,7 +152,7 @@ class DataIOUnitSchema(BaseModel):
152
152
  input: List[
153
153
  Union[
154
154
  DataIORestAPIInputSchema,
155
- Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema15],
155
+ Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema19],
156
156
  ObjectStorageIoSchema,
157
157
  ]
158
158
  ]
@@ -222,7 +222,7 @@ class DataIOUnitSchema(BaseModel):
222
222
  statusTrack: Optional[List[StatusTrackItem]] = None
223
223
 
224
224
 
225
- class Type107(Enum):
225
+ class Type106(Enum):
226
226
  reduce = "reduce"
227
227
 
228
228
 
@@ -319,7 +319,7 @@ class ReduceUnitSchema(BaseModel):
319
319
  statusTrack: Optional[List[StatusTrackItem]] = None
320
320
 
321
321
 
322
- class Type108(Enum):
322
+ class Type107(Enum):
323
323
  condition = "condition"
324
324
 
325
325
 
@@ -432,7 +432,7 @@ class ConditionUnitSchema(BaseModel):
432
432
  statusTrack: Optional[List[StatusTrackItem]] = None
433
433
 
434
434
 
435
- class Type109(Enum):
435
+ class Type108(Enum):
436
436
  assertion = "assertion"
437
437
 
438
438
 
@@ -518,7 +518,7 @@ class AssertionUnitSchema(BaseModel):
518
518
  statusTrack: Optional[List[StatusTrackItem]] = None
519
519
 
520
520
 
521
- class Type110(Enum):
521
+ class Type109(Enum):
522
522
  execution = "execution"
523
523
 
524
524
 
@@ -773,7 +773,7 @@ class ExecutionUnitSchemaBase(BaseModel):
773
773
  statusTrack: Optional[List[StatusTrackItem]] = None
774
774
 
775
775
 
776
- class Type111(Enum):
776
+ class Type110(Enum):
777
777
  assignment = "assignment"
778
778
 
779
779
 
@@ -864,7 +864,7 @@ class AssignmentUnitSchema(BaseModel):
864
864
  scope: Optional[str] = None
865
865
 
866
866
 
867
- class Type112(Enum):
867
+ class Type111(Enum):
868
868
  processing = "processing"
869
869
 
870
870
 
@@ -1182,21 +1182,21 @@ class Subworkflow(BaseModel):
1182
1182
  """
1183
1183
  Human-readable name of the subworkflow. e.g. Total-energy
1184
1184
  """
1185
- properties: Optional[List[Union[str, Dict[str, Any]]]] = None
1185
+ properties: Optional[List[str]] = None
1186
1186
  """
1187
1187
  Array of characteristic properties calculated by this subworkflow
1188
1188
  """
1189
- compute: Optional[ComputeArgumentsSchema] = None
1189
+ compute: Optional[ComputeArgumentsSchema] = Field(None, title="compute arguments schema")
1190
1190
  """
1191
- compute parameters
1191
+ Custom keywords prefixed with validate correspond to custom validation methods implemented downstream
1192
1192
  """
1193
1193
 
1194
1194
 
1195
- class Type113(Enum):
1195
+ class Type112(Enum):
1196
1196
  io = "io"
1197
1197
 
1198
1198
 
1199
- class DataIODatabaseInputOutputSchema16(BaseModel):
1199
+ class DataIODatabaseInputOutputSchema20(BaseModel):
1200
1200
  model_config = ConfigDict(
1201
1201
  extra="allow",
1202
1202
  )
@@ -1206,7 +1206,7 @@ class DataIODatabaseInputOutputSchema16(BaseModel):
1206
1206
  """
1207
1207
 
1208
1208
 
1209
- class DataIODatabaseInputOutputSchema17(BaseModel):
1209
+ class DataIODatabaseInputOutputSchema21(BaseModel):
1210
1210
  model_config = ConfigDict(
1211
1211
  extra="allow",
1212
1212
  )
@@ -1214,18 +1214,18 @@ class DataIODatabaseInputOutputSchema17(BaseModel):
1214
1214
  """
1215
1215
  db collection name
1216
1216
  """
1217
- draft: Optional[bool] = True
1217
+ draft: bool
1218
1218
  """
1219
1219
  whether the result should be saved as draft
1220
1220
  """
1221
1221
 
1222
1222
 
1223
- class ObjectStorageIoSchema8(BaseModel):
1223
+ class ObjectStorageIoSchema10(BaseModel):
1224
1224
  model_config = ConfigDict(
1225
1225
  extra="allow",
1226
1226
  )
1227
1227
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
1228
- overwrite: Optional[bool] = False
1228
+ overwrite: Optional[bool] = None
1229
1229
  """
1230
1230
  if a file with the same filename already exists, whether to overwrite the old file
1231
1231
  """
@@ -1243,7 +1243,7 @@ class ObjectStorageIoSchema8(BaseModel):
1243
1243
  """
1244
1244
 
1245
1245
 
1246
- class DataIOUnitSchema7(BaseModel):
1246
+ class DataIOUnitSchema9(BaseModel):
1247
1247
  model_config = ConfigDict(
1248
1248
  extra="allow",
1249
1249
  )
@@ -1256,8 +1256,8 @@ class DataIOUnitSchema7(BaseModel):
1256
1256
  input: List[
1257
1257
  Union[
1258
1258
  DataIORestAPIInputSchema,
1259
- Union[DataIODatabaseInputOutputSchema16, DataIODatabaseInputOutputSchema17],
1260
- ObjectStorageIoSchema8,
1259
+ Union[DataIODatabaseInputOutputSchema20, DataIODatabaseInputOutputSchema21],
1260
+ ObjectStorageIoSchema10,
1261
1261
  ]
1262
1262
  ]
1263
1263
  field_id: Optional[str] = Field(None, alias="_id")
@@ -1326,11 +1326,11 @@ class DataIOUnitSchema7(BaseModel):
1326
1326
  statusTrack: Optional[List[StatusTrackItem]] = None
1327
1327
 
1328
1328
 
1329
- class Type114(Enum):
1329
+ class Type113(Enum):
1330
1330
  reduce = "reduce"
1331
1331
 
1332
1332
 
1333
- class ReduceUnitSchema7(BaseModel):
1333
+ class ReduceUnitSchema9(BaseModel):
1334
1334
  model_config = ConfigDict(
1335
1335
  extra="allow",
1336
1336
  )
@@ -1412,11 +1412,11 @@ class ReduceUnitSchema7(BaseModel):
1412
1412
  statusTrack: Optional[List[StatusTrackItem]] = None
1413
1413
 
1414
1414
 
1415
- class Type115(Enum):
1415
+ class Type114(Enum):
1416
1416
  condition = "condition"
1417
1417
 
1418
1418
 
1419
- class ConditionUnitSchema7(BaseModel):
1419
+ class ConditionUnitSchema9(BaseModel):
1420
1420
  model_config = ConfigDict(
1421
1421
  extra="allow",
1422
1422
  )
@@ -1514,11 +1514,11 @@ class ConditionUnitSchema7(BaseModel):
1514
1514
  statusTrack: Optional[List[StatusTrackItem]] = None
1515
1515
 
1516
1516
 
1517
- class Type116(Enum):
1517
+ class Type115(Enum):
1518
1518
  assertion = "assertion"
1519
1519
 
1520
1520
 
1521
- class AssertionUnitSchema7(BaseModel):
1521
+ class AssertionUnitSchema9(BaseModel):
1522
1522
  model_config = ConfigDict(
1523
1523
  extra="allow",
1524
1524
  )
@@ -1600,11 +1600,11 @@ class AssertionUnitSchema7(BaseModel):
1600
1600
  statusTrack: Optional[List[StatusTrackItem]] = None
1601
1601
 
1602
1602
 
1603
- class Type117(Enum):
1603
+ class Type116(Enum):
1604
1604
  execution = "execution"
1605
1605
 
1606
1606
 
1607
- class ExecutableSchema18(BaseModel):
1607
+ class ExecutableSchema12(BaseModel):
1608
1608
  name: str
1609
1609
  """
1610
1610
  The name of the executable. e.g. pw.x
@@ -1652,7 +1652,7 @@ class ExecutableSchema18(BaseModel):
1652
1652
  """
1653
1653
 
1654
1654
 
1655
- class FlavorSchema18(BaseModel):
1655
+ class FlavorSchema12(BaseModel):
1656
1656
  executableId: Optional[str] = None
1657
1657
  """
1658
1658
  _id of the executable this flavor belongs to
@@ -1711,7 +1711,7 @@ class FlavorSchema18(BaseModel):
1711
1711
  """
1712
1712
 
1713
1713
 
1714
- class ExecutionUnitSchemaBase7(BaseModel):
1714
+ class ExecutionUnitSchemaBase9(BaseModel):
1715
1715
  model_config = ConfigDict(
1716
1716
  extra="allow",
1717
1717
  )
@@ -1720,8 +1720,8 @@ class ExecutionUnitSchemaBase7(BaseModel):
1720
1720
  type of the unit
1721
1721
  """
1722
1722
  application: ApplicationSchemaBase = Field(..., title="application schema (base)")
1723
- executable: Optional[ExecutableSchema18] = Field(None, title="executable schema")
1724
- flavor: Optional[FlavorSchema18] = Field(None, title="flavor schema")
1723
+ executable: Optional[ExecutableSchema12] = Field(None, title="executable schema")
1724
+ flavor: Optional[FlavorSchema12] = Field(None, title="flavor schema")
1725
1725
  input: Any
1726
1726
  """
1727
1727
  unit input (type to be specified by the application's execution unit)
@@ -1792,11 +1792,11 @@ class ExecutionUnitSchemaBase7(BaseModel):
1792
1792
  statusTrack: Optional[List[StatusTrackItem]] = None
1793
1793
 
1794
1794
 
1795
- class Type118(Enum):
1795
+ class Type117(Enum):
1796
1796
  assignment = "assignment"
1797
1797
 
1798
1798
 
1799
- class AssignmentUnitSchema7(BaseModel):
1799
+ class AssignmentUnitSchema9(BaseModel):
1800
1800
  model_config = ConfigDict(
1801
1801
  extra="allow",
1802
1802
  )
@@ -1883,11 +1883,11 @@ class AssignmentUnitSchema7(BaseModel):
1883
1883
  scope: Optional[str] = None
1884
1884
 
1885
1885
 
1886
- class Type119(Enum):
1886
+ class Type118(Enum):
1887
1887
  processing = "processing"
1888
1888
 
1889
1889
 
1890
- class ProcessingUnitSchema7(BaseModel):
1890
+ class ProcessingUnitSchema9(BaseModel):
1891
1891
  model_config = ConfigDict(
1892
1892
  extra="allow",
1893
1893
  )
@@ -1973,7 +1973,7 @@ class ProcessingUnitSchema7(BaseModel):
1973
1973
  statusTrack: Optional[List[StatusTrackItem]] = None
1974
1974
 
1975
1975
 
1976
- class Type120(Enum):
1976
+ class Type119(Enum):
1977
1977
  map = "map"
1978
1978
 
1979
1979
 
@@ -2079,7 +2079,7 @@ class MapUnitSchema(BaseModel):
2079
2079
  statusTrack: Optional[List[StatusTrackItem]] = None
2080
2080
 
2081
2081
 
2082
- class Type121(Enum):
2082
+ class Type120(Enum):
2083
2083
  subworkflow = "subworkflow"
2084
2084
 
2085
2085
 
@@ -2160,26 +2160,26 @@ class SubworkflowUnitSchema(BaseModel):
2160
2160
  class WorkflowUnitSchema(
2161
2161
  RootModel[
2162
2162
  Union[
2163
- DataIOUnitSchema7,
2164
- ReduceUnitSchema7,
2165
- ConditionUnitSchema7,
2166
- AssertionUnitSchema7,
2167
- ExecutionUnitSchemaBase7,
2168
- AssignmentUnitSchema7,
2169
- ProcessingUnitSchema7,
2163
+ DataIOUnitSchema9,
2164
+ ReduceUnitSchema9,
2165
+ ConditionUnitSchema9,
2166
+ AssertionUnitSchema9,
2167
+ ExecutionUnitSchemaBase9,
2168
+ AssignmentUnitSchema9,
2169
+ ProcessingUnitSchema9,
2170
2170
  MapUnitSchema,
2171
2171
  SubworkflowUnitSchema,
2172
2172
  ]
2173
2173
  ]
2174
2174
  ):
2175
2175
  root: Union[
2176
- DataIOUnitSchema7,
2177
- ReduceUnitSchema7,
2178
- ConditionUnitSchema7,
2179
- AssertionUnitSchema7,
2180
- ExecutionUnitSchemaBase7,
2181
- AssignmentUnitSchema7,
2182
- ProcessingUnitSchema7,
2176
+ DataIOUnitSchema9,
2177
+ ReduceUnitSchema9,
2178
+ ConditionUnitSchema9,
2179
+ AssertionUnitSchema9,
2180
+ ExecutionUnitSchemaBase9,
2181
+ AssignmentUnitSchema9,
2182
+ ProcessingUnitSchema9,
2183
2183
  MapUnitSchema,
2184
2184
  SubworkflowUnitSchema,
2185
2185
  ] = Field(..., discriminator="type", title="workflow unit schema")
@@ -5,7 +5,7 @@
5
5
  from __future__ import annotations
6
6
 
7
7
  from enum import Enum
8
- from typing import Any, Dict, List, Optional, Union
8
+ from typing import List, Optional
9
9
 
10
10
  from pydantic import BaseModel, ConfigDict, Field, conint
11
11
 
@@ -170,11 +170,11 @@ class BaseFlow(BaseModel):
170
170
  """
171
171
  Human-readable name of the subworkflow. e.g. Total-energy
172
172
  """
173
- properties: Optional[List[Union[str, Dict[str, Any]]]] = None
173
+ properties: Optional[List[str]] = None
174
174
  """
175
175
  Array of characteristic properties calculated by this subworkflow
176
176
  """
177
- compute: Optional[ComputeArgumentsSchema] = None
177
+ compute: Optional[ComputeArgumentsSchema] = Field(None, title="compute arguments schema")
178
178
  """
179
- compute parameters
179
+ Custom keywords prefixed with validate correspond to custom validation methods implemented downstream
180
180
  """
@@ -54,7 +54,7 @@ class DataIODatabaseInputOutputSchema(BaseModel):
54
54
  """
55
55
 
56
56
 
57
- class DataIODatabaseInputOutputSchema9(BaseModel):
57
+ class DataIODatabaseInputOutputSchema13(BaseModel):
58
58
  model_config = ConfigDict(
59
59
  extra="allow",
60
60
  )
@@ -62,7 +62,7 @@ class DataIODatabaseInputOutputSchema9(BaseModel):
62
62
  """
63
63
  db collection name
64
64
  """
65
- draft: Optional[bool] = True
65
+ draft: bool
66
66
  """
67
67
  whether the result should be saved as draft
68
68
  """
@@ -100,7 +100,7 @@ class ObjectStorageIoSchema(BaseModel):
100
100
  extra="allow",
101
101
  )
102
102
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
103
- overwrite: Optional[bool] = False
103
+ overwrite: Optional[bool] = None
104
104
  """
105
105
  if a file with the same filename already exists, whether to overwrite the old file
106
106
  """
@@ -152,7 +152,7 @@ class DataIOUnitSchema(BaseModel):
152
152
  input: List[
153
153
  Union[
154
154
  DataIORestAPIInputSchema,
155
- Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema9],
155
+ Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema13],
156
156
  ObjectStorageIoSchema,
157
157
  ]
158
158
  ]
@@ -1182,11 +1182,11 @@ class Subworkflow(BaseModel):
1182
1182
  """
1183
1183
  Human-readable name of the subworkflow. e.g. Total-energy
1184
1184
  """
1185
- properties: Optional[List[Union[str, Dict[str, Any]]]] = None
1185
+ properties: Optional[List[str]] = None
1186
1186
  """
1187
1187
  Array of characteristic properties calculated by this subworkflow
1188
1188
  """
1189
- compute: Optional[ComputeArgumentsSchema] = None
1189
+ compute: Optional[ComputeArgumentsSchema] = Field(None, title="compute arguments schema")
1190
1190
  """
1191
- compute parameters
1191
+ Custom keywords prefixed with validate correspond to custom validation methods implemented downstream
1192
1192
  """
@@ -54,7 +54,7 @@ class DataIODatabaseInputOutputSchema(BaseModel):
54
54
  """
55
55
 
56
56
 
57
- class DataIODatabaseInputOutputSchema13(BaseModel):
57
+ class DataIODatabaseInputOutputSchema17(BaseModel):
58
58
  model_config = ConfigDict(
59
59
  extra="allow",
60
60
  )
@@ -62,7 +62,7 @@ class DataIODatabaseInputOutputSchema13(BaseModel):
62
62
  """
63
63
  db collection name
64
64
  """
65
- draft: Optional[bool] = True
65
+ draft: bool
66
66
  """
67
67
  whether the result should be saved as draft
68
68
  """
@@ -100,7 +100,7 @@ class ObjectStorageIoSchema(BaseModel):
100
100
  extra="allow",
101
101
  )
102
102
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
103
- overwrite: Optional[bool] = False
103
+ overwrite: Optional[bool] = None
104
104
  """
105
105
  if a file with the same filename already exists, whether to overwrite the old file
106
106
  """
@@ -152,7 +152,7 @@ class DataIOUnitSchema(BaseModel):
152
152
  input: List[
153
153
  Union[
154
154
  DataIORestAPIInputSchema,
155
- Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema13],
155
+ Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema17],
156
156
  ObjectStorageIoSchema,
157
157
  ]
158
158
  ]
@@ -222,7 +222,7 @@ class DataIOUnitSchema(BaseModel):
222
222
  statusTrack: Optional[List[StatusTrackItem]] = None
223
223
 
224
224
 
225
- class Type98(Enum):
225
+ class Type97(Enum):
226
226
  reduce = "reduce"
227
227
 
228
228
 
@@ -319,7 +319,7 @@ class ReduceUnitSchema(BaseModel):
319
319
  statusTrack: Optional[List[StatusTrackItem]] = None
320
320
 
321
321
 
322
- class Type99(Enum):
322
+ class Type98(Enum):
323
323
  condition = "condition"
324
324
 
325
325
 
@@ -432,7 +432,7 @@ class ConditionUnitSchema(BaseModel):
432
432
  statusTrack: Optional[List[StatusTrackItem]] = None
433
433
 
434
434
 
435
- class Type100(Enum):
435
+ class Type99(Enum):
436
436
  assertion = "assertion"
437
437
 
438
438
 
@@ -518,7 +518,7 @@ class AssertionUnitSchema(BaseModel):
518
518
  statusTrack: Optional[List[StatusTrackItem]] = None
519
519
 
520
520
 
521
- class Type101(Enum):
521
+ class Type100(Enum):
522
522
  execution = "execution"
523
523
 
524
524
 
@@ -773,7 +773,7 @@ class ExecutionUnitSchemaBase(BaseModel):
773
773
  statusTrack: Optional[List[StatusTrackItem]] = None
774
774
 
775
775
 
776
- class Type102(Enum):
776
+ class Type101(Enum):
777
777
  assignment = "assignment"
778
778
 
779
779
 
@@ -864,7 +864,7 @@ class AssignmentUnitSchema(BaseModel):
864
864
  scope: Optional[str] = None
865
865
 
866
866
 
867
- class Type103(Enum):
867
+ class Type102(Enum):
868
868
  processing = "processing"
869
869
 
870
870
 
@@ -54,7 +54,7 @@ class DataIODatabaseInputOutputSchema(BaseModel):
54
54
  """
55
55
 
56
56
 
57
- class DataIODatabaseInputOutputSchema11(BaseModel):
57
+ class DataIODatabaseInputOutputSchema15(BaseModel):
58
58
  model_config = ConfigDict(
59
59
  extra="allow",
60
60
  )
@@ -62,7 +62,7 @@ class DataIODatabaseInputOutputSchema11(BaseModel):
62
62
  """
63
63
  db collection name
64
64
  """
65
- draft: Optional[bool] = True
65
+ draft: bool
66
66
  """
67
67
  whether the result should be saved as draft
68
68
  """
@@ -100,7 +100,7 @@ class ObjectStorageIoSchema(BaseModel):
100
100
  extra="allow",
101
101
  )
102
102
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
103
- overwrite: Optional[bool] = False
103
+ overwrite: Optional[bool] = None
104
104
  """
105
105
  if a file with the same filename already exists, whether to overwrite the old file
106
106
  """
@@ -152,7 +152,7 @@ class DataIOUnitSchema(BaseModel):
152
152
  input: List[
153
153
  Union[
154
154
  DataIORestAPIInputSchema,
155
- Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema11],
155
+ Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema15],
156
156
  ObjectStorageIoSchema,
157
157
  ]
158
158
  ]
@@ -222,7 +222,7 @@ class DataIOUnitSchema(BaseModel):
222
222
  statusTrack: Optional[List[StatusTrackItem]] = None
223
223
 
224
224
 
225
- class Type89(Enum):
225
+ class Type88(Enum):
226
226
  reduce = "reduce"
227
227
 
228
228
 
@@ -319,7 +319,7 @@ class ReduceUnitSchema(BaseModel):
319
319
  statusTrack: Optional[List[StatusTrackItem]] = None
320
320
 
321
321
 
322
- class Type90(Enum):
322
+ class Type89(Enum):
323
323
  condition = "condition"
324
324
 
325
325
 
@@ -432,7 +432,7 @@ class ConditionUnitSchema(BaseModel):
432
432
  statusTrack: Optional[List[StatusTrackItem]] = None
433
433
 
434
434
 
435
- class Type91(Enum):
435
+ class Type90(Enum):
436
436
  assertion = "assertion"
437
437
 
438
438
 
@@ -518,7 +518,7 @@ class AssertionUnitSchema(BaseModel):
518
518
  statusTrack: Optional[List[StatusTrackItem]] = None
519
519
 
520
520
 
521
- class Type92(Enum):
521
+ class Type91(Enum):
522
522
  execution = "execution"
523
523
 
524
524
 
@@ -773,7 +773,7 @@ class ExecutionUnitSchemaBase(BaseModel):
773
773
  statusTrack: Optional[List[StatusTrackItem]] = None
774
774
 
775
775
 
776
- class Type93(Enum):
776
+ class Type92(Enum):
777
777
  assignment = "assignment"
778
778
 
779
779
 
@@ -864,7 +864,7 @@ class AssignmentUnitSchema(BaseModel):
864
864
  scope: Optional[str] = None
865
865
 
866
866
 
867
- class Type94(Enum):
867
+ class Type93(Enum):
868
868
  processing = "processing"
869
869
 
870
870
 
@@ -954,7 +954,7 @@ class ProcessingUnitSchema(BaseModel):
954
954
  statusTrack: Optional[List[StatusTrackItem]] = None
955
955
 
956
956
 
957
- class Type95(Enum):
957
+ class Type94(Enum):
958
958
  map = "map"
959
959
 
960
960
 
@@ -1060,7 +1060,7 @@ class MapUnitSchema(BaseModel):
1060
1060
  statusTrack: Optional[List[StatusTrackItem]] = None
1061
1061
 
1062
1062
 
1063
- class Type96(Enum):
1063
+ class Type95(Enum):
1064
1064
  subworkflow = "subworkflow"
1065
1065
 
1066
1066
 
@@ -54,7 +54,7 @@ class DataIODatabaseInputOutputSchema(BaseModel):
54
54
  """
55
55
 
56
56
 
57
- class DataIODatabaseInputOutputSchema3(BaseModel):
57
+ class DataIODatabaseInputOutputSchema7(BaseModel):
58
58
  model_config = ConfigDict(
59
59
  extra="allow",
60
60
  )
@@ -62,7 +62,7 @@ class DataIODatabaseInputOutputSchema3(BaseModel):
62
62
  """
63
63
  db collection name
64
64
  """
65
- draft: Optional[bool] = True
65
+ draft: bool
66
66
  """
67
67
  whether the result should be saved as draft
68
68
  """
@@ -100,7 +100,7 @@ class ObjectStorageIoSchema(BaseModel):
100
100
  extra="allow",
101
101
  )
102
102
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
103
- overwrite: Optional[bool] = False
103
+ overwrite: Optional[bool] = None
104
104
  """
105
105
  if a file with the same filename already exists, whether to overwrite the old file
106
106
  """
@@ -152,7 +152,7 @@ class DataIOUnitSchema(BaseModel):
152
152
  input: List[
153
153
  Union[
154
154
  DataIORestAPIInputSchema,
155
- Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema3],
155
+ Union[DataIODatabaseInputOutputSchema, DataIODatabaseInputOutputSchema7],
156
156
  ObjectStorageIoSchema,
157
157
  ]
158
158
  ]
@@ -4,7 +4,7 @@
4
4
 
5
5
  from __future__ import annotations
6
6
 
7
- from typing import List, Optional, Union
7
+ from typing import List, Union
8
8
 
9
9
  from pydantic import BaseModel, ConfigDict, Field, RootModel
10
10
 
@@ -27,7 +27,7 @@ class DataIODatabaseInputOutputSchema1(BaseModel):
27
27
  """
28
28
  db collection name
29
29
  """
30
- draft: Optional[bool] = True
30
+ draft: bool
31
31
  """
32
32
  whether the result should be saved as draft
33
33
  """
@@ -41,7 +41,7 @@ class ObjectStorageIoSchema(BaseModel):
41
41
  extra="allow",
42
42
  )
43
43
  objectData: ObjectStorageContainerData = Field(..., title="Object Storage Container Data")
44
- overwrite: Optional[bool] = False
44
+ overwrite: Optional[bool] = None
45
45
  """
46
46
  if a file with the same filename already exists, whether to overwrite the old file
47
47
  """
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mat3ra-esse
3
- Version: 2025.8.14.post0
3
+ Version: 2025.10.8.post0
4
4
  Summary: Excellent Source of Schemas and Examples.
5
5
  Author-email: "Exabyte Inc." <info@mat3ra.com>
6
6
  License: # LICENSE