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
@@ -1,3 +0,0 @@
1
- # generated by datamodel-codegen:
2
- # filename: schema
3
- # version: 0.28.5
@@ -1,293 +0,0 @@
1
- # generated by datamodel-codegen:
2
- # filename: software_directory/ml/unit/execution/evaluate/cross_validate.json
3
- # version: 0.28.5
4
-
5
- from __future__ import annotations
6
-
7
- from enum import Enum
8
- from typing import Any, Dict, List, Optional, Union
9
-
10
- from pydantic import BaseModel, ConfigDict, Field
11
-
12
-
13
- class Input(BaseModel):
14
- nSplits: float
15
- """
16
- number of groups to split the training dataset for cross-validation
17
- """
18
-
19
-
20
- class Type(Enum):
21
- execution = "execution"
22
-
23
-
24
- class ApplicationSchemaBase(BaseModel):
25
- model_config = ConfigDict(
26
- extra="allow",
27
- )
28
- shortName: Optional[str] = None
29
- """
30
- The short name of the application. e.g. qe
31
- """
32
- summary: Optional[str] = None
33
- """
34
- Application's short description.
35
- """
36
- version: Optional[str] = None
37
- """
38
- Application version. e.g. 5.3.5
39
- """
40
- build: Optional[str] = None
41
- """
42
- Application build. e.g. VTST
43
- """
44
- hasAdvancedComputeOptions: Optional[bool] = None
45
- """
46
- Whether advanced compute options are present
47
- """
48
- isLicensed: Optional[bool] = None
49
- """
50
- Whether licensing is present
51
- """
52
- field_id: Optional[str] = Field(None, alias="_id")
53
- """
54
- entity identity
55
- """
56
- slug: Optional[str] = None
57
- """
58
- entity slug
59
- """
60
- systemName: Optional[str] = None
61
- schemaVersion: Optional[str] = "2022.8.16"
62
- """
63
- entity's schema version. Used to distinct between different schemas.
64
- """
65
- name: Optional[str] = None
66
- """
67
- entity name
68
- """
69
- isDefault: Optional[bool] = False
70
- """
71
- Identifies that entity is defaultable
72
- """
73
-
74
-
75
- class NameResultSchema(BaseModel):
76
- name: str
77
- """
78
- The name of this item. e.g. scf_accuracy
79
- """
80
-
81
-
82
- class ExecutableSchema(BaseModel):
83
- name: str
84
- """
85
- The name of the executable. e.g. pw.x
86
- """
87
- applicationId: Optional[List[str]] = None
88
- """
89
- _ids of the application this executable belongs to
90
- """
91
- hasAdvancedComputeOptions: Optional[bool] = None
92
- """
93
- Whether advanced compute options are present
94
- """
95
- field_id: Optional[str] = Field(None, alias="_id")
96
- """
97
- entity identity
98
- """
99
- slug: Optional[str] = None
100
- """
101
- entity slug
102
- """
103
- systemName: Optional[str] = None
104
- schemaVersion: Optional[str] = "2022.8.16"
105
- """
106
- entity's schema version. Used to distinct between different schemas.
107
- """
108
- isDefault: Optional[bool] = False
109
- """
110
- Identifies that entity is defaultable
111
- """
112
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
113
- """
114
- names of the pre-processors for this calculation
115
- """
116
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
117
- """
118
- names of the post-processors for this calculation
119
- """
120
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
121
- """
122
- names of the monitors for this calculation
123
- """
124
- results: Optional[List[Union[NameResultSchema, str]]] = None
125
- """
126
- names of the results for this calculation
127
- """
128
-
129
-
130
- class ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines(BaseModel):
131
- model_config = ConfigDict(
132
- extra="forbid",
133
- )
134
- templateId: Optional[str] = None
135
- templateName: Optional[str] = None
136
- name: Optional[str] = None
137
- """
138
- name of the resulting input file, if different than template name
139
- """
140
-
141
-
142
- class FlavorSchema(BaseModel):
143
- executableId: Optional[str] = None
144
- """
145
- _id of the executable this flavor belongs to
146
- """
147
- executableName: Optional[str] = None
148
- """
149
- name of the executable this flavor belongs to
150
- """
151
- applicationName: Optional[str] = None
152
- """
153
- name of the application this flavor belongs to
154
- """
155
- input: Optional[List[ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines]] = Field(
156
- None, title="execution unit input schema"
157
- )
158
- supportedApplicationVersions: Optional[List[str]] = None
159
- """
160
- list of application versions this flavor supports
161
- """
162
- field_id: Optional[str] = Field(None, alias="_id")
163
- """
164
- entity identity
165
- """
166
- slug: Optional[str] = None
167
- """
168
- entity slug
169
- """
170
- systemName: Optional[str] = None
171
- schemaVersion: Optional[str] = "2022.8.16"
172
- """
173
- entity's schema version. Used to distinct between different schemas.
174
- """
175
- name: Optional[str] = None
176
- """
177
- entity name
178
- """
179
- isDefault: Optional[bool] = False
180
- """
181
- Identifies that entity is defaultable
182
- """
183
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
184
- """
185
- names of the pre-processors for this calculation
186
- """
187
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
188
- """
189
- names of the post-processors for this calculation
190
- """
191
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
192
- """
193
- names of the monitors for this calculation
194
- """
195
- results: Optional[List[Union[NameResultSchema, str]]] = None
196
- """
197
- names of the results for this calculation
198
- """
199
-
200
-
201
- class Status(Enum):
202
- idle = "idle"
203
- active = "active"
204
- warning = "warning"
205
- error = "error"
206
- finished = "finished"
207
-
208
-
209
- class StatusTrackItem(BaseModel):
210
- trackedAt: float
211
- status: str
212
- repetition: Optional[float] = None
213
-
214
-
215
- class CrossValidationUnitSchema(BaseModel):
216
- model_config = ConfigDict(
217
- extra="allow",
218
- )
219
- input: Input
220
- """
221
- TODO: consider keeping executable `evaluate` and flavor `cross-validate` as before
222
- """
223
- type: Type
224
- """
225
- type of the unit
226
- """
227
- application: ApplicationSchemaBase = Field(..., title="application schema (base)")
228
- executable: Optional[ExecutableSchema] = Field(None, title="executable schema")
229
- flavor: Optional[FlavorSchema] = Field(None, title="flavor schema")
230
- field_id: Optional[str] = Field(None, alias="_id")
231
- """
232
- entity identity
233
- """
234
- isDraft: Optional[bool] = None
235
- name: Optional[str] = None
236
- """
237
- name of the unit. e.g. pw_scf
238
- """
239
- status: Optional[Status] = None
240
- """
241
- Status of the unit.
242
- """
243
- head: Optional[bool] = None
244
- """
245
- Whether this unit is the first one to be executed.
246
- """
247
- flowchartId: str
248
- """
249
- Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
250
- """
251
- next: Optional[str] = None
252
- """
253
- Next unit's flowchartId. If empty, the current unit is the last.
254
- """
255
- enableRender: Optional[bool] = None
256
- """
257
- Whether Rupy should attempt to use Jinja templating to add context variables into the unit
258
- """
259
- context: Optional[Dict[str, Any]] = None
260
- slug: Optional[str] = None
261
- """
262
- entity slug
263
- """
264
- systemName: Optional[str] = None
265
- schemaVersion: Optional[str] = "2022.8.16"
266
- """
267
- entity's schema version. Used to distinct between different schemas.
268
- """
269
- isDefault: Optional[bool] = False
270
- """
271
- Identifies that entity is defaultable
272
- """
273
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
274
- """
275
- names of the pre-processors for this calculation
276
- """
277
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
278
- """
279
- names of the post-processors for this calculation
280
- """
281
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
282
- """
283
- names of the monitors for this calculation
284
- """
285
- results: Optional[List[Union[NameResultSchema, str]]] = None
286
- """
287
- names of the results for this calculation
288
- """
289
- tags: Optional[List[str]] = None
290
- """
291
- entity tags
292
- """
293
- statusTrack: Optional[List[StatusTrackItem]] = None
@@ -1,293 +0,0 @@
1
- # generated by datamodel-codegen:
2
- # filename: software_directory/ml/unit/execution/initialize.json
3
- # version: 0.28.5
4
-
5
- from __future__ import annotations
6
-
7
- from enum import Enum
8
- from typing import Any, Dict, List, Optional, Union
9
-
10
- from pydantic import BaseModel, ConfigDict, Field
11
-
12
-
13
- class Input(BaseModel):
14
- targets: List[str]
15
- """
16
- target properties to predict (NOTE: must be a subset of targets for which training was done)
17
- """
18
-
19
-
20
- class Type(Enum):
21
- execution = "execution"
22
-
23
-
24
- class ApplicationSchemaBase(BaseModel):
25
- model_config = ConfigDict(
26
- extra="allow",
27
- )
28
- shortName: Optional[str] = None
29
- """
30
- The short name of the application. e.g. qe
31
- """
32
- summary: Optional[str] = None
33
- """
34
- Application's short description.
35
- """
36
- version: Optional[str] = None
37
- """
38
- Application version. e.g. 5.3.5
39
- """
40
- build: Optional[str] = None
41
- """
42
- Application build. e.g. VTST
43
- """
44
- hasAdvancedComputeOptions: Optional[bool] = None
45
- """
46
- Whether advanced compute options are present
47
- """
48
- isLicensed: Optional[bool] = None
49
- """
50
- Whether licensing is present
51
- """
52
- field_id: Optional[str] = Field(None, alias="_id")
53
- """
54
- entity identity
55
- """
56
- slug: Optional[str] = None
57
- """
58
- entity slug
59
- """
60
- systemName: Optional[str] = None
61
- schemaVersion: Optional[str] = "2022.8.16"
62
- """
63
- entity's schema version. Used to distinct between different schemas.
64
- """
65
- name: Optional[str] = None
66
- """
67
- entity name
68
- """
69
- isDefault: Optional[bool] = False
70
- """
71
- Identifies that entity is defaultable
72
- """
73
-
74
-
75
- class NameResultSchema(BaseModel):
76
- name: str
77
- """
78
- The name of this item. e.g. scf_accuracy
79
- """
80
-
81
-
82
- class ExecutableSchema(BaseModel):
83
- name: str
84
- """
85
- The name of the executable. e.g. pw.x
86
- """
87
- applicationId: Optional[List[str]] = None
88
- """
89
- _ids of the application this executable belongs to
90
- """
91
- hasAdvancedComputeOptions: Optional[bool] = None
92
- """
93
- Whether advanced compute options are present
94
- """
95
- field_id: Optional[str] = Field(None, alias="_id")
96
- """
97
- entity identity
98
- """
99
- slug: Optional[str] = None
100
- """
101
- entity slug
102
- """
103
- systemName: Optional[str] = None
104
- schemaVersion: Optional[str] = "2022.8.16"
105
- """
106
- entity's schema version. Used to distinct between different schemas.
107
- """
108
- isDefault: Optional[bool] = False
109
- """
110
- Identifies that entity is defaultable
111
- """
112
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
113
- """
114
- names of the pre-processors for this calculation
115
- """
116
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
117
- """
118
- names of the post-processors for this calculation
119
- """
120
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
121
- """
122
- names of the monitors for this calculation
123
- """
124
- results: Optional[List[Union[NameResultSchema, str]]] = None
125
- """
126
- names of the results for this calculation
127
- """
128
-
129
-
130
- class ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines(BaseModel):
131
- model_config = ConfigDict(
132
- extra="forbid",
133
- )
134
- templateId: Optional[str] = None
135
- templateName: Optional[str] = None
136
- name: Optional[str] = None
137
- """
138
- name of the resulting input file, if different than template name
139
- """
140
-
141
-
142
- class FlavorSchema(BaseModel):
143
- executableId: Optional[str] = None
144
- """
145
- _id of the executable this flavor belongs to
146
- """
147
- executableName: Optional[str] = None
148
- """
149
- name of the executable this flavor belongs to
150
- """
151
- applicationName: Optional[str] = None
152
- """
153
- name of the application this flavor belongs to
154
- """
155
- input: Optional[List[ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines]] = Field(
156
- None, title="execution unit input schema"
157
- )
158
- supportedApplicationVersions: Optional[List[str]] = None
159
- """
160
- list of application versions this flavor supports
161
- """
162
- field_id: Optional[str] = Field(None, alias="_id")
163
- """
164
- entity identity
165
- """
166
- slug: Optional[str] = None
167
- """
168
- entity slug
169
- """
170
- systemName: Optional[str] = None
171
- schemaVersion: Optional[str] = "2022.8.16"
172
- """
173
- entity's schema version. Used to distinct between different schemas.
174
- """
175
- name: Optional[str] = None
176
- """
177
- entity name
178
- """
179
- isDefault: Optional[bool] = False
180
- """
181
- Identifies that entity is defaultable
182
- """
183
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
184
- """
185
- names of the pre-processors for this calculation
186
- """
187
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
188
- """
189
- names of the post-processors for this calculation
190
- """
191
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
192
- """
193
- names of the monitors for this calculation
194
- """
195
- results: Optional[List[Union[NameResultSchema, str]]] = None
196
- """
197
- names of the results for this calculation
198
- """
199
-
200
-
201
- class Status(Enum):
202
- idle = "idle"
203
- active = "active"
204
- warning = "warning"
205
- error = "error"
206
- finished = "finished"
207
-
208
-
209
- class StatusTrackItem(BaseModel):
210
- trackedAt: float
211
- status: str
212
- repetition: Optional[float] = None
213
-
214
-
215
- class InitializeUnitSchema(BaseModel):
216
- model_config = ConfigDict(
217
- extra="allow",
218
- )
219
- input: Input
220
- """
221
- model init unit (NOTE: info about method, eg. regression/linear is taken from (sub)workflow)
222
- """
223
- type: Type
224
- """
225
- type of the unit
226
- """
227
- application: ApplicationSchemaBase = Field(..., title="application schema (base)")
228
- executable: Optional[ExecutableSchema] = Field(None, title="executable schema")
229
- flavor: Optional[FlavorSchema] = Field(None, title="flavor schema")
230
- field_id: Optional[str] = Field(None, alias="_id")
231
- """
232
- entity identity
233
- """
234
- isDraft: Optional[bool] = None
235
- name: Optional[str] = None
236
- """
237
- name of the unit. e.g. pw_scf
238
- """
239
- status: Optional[Status] = None
240
- """
241
- Status of the unit.
242
- """
243
- head: Optional[bool] = None
244
- """
245
- Whether this unit is the first one to be executed.
246
- """
247
- flowchartId: str
248
- """
249
- Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
250
- """
251
- next: Optional[str] = None
252
- """
253
- Next unit's flowchartId. If empty, the current unit is the last.
254
- """
255
- enableRender: Optional[bool] = None
256
- """
257
- Whether Rupy should attempt to use Jinja templating to add context variables into the unit
258
- """
259
- context: Optional[Dict[str, Any]] = None
260
- slug: Optional[str] = None
261
- """
262
- entity slug
263
- """
264
- systemName: Optional[str] = None
265
- schemaVersion: Optional[str] = "2022.8.16"
266
- """
267
- entity's schema version. Used to distinct between different schemas.
268
- """
269
- isDefault: Optional[bool] = False
270
- """
271
- Identifies that entity is defaultable
272
- """
273
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
274
- """
275
- names of the pre-processors for this calculation
276
- """
277
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
278
- """
279
- names of the post-processors for this calculation
280
- """
281
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
282
- """
283
- names of the monitors for this calculation
284
- """
285
- results: Optional[List[Union[NameResultSchema, str]]] = None
286
- """
287
- names of the results for this calculation
288
- """
289
- tags: Optional[List[str]] = None
290
- """
291
- entity tags
292
- """
293
- statusTrack: Optional[List[StatusTrackItem]] = None