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