mat3ra-esse 2024.4.8.post0__py3-none-any.whl → 2024.4.8.post2__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 (447) hide show
  1. mat3ra/esse/models/__init__.py +3 -0
  2. mat3ra/esse/models/core/__init__.py +3 -0
  3. mat3ra/esse/models/core/abstract/2d_data.py +17 -0
  4. mat3ra/esse/models/core/abstract/2d_plot.py +34 -0
  5. mat3ra/esse/models/core/abstract/3d_grid.py +14 -0
  6. mat3ra/esse/models/core/abstract/3d_tensor.py +19 -0
  7. mat3ra/esse/models/core/abstract/3d_vector_basis.py +15 -0
  8. mat3ra/esse/models/core/abstract/__init__.py +3 -0
  9. mat3ra/esse/models/core/abstract/point.py +13 -0
  10. mat3ra/esse/models/core/abstract/vector.py +13 -0
  11. mat3ra/esse/models/core/primitive/1d_data_series.py +13 -0
  12. mat3ra/esse/models/core/primitive/3d_lattice.py +34 -0
  13. mat3ra/esse/models/core/primitive/__init__.py +3 -0
  14. mat3ra/esse/models/core/primitive/array_of_3_booleans.py +13 -0
  15. mat3ra/esse/models/core/primitive/array_of_3_numbers.py +13 -0
  16. mat3ra/esse/models/core/primitive/array_of_ids.py +23 -0
  17. mat3ra/esse/models/core/primitive/array_of_strings.py +16 -0
  18. mat3ra/esse/models/core/primitive/axis.py +20 -0
  19. mat3ra/esse/models/core/primitive/group_info.py +20 -0
  20. mat3ra/esse/models/core/primitive/integer_one_or_zero.py +11 -0
  21. mat3ra/esse/models/core/primitive/linked_list/__init__.py +33 -0
  22. mat3ra/esse/models/core/primitive/linked_list/base_node.py +31 -0
  23. mat3ra/esse/models/core/primitive/linked_list/named_node.py +35 -0
  24. mat3ra/esse/models/core/primitive/linked_list/named_node_in_group.py +43 -0
  25. mat3ra/esse/models/core/primitive/linked_list/node_with_type.py +32 -0
  26. mat3ra/esse/models/core/primitive/scalar.py +11 -0
  27. mat3ra/esse/models/core/primitive/slugified_entry.py +18 -0
  28. mat3ra/esse/models/core/primitive/slugified_entry_or_slug.py +27 -0
  29. mat3ra/esse/models/core/primitive/string.py +11 -0
  30. mat3ra/esse/models/core/reference/__init__.py +260 -0
  31. mat3ra/esse/models/core/reference/exabyte.py +24 -0
  32. mat3ra/esse/models/core/reference/experiment/__init__.py +150 -0
  33. mat3ra/esse/models/core/reference/experiment/condition.py +28 -0
  34. mat3ra/esse/models/core/reference/experiment/location.py +18 -0
  35. mat3ra/esse/models/core/reference/literature/__init__.py +86 -0
  36. mat3ra/esse/models/core/reference/literature/name.py +16 -0
  37. mat3ra/esse/models/core/reference/literature/pages.py +14 -0
  38. mat3ra/esse/models/core/reference/modeling/__init__.py +49 -0
  39. mat3ra/esse/models/core/reference/modeling/exabyte.py +42 -0
  40. mat3ra/esse/models/core/reusable/__init__.py +3 -0
  41. mat3ra/esse/models/core/reusable/atomic_data/__init__.py +3 -0
  42. mat3ra/esse/models/core/reusable/atomic_data/per_orbital.py +21 -0
  43. mat3ra/esse/models/core/reusable/atomic_data/per_orbital_pair.py +34 -0
  44. mat3ra/esse/models/core/reusable/atomic_data/value_number.py +16 -0
  45. mat3ra/esse/models/core/reusable/atomic_data/value_string.py +16 -0
  46. mat3ra/esse/models/core/reusable/atomic_data_per_orbital_numeric.py +25 -0
  47. mat3ra/esse/models/core/reusable/atomic_data_per_orbital_pair_numeric.py +38 -0
  48. mat3ra/esse/models/core/reusable/atomic_orbital.py +20 -0
  49. mat3ra/esse/models/core/reusable/atomic_scalars.py +28 -0
  50. mat3ra/esse/models/core/reusable/atomic_strings.py +24 -0
  51. mat3ra/esse/models/core/reusable/atomic_vectors.py +24 -0
  52. mat3ra/esse/models/core/reusable/band_gap.py +42 -0
  53. mat3ra/esse/models/core/reusable/categories.py +43 -0
  54. mat3ra/esse/models/core/reusable/category_path.py +14 -0
  55. mat3ra/esse/models/core/reusable/dielectric_tensor_component.py +31 -0
  56. mat3ra/esse/models/core/reusable/energy.py +30 -0
  57. mat3ra/esse/models/core/reusable/file_metadata.py +24 -0
  58. mat3ra/esse/models/core/reusable/frequency_function_matrix.py +20 -0
  59. mat3ra/esse/models/core/reusable/object_storage_container_data.py +36 -0
  60. mat3ra/esse/models/definitions/__init__.py +3 -0
  61. mat3ra/esse/models/definitions/units.py +13 -0
  62. mat3ra/esse/models/element.py +74 -0
  63. mat3ra/esse/models/in_memory_entity/__init__.py +3 -0
  64. mat3ra/esse/models/in_memory_entity/base.py +58 -0
  65. mat3ra/esse/models/in_memory_entity/defaultable.py +62 -0
  66. mat3ra/esse/models/in_memory_entity/named.py +62 -0
  67. mat3ra/esse/models/in_memory_entity/named_defaultable.py +66 -0
  68. mat3ra/esse/models/in_memory_entity/named_defaultable_has_metadata.py +67 -0
  69. mat3ra/esse/models/in_memory_entity/named_defaultable_runtime_items.py +89 -0
  70. mat3ra/esse/models/job/__init__.py +3006 -0
  71. mat3ra/esse/models/job/base.py +287 -0
  72. mat3ra/esse/models/job/compute.py +161 -0
  73. mat3ra/esse/models/material/__init__.py +420 -0
  74. mat3ra/esse/models/material/conventional.py +13 -0
  75. mat3ra/esse/models/method/__init__.py +28 -0
  76. mat3ra/esse/models/method/categorized_method.py +86 -0
  77. mat3ra/esse/models/method/method_parameters.py +48 -0
  78. mat3ra/esse/models/method/unit_method.py +70 -0
  79. mat3ra/esse/models/methods_category/mathematical/__init__.py +3 -0
  80. mat3ra/esse/models/methods_category/mathematical/diff/__init__.py +48 -0
  81. mat3ra/esse/models/methods_category/mathematical/diff/enum_options.py +13 -0
  82. mat3ra/esse/models/methods_category/mathematical/diff/fd.py +52 -0
  83. mat3ra/esse/models/methods_category/mathematical/discr/__init__.py +48 -0
  84. mat3ra/esse/models/methods_category/mathematical/discr/enum_options.py +13 -0
  85. mat3ra/esse/models/methods_category/mathematical/discr/mesh/__init__.py +52 -0
  86. mat3ra/esse/models/methods_category/mathematical/discr/mesh/enum_options.py +13 -0
  87. mat3ra/esse/models/methods_category/mathematical/discr/mesh/hybrid.py +56 -0
  88. mat3ra/esse/models/methods_category/mathematical/discr/mesh/nstruct.py +56 -0
  89. mat3ra/esse/models/methods_category/mathematical/discr/mesh/struct/__init__.py +56 -0
  90. mat3ra/esse/models/methods_category/mathematical/discr/mesh/struct/cartesian.py +60 -0
  91. mat3ra/esse/models/methods_category/mathematical/discr/mesh/struct/enum_options.py +13 -0
  92. mat3ra/esse/models/methods_category/mathematical/enum_options.py +13 -0
  93. mat3ra/esse/models/methods_category/mathematical/fapprx/__init__.py +48 -0
  94. mat3ra/esse/models/methods_category/mathematical/fapprx/basisexp.py +52 -0
  95. mat3ra/esse/models/methods_category/mathematical/fapprx/enum_options.py +13 -0
  96. mat3ra/esse/models/methods_category/mathematical/fapprx/ipol/__init__.py +52 -0
  97. mat3ra/esse/models/methods_category/mathematical/fapprx/ipol/enum_options.py +13 -0
  98. mat3ra/esse/models/methods_category/mathematical/fapprx/ipol/lin.py +56 -0
  99. mat3ra/esse/models/methods_category/mathematical/fapprx/ipol/poly.py +56 -0
  100. mat3ra/esse/models/methods_category/mathematical/fapprx/ipol/spline.py +56 -0
  101. mat3ra/esse/models/methods_category/mathematical/intgr/__init__.py +48 -0
  102. mat3ra/esse/models/methods_category/mathematical/intgr/analytic/__init__.py +52 -0
  103. mat3ra/esse/models/methods_category/mathematical/intgr/analytic/enum_options.py +13 -0
  104. mat3ra/esse/models/methods_category/mathematical/intgr/analytic/volume.py +67 -0
  105. mat3ra/esse/models/methods_category/mathematical/intgr/diffeq/__init__.py +52 -0
  106. mat3ra/esse/models/methods_category/mathematical/intgr/diffeq/enum_options.py +13 -0
  107. mat3ra/esse/models/methods_category/mathematical/intgr/diffeq/order1.py +56 -0
  108. mat3ra/esse/models/methods_category/mathematical/intgr/diffeq/order2.py +56 -0
  109. mat3ra/esse/models/methods_category/mathematical/intgr/enum_options.py +13 -0
  110. mat3ra/esse/models/methods_category/mathematical/intgr/numquad/__init__.py +52 -0
  111. mat3ra/esse/models/methods_category/mathematical/intgr/numquad/enum_options.py +13 -0
  112. mat3ra/esse/models/methods_category/mathematical/intgr/numquad/gauss.py +56 -0
  113. mat3ra/esse/models/methods_category/mathematical/intgr/numquad/newcot.py +56 -0
  114. mat3ra/esse/models/methods_category/mathematical/intgr/transf/__init__.py +52 -0
  115. mat3ra/esse/models/methods_category/mathematical/intgr/transf/enum_options.py +13 -0
  116. mat3ra/esse/models/methods_category/mathematical/intgr/transf/fourier.py +56 -0
  117. mat3ra/esse/models/methods_category/mathematical/linalg/__init__.py +48 -0
  118. mat3ra/esse/models/methods_category/mathematical/linalg/dcomp.py +52 -0
  119. mat3ra/esse/models/methods_category/mathematical/linalg/diag/__init__.py +52 -0
  120. mat3ra/esse/models/methods_category/mathematical/linalg/diag/davidson.py +56 -0
  121. mat3ra/esse/models/methods_category/mathematical/linalg/diag/enum_options.py +13 -0
  122. mat3ra/esse/models/methods_category/mathematical/linalg/enum_options.py +13 -0
  123. mat3ra/esse/models/methods_category/mathematical/linalg/lintra.py +52 -0
  124. mat3ra/esse/models/methods_category/mathematical/linalg/matf.py +52 -0
  125. mat3ra/esse/models/methods_category/mathematical/opt/__init__.py +48 -0
  126. mat3ra/esse/models/methods_category/mathematical/opt/diff/__init__.py +52 -0
  127. mat3ra/esse/models/methods_category/mathematical/opt/diff/bracket.py +56 -0
  128. mat3ra/esse/models/methods_category/mathematical/opt/diff/enum_options.py +13 -0
  129. mat3ra/esse/models/methods_category/mathematical/opt/diff/local.py +56 -0
  130. mat3ra/esse/models/methods_category/mathematical/opt/diff/order1.py +56 -0
  131. mat3ra/esse/models/methods_category/mathematical/opt/diff/order2.py +56 -0
  132. mat3ra/esse/models/methods_category/mathematical/opt/diff/ordern/__init__.py +56 -0
  133. mat3ra/esse/models/methods_category/mathematical/opt/diff/ordern/cg.py +60 -0
  134. mat3ra/esse/models/methods_category/mathematical/opt/diff/ordern/enum_options.py +13 -0
  135. mat3ra/esse/models/methods_category/mathematical/opt/enum_options.py +13 -0
  136. mat3ra/esse/models/methods_category/mathematical/opt/ndiff/__init__.py +52 -0
  137. mat3ra/esse/models/methods_category/mathematical/opt/ndiff/direct.py +56 -0
  138. mat3ra/esse/models/methods_category/mathematical/opt/ndiff/enum_options.py +13 -0
  139. mat3ra/esse/models/methods_category/mathematical/opt/ndiff/pop.py +56 -0
  140. mat3ra/esse/models/methods_category/mathematical/opt/ndiff/stoch.py +56 -0
  141. mat3ra/esse/models/methods_category/mathematical/opt/root/__init__.py +52 -0
  142. mat3ra/esse/models/methods_category/mathematical/opt/root/bracket.py +56 -0
  143. mat3ra/esse/models/methods_category/mathematical/opt/root/enum_options.py +13 -0
  144. mat3ra/esse/models/methods_category/mathematical/opt/root/iter.py +56 -0
  145. mat3ra/esse/models/methods_category/mathematical/regression.py +54 -0
  146. mat3ra/esse/models/methods_category/physical/__init__.py +3 -0
  147. mat3ra/esse/models/methods_category/physical/enum_options.py +13 -0
  148. mat3ra/esse/models/methods_category/physical/qm/__init__.py +48 -0
  149. mat3ra/esse/models/methods_category/physical/qm/enum_options.py +13 -0
  150. mat3ra/esse/models/methods_category/physical/qm/wf/__init__.py +52 -0
  151. mat3ra/esse/models/methods_category/physical/qm/wf/ao/__init__.py +62 -0
  152. mat3ra/esse/models/methods_category/physical/qm/wf/ao/dunning.py +60 -0
  153. mat3ra/esse/models/methods_category/physical/qm/wf/ao/other.py +60 -0
  154. mat3ra/esse/models/methods_category/physical/qm/wf/ao/pople.py +60 -0
  155. mat3ra/esse/models/methods_category/physical/qm/wf/enum_options.py +13 -0
  156. mat3ra/esse/models/methods_category/physical/qm/wf/psp.py +63 -0
  157. mat3ra/esse/models/methods_category/physical/qm/wf/pw.py +56 -0
  158. mat3ra/esse/models/methods_category/physical/qm/wf/smearing.py +63 -0
  159. mat3ra/esse/models/methods_category/physical/qm/wf/tetrahedron.py +62 -0
  160. mat3ra/esse/models/methods_directory/legacy/__init__.py +3 -0
  161. mat3ra/esse/models/methods_directory/legacy/localorbital.py +37 -0
  162. mat3ra/esse/models/methods_directory/legacy/pseudopotential.py +40 -0
  163. mat3ra/esse/models/methods_directory/legacy/regression.py +118 -0
  164. mat3ra/esse/models/methods_directory/legacy/unknown.py +37 -0
  165. mat3ra/esse/models/methods_directory/mathematical/__init__.py +3 -0
  166. mat3ra/esse/models/methods_directory/mathematical/cg.py +87 -0
  167. mat3ra/esse/models/methods_directory/mathematical/davidson.py +83 -0
  168. mat3ra/esse/models/methods_directory/mathematical/regression/__init__.py +161 -0
  169. mat3ra/esse/models/methods_directory/mathematical/regression/data.py +69 -0
  170. mat3ra/esse/models/methods_directory/mathematical/regression/dataset.py +20 -0
  171. mat3ra/esse/models/methods_directory/mathematical/regression/kernel_ridge/__init__.py +3 -0
  172. mat3ra/esse/models/methods_directory/mathematical/regression/kernel_ridge/data_per_property.py +39 -0
  173. mat3ra/esse/models/methods_directory/mathematical/regression/linear/__init__.py +3 -0
  174. mat3ra/esse/models/methods_directory/mathematical/regression/linear/data_per_property.py +35 -0
  175. mat3ra/esse/models/methods_directory/mathematical/regression/per_feature_item.py +24 -0
  176. mat3ra/esse/models/methods_directory/mathematical/regression/precision.py +28 -0
  177. mat3ra/esse/models/methods_directory/mathematical/regression/precision_per_property.py +24 -0
  178. mat3ra/esse/models/methods_directory/physical/__init__.py +3 -0
  179. mat3ra/esse/models/methods_directory/physical/ao/__init__.py +3 -0
  180. mat3ra/esse/models/methods_directory/physical/ao/dunning.py +103 -0
  181. mat3ra/esse/models/methods_directory/physical/ao/enum_options.py +13 -0
  182. mat3ra/esse/models/methods_directory/physical/ao/other.py +107 -0
  183. mat3ra/esse/models/methods_directory/physical/ao/pople.py +101 -0
  184. mat3ra/esse/models/methods_directory/physical/psp/__init__.py +187 -0
  185. mat3ra/esse/models/methods_directory/physical/psp/file.py +106 -0
  186. mat3ra/esse/models/methods_directory/physical/psp/file_data_item.py +88 -0
  187. mat3ra/esse/models/methods_directory/physical/pw.py +83 -0
  188. mat3ra/esse/models/methods_directory/physical/smearing.py +90 -0
  189. mat3ra/esse/models/methods_directory/physical/tetrahedron.py +91 -0
  190. mat3ra/esse/models/model/__init__.py +43 -0
  191. mat3ra/esse/models/model/categorized_model.py +211 -0
  192. mat3ra/esse/models/model/mixins/__init__.py +3 -0
  193. mat3ra/esse/models/model/mixins/dft/__init__.py +5 -0
  194. mat3ra/esse/models/model/mixins/dft/double_hybrid_functional.py +18 -0
  195. mat3ra/esse/models/model/mixins/dft/enum_options.py +13 -0
  196. mat3ra/esse/models/model/mixins/dft/gga_functional.py +22 -0
  197. mat3ra/esse/models/model/mixins/dft/hybrid_functional.py +19 -0
  198. mat3ra/esse/models/model/mixins/dft/lda_functional.py +21 -0
  199. mat3ra/esse/models/model/mixins/dft/mgga_functional.py +21 -0
  200. mat3ra/esse/models/model/mixins/dispersion_correction.py +21 -0
  201. mat3ra/esse/models/model/mixins/enum_options.py +13 -0
  202. mat3ra/esse/models/model/mixins/hubbard.py +18 -0
  203. mat3ra/esse/models/model/mixins/spin_orbit_coupling.py +16 -0
  204. mat3ra/esse/models/model/mixins/spin_polarization.py +22 -0
  205. mat3ra/esse/models/model/model_parameters.py +123 -0
  206. mat3ra/esse/models/model/model_without_method.py +144 -0
  207. mat3ra/esse/models/models_category/__init__.py +3 -0
  208. mat3ra/esse/models/models_category/enum_options.py +13 -0
  209. mat3ra/esse/models/models_category/pb/__init__.py +48 -0
  210. mat3ra/esse/models/models_category/pb/enum_options.py +13 -0
  211. mat3ra/esse/models/models_category/pb/qm/__init__.py +52 -0
  212. mat3ra/esse/models/models_category/pb/qm/abin/__init__.py +56 -0
  213. mat3ra/esse/models/models_category/pb/qm/abin/enum_options.py +13 -0
  214. mat3ra/esse/models/models_category/pb/qm/abin/gw.py +66 -0
  215. mat3ra/esse/models/models_category/pb/qm/dft/__init__.py +56 -0
  216. mat3ra/esse/models/models_category/pb/qm/dft/enum_options.py +13 -0
  217. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/__init__.py +60 -0
  218. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/double_hybrid.py +64 -0
  219. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/enum_options.py +13 -0
  220. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/gga.py +64 -0
  221. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/hybrid.py +64 -0
  222. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/lda.py +64 -0
  223. mat3ra/esse/models/models_category/pb/qm/dft/ksdft/mgga.py +64 -0
  224. mat3ra/esse/models/models_category/pb/qm/enum_options.py +13 -0
  225. mat3ra/esse/models/models_category/pb/qm/semp.py +56 -0
  226. mat3ra/esse/models/models_category/st/__init__.py +48 -0
  227. mat3ra/esse/models/models_category/st/det/__init__.py +52 -0
  228. mat3ra/esse/models/models_category/st/det/enum_options.py +13 -0
  229. mat3ra/esse/models/models_category/st/det/ml/__init__.py +56 -0
  230. mat3ra/esse/models/models_category/st/det/ml/enum_options.py +13 -0
  231. mat3ra/esse/models/models_category/st/det/ml/re.py +60 -0
  232. mat3ra/esse/models/models_category/st/enum_options.py +13 -0
  233. mat3ra/esse/models/models_directory/__init__.py +3 -0
  234. mat3ra/esse/models/models_directory/double_hybrid.py +205 -0
  235. mat3ra/esse/models/models_directory/gga.py +219 -0
  236. mat3ra/esse/models/models_directory/gw.py +272 -0
  237. mat3ra/esse/models/models_directory/hybrid.py +213 -0
  238. mat3ra/esse/models/models_directory/lda.py +218 -0
  239. mat3ra/esse/models/models_directory/legacy/__init__.py +3 -0
  240. mat3ra/esse/models/models_directory/legacy/dft.py +170 -0
  241. mat3ra/esse/models/models_directory/legacy/ml.py +52 -0
  242. mat3ra/esse/models/models_directory/legacy/unknown.py +52 -0
  243. mat3ra/esse/models/models_directory/mgga.py +218 -0
  244. mat3ra/esse/models/models_directory/re.py +160 -0
  245. mat3ra/esse/models/project.py +82 -0
  246. mat3ra/esse/models/properties_directory/__init__.py +3 -0
  247. mat3ra/esse/models/properties_directory/derived_properties.py +140 -0
  248. mat3ra/esse/models/properties_directory/electronic_configuration.py +20 -0
  249. mat3ra/esse/models/properties_directory/elemental/__init__.py +3 -0
  250. mat3ra/esse/models/properties_directory/elemental/atomic_radius.py +34 -0
  251. mat3ra/esse/models/properties_directory/elemental/electronegativity.py +19 -0
  252. mat3ra/esse/models/properties_directory/elemental/ionization_potential.py +30 -0
  253. mat3ra/esse/models/properties_directory/non_scalar/__init__.py +3 -0
  254. mat3ra/esse/models/properties_directory/non_scalar/average_potential_profile.py +83 -0
  255. mat3ra/esse/models/properties_directory/non_scalar/band_gaps.py +64 -0
  256. mat3ra/esse/models/properties_directory/non_scalar/band_structure.py +92 -0
  257. mat3ra/esse/models/properties_directory/non_scalar/charge_density_profile.py +63 -0
  258. mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +97 -0
  259. mat3ra/esse/models/properties_directory/non_scalar/dielectric_tensor.py +40 -0
  260. mat3ra/esse/models/properties_directory/non_scalar/file_content.py +64 -0
  261. mat3ra/esse/models/properties_directory/non_scalar/hubbard_u.py +40 -0
  262. mat3ra/esse/models/properties_directory/non_scalar/hubbard_v.py +54 -0
  263. mat3ra/esse/models/properties_directory/non_scalar/hubbard_v_nn.py +54 -0
  264. mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +79 -0
  265. mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +71 -0
  266. mat3ra/esse/models/properties_directory/non_scalar/potential_profile.py +69 -0
  267. mat3ra/esse/models/properties_directory/non_scalar/reaction_energy_profile.py +69 -0
  268. mat3ra/esse/models/properties_directory/non_scalar/stress_tensor.py +31 -0
  269. mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +198 -0
  270. mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +75 -0
  271. mat3ra/esse/models/properties_directory/scalar/__init__.py +3 -0
  272. mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +34 -0
  273. mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +34 -0
  274. mat3ra/esse/models/properties_directory/scalar/formation_energy.py +34 -0
  275. mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +34 -0
  276. mat3ra/esse/models/properties_directory/scalar/pressure.py +25 -0
  277. mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +34 -0
  278. mat3ra/esse/models/properties_directory/scalar/surface_energy.py +34 -0
  279. mat3ra/esse/models/properties_directory/scalar/total_energy.py +34 -0
  280. mat3ra/esse/models/properties_directory/scalar/total_force.py +29 -0
  281. mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +34 -0
  282. mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +34 -0
  283. mat3ra/esse/models/properties_directory/structural/__init__.py +3 -0
  284. mat3ra/esse/models/properties_directory/structural/atomic_forces.py +40 -0
  285. mat3ra/esse/models/properties_directory/structural/basis/__init__.py +68 -0
  286. mat3ra/esse/models/properties_directory/structural/basis/atomic_constraints.py +30 -0
  287. mat3ra/esse/models/properties_directory/structural/basis/atomic_coordinate.py +14 -0
  288. mat3ra/esse/models/properties_directory/structural/basis/atomic_coordinates.py +39 -0
  289. mat3ra/esse/models/properties_directory/structural/basis/atomic_element.py +19 -0
  290. mat3ra/esse/models/properties_directory/structural/basis/bonds.py +40 -0
  291. mat3ra/esse/models/properties_directory/structural/density.py +24 -0
  292. mat3ra/esse/models/properties_directory/structural/elemental_ratio.py +23 -0
  293. mat3ra/esse/models/properties_directory/structural/inchi.py +19 -0
  294. mat3ra/esse/models/properties_directory/structural/inchi_key.py +19 -0
  295. mat3ra/esse/models/properties_directory/structural/lattice/__init__.py +102 -0
  296. mat3ra/esse/models/properties_directory/structural/lattice/lattice_bravais.py +71 -0
  297. mat3ra/esse/models/properties_directory/structural/lattice/lattice_vectors.py +35 -0
  298. mat3ra/esse/models/properties_directory/structural/lattice/type_enum.py +24 -0
  299. mat3ra/esse/models/properties_directory/structural/lattice/type_extended_enum.py +34 -0
  300. mat3ra/esse/models/properties_directory/structural/magnetic_moments.py +35 -0
  301. mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +70 -0
  302. mat3ra/esse/models/properties_directory/structural/p_norm.py +23 -0
  303. mat3ra/esse/models/properties_directory/structural/patterns/__init__.py +3 -0
  304. mat3ra/esse/models/properties_directory/structural/patterns/functional_group.py +37 -0
  305. mat3ra/esse/models/properties_directory/structural/patterns/ring.py +34 -0
  306. mat3ra/esse/models/properties_directory/structural/patterns/special_bond.py +33 -0
  307. mat3ra/esse/models/properties_directory/structural/symmetry.py +39 -0
  308. mat3ra/esse/models/properties_directory/structural/volume.py +24 -0
  309. mat3ra/esse/models/properties_directory/workflow/convergence/__init__.py +3 -0
  310. mat3ra/esse/models/properties_directory/workflow/convergence/electronic.py +26 -0
  311. mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +63 -0
  312. mat3ra/esse/models/properties_directory/workflow/convergence/kpoint.py +43 -0
  313. mat3ra/esse/models/property/__init__.py +3 -0
  314. mat3ra/esse/models/property/base/The_source_of_a_property/__init__.py +5 -0
  315. mat3ra/esse/models/property/base/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  316. mat3ra/esse/models/property/base/__init__.py +232 -0
  317. mat3ra/esse/models/property/meta/The_source_of_a_property/__init__.py +5 -0
  318. mat3ra/esse/models/property/meta/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  319. mat3ra/esse/models/property/meta/__init__.py +232 -0
  320. mat3ra/esse/models/property/raw/The_source_of_a_property/__init__.py +5 -0
  321. mat3ra/esse/models/property/raw/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  322. mat3ra/esse/models/property/raw/__init__.py +232 -0
  323. mat3ra/esse/models/property/source/The_source_of_a_property/__init__.py +5 -0
  324. mat3ra/esse/models/property/source/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  325. mat3ra/esse/models/property/source/__init__.py +150 -0
  326. mat3ra/esse/models/software/__init__.py +3 -0
  327. mat3ra/esse/models/software/application.py +93 -0
  328. mat3ra/esse/models/software/executable.py +97 -0
  329. mat3ra/esse/models/software/flavor.py +116 -0
  330. mat3ra/esse/models/software/template.py +77 -0
  331. mat3ra/esse/models/software_directory/ml/__init__.py +3 -0
  332. mat3ra/esse/models/software_directory/ml/exabyteml.py +28 -0
  333. mat3ra/esse/models/software_directory/ml/unit/__init__.py +3 -0
  334. mat3ra/esse/models/software_directory/ml/unit/execution/__init__.py +1348 -0
  335. mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/__init__.py +5 -0
  336. mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/cross_validate.py +381 -0
  337. mat3ra/esse/models/software_directory/ml/unit/execution/initialize.py +381 -0
  338. mat3ra/esse/models/software_directory/ml/unit/execution/score.py +374 -0
  339. mat3ra/esse/models/software_directory/ml/unit/execution/train.py +385 -0
  340. mat3ra/esse/models/software_directory/ml/unit/processing/__init__.py +328 -0
  341. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/__init__.py +199 -0
  342. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/manipulation.py +176 -0
  343. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/scale_and_reduce.py +195 -0
  344. mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/__init__.py +180 -0
  345. mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/filter_based.py +176 -0
  346. mat3ra/esse/models/software_directory/modeling/__init__.py +3 -0
  347. mat3ra/esse/models/software_directory/modeling/deepmd.py +112 -0
  348. mat3ra/esse/models/software_directory/modeling/espresso/__init__.py +39 -0
  349. mat3ra/esse/models/software_directory/modeling/espresso/arguments.py +35 -0
  350. mat3ra/esse/models/software_directory/modeling/nwchem.py +113 -0
  351. mat3ra/esse/models/software_directory/modeling/unit/__init__.py +3 -0
  352. mat3ra/esse/models/software_directory/modeling/unit/execution.py +390 -0
  353. mat3ra/esse/models/software_directory/modeling/vasp.py +117 -0
  354. mat3ra/esse/models/software_directory/scripting/__init__.py +3 -0
  355. mat3ra/esse/models/software_directory/scripting/jupyter_lab.py +115 -0
  356. mat3ra/esse/models/software_directory/scripting/python.py +129 -0
  357. mat3ra/esse/models/software_directory/scripting/shell.py +129 -0
  358. mat3ra/esse/models/software_directory/scripting/unit/__init__.py +3 -0
  359. mat3ra/esse/models/software_directory/scripting/unit/execution.py +390 -0
  360. mat3ra/esse/models/system/__init__.py +3 -0
  361. mat3ra/esse/models/system/_material.py +29 -0
  362. mat3ra/esse/models/system/_parent_job.py +29 -0
  363. mat3ra/esse/models/system/_project.py +29 -0
  364. mat3ra/esse/models/system/bankable.py +20 -0
  365. mat3ra/esse/models/system/consistency_check.py +40 -0
  366. mat3ra/esse/models/system/creator.py +29 -0
  367. mat3ra/esse/models/system/creator_account.py +28 -0
  368. mat3ra/esse/models/system/database_source.py +36 -0
  369. mat3ra/esse/models/system/defaultable.py +16 -0
  370. mat3ra/esse/models/system/description.py +17 -0
  371. mat3ra/esse/models/system/entity_reference.py +24 -0
  372. mat3ra/esse/models/system/file_source.py +28 -0
  373. mat3ra/esse/models/system/history.py +18 -0
  374. mat3ra/esse/models/system/iframe_message.py +36 -0
  375. mat3ra/esse/models/system/in_set.py +30 -0
  376. mat3ra/esse/models/system/is_multi_material.py +13 -0
  377. mat3ra/esse/models/system/is_outdated.py +13 -0
  378. mat3ra/esse/models/system/job_extended.py +36 -0
  379. mat3ra/esse/models/system/message.py +59 -0
  380. mat3ra/esse/models/system/metadata.py +13 -0
  381. mat3ra/esse/models/system/name.py +16 -0
  382. mat3ra/esse/models/system/owner.py +29 -0
  383. mat3ra/esse/models/system/path.py +16 -0
  384. mat3ra/esse/models/system/path_entity.py +20 -0
  385. mat3ra/esse/models/system/schema_version.py +16 -0
  386. mat3ra/esse/models/system/scope.py +13 -0
  387. mat3ra/esse/models/system/set.py +15 -0
  388. mat3ra/esse/models/system/sharing.py +13 -0
  389. mat3ra/esse/models/system/soft_removable.py +20 -0
  390. mat3ra/esse/models/system/status.py +20 -0
  391. mat3ra/esse/models/system/tags.py +16 -0
  392. mat3ra/esse/models/system/timestampable.py +22 -0
  393. mat3ra/esse/models/system/use_values.py +13 -0
  394. mat3ra/esse/models/third_party/db/nist_jarvis/2024.3.13/__init__.py +3 -0
  395. mat3ra/esse/models/third_party/db/nist_jarvis/2024.3.13/atoms.py +41 -0
  396. mat3ra/esse/models/third_party/db/nist_jarvis/2024.3.13/db_entry.py +55 -0
  397. mat3ra/esse/models/third_party/file/applications/espresso/7.2/__init__.py +3 -0
  398. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/__init__.py +1990 -0
  399. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/atomic_positions.py +51 -0
  400. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/atomic_species.py +34 -0
  401. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/cell.py +111 -0
  402. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/cell_parameters.py +36 -0
  403. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/control.py +169 -0
  404. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/electrons.py +139 -0
  405. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/hubbard.py +194 -0
  406. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/ions.py +422 -0
  407. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/k_points.py +73 -0
  408. mat3ra/esse/models/third_party/file/applications/espresso/7.2/pw.x/system.py +841 -0
  409. mat3ra/esse/models/workflow/__init__.py +2817 -0
  410. mat3ra/esse/models/workflow/base.py +79 -0
  411. mat3ra/esse/models/workflow/base_flow.py +180 -0
  412. mat3ra/esse/models/workflow/scope.py +14 -0
  413. mat3ra/esse/models/workflow/subworkflow/__init__.py +1472 -0
  414. mat3ra/esse/models/workflow/subworkflow/unit.py +1187 -0
  415. mat3ra/esse/models/workflow/unit/__init__.py +1415 -0
  416. mat3ra/esse/models/workflow/unit/assertion.py +149 -0
  417. mat3ra/esse/models/workflow/unit/assignment.py +165 -0
  418. mat3ra/esse/models/workflow/unit/base.py +137 -0
  419. mat3ra/esse/models/workflow/unit/condition.py +176 -0
  420. mat3ra/esse/models/workflow/unit/execution.py +374 -0
  421. mat3ra/esse/models/workflow/unit/input/__init__.py +3 -0
  422. mat3ra/esse/models/workflow/unit/input/_input.py +43 -0
  423. mat3ra/esse/models/workflow/unit/input/_inputItem.py +18 -0
  424. mat3ra/esse/models/workflow/unit/input/_inputItemId.py +21 -0
  425. mat3ra/esse/models/workflow/unit/input/_inputItemScope.py +18 -0
  426. mat3ra/esse/models/workflow/unit/input/_map_input/__init__.py +17 -0
  427. mat3ra/esse/models/workflow/unit/input/_map_input/values.py +13 -0
  428. mat3ra/esse/models/workflow/unit/io/__init__.py +254 -0
  429. mat3ra/esse/models/workflow/unit/io/api.py +27 -0
  430. mat3ra/esse/models/workflow/unit/io/db.py +39 -0
  431. mat3ra/esse/models/workflow/unit/io/object_storage.py +59 -0
  432. mat3ra/esse/models/workflow/unit/map.py +169 -0
  433. mat3ra/esse/models/workflow/unit/processing.py +153 -0
  434. mat3ra/esse/models/workflow/unit/reduce.py +160 -0
  435. mat3ra/esse/models/workflow/unit/runtime/__init__.py +3 -0
  436. mat3ra/esse/models/workflow/unit/runtime/_runtime_item_full_object.py +14 -0
  437. mat3ra/esse/models/workflow/unit/runtime/_runtime_item_name_object.py +14 -0
  438. mat3ra/esse/models/workflow/unit/runtime/_runtime_item_string.py +14 -0
  439. mat3ra/esse/models/workflow/unit/runtime/runtime_item.py +20 -0
  440. mat3ra/esse/models/workflow/unit/runtime/runtime_items.py +35 -0
  441. mat3ra/esse/models/workflow/unit/subworkflow.py +141 -0
  442. {mat3ra_esse-2024.4.8.post0.dist-info → mat3ra_esse-2024.4.8.post2.dist-info}/METADATA +1 -1
  443. mat3ra_esse-2024.4.8.post2.dist-info/RECORD +453 -0
  444. mat3ra_esse-2024.4.8.post0.dist-info/RECORD +0 -12
  445. {mat3ra_esse-2024.4.8.post0.dist-info → mat3ra_esse-2024.4.8.post2.dist-info}/LICENSE.md +0 -0
  446. {mat3ra_esse-2024.4.8.post0.dist-info → mat3ra_esse-2024.4.8.post2.dist-info}/WHEEL +0 -0
  447. {mat3ra_esse-2024.4.8.post0.dist-info → mat3ra_esse-2024.4.8.post2.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,1348 @@
1
+ # generated by datamodel-codegen:
2
+ # filename: software_directory/ml/unit/execution.json
3
+ # version: 0.25.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, RootModel
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 Name(Enum):
25
+ default = "default"
26
+ atomsTooClose = "atomsTooClose"
27
+ atomsOverlap = "atomsOverlap"
28
+
29
+
30
+ class Severity(Enum):
31
+ info = "info"
32
+ warning = "warning"
33
+ error = "error"
34
+
35
+
36
+ class ConsistencyCheck(BaseModel):
37
+ key: str
38
+ """
39
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
40
+ """
41
+ name: Name
42
+ """
43
+ Name of the consistency check that is performed, which is listed in an enum.
44
+ """
45
+ severity: Severity
46
+ """
47
+ Severity level of the problem, which is used in UI to differentiate.
48
+ """
49
+ message: str
50
+ """
51
+ Message generated by the consistency check describing the problem.
52
+ """
53
+
54
+
55
+ class ApplicationSchemaBase(BaseModel):
56
+ model_config = ConfigDict(
57
+ extra="allow",
58
+ )
59
+ shortName: Optional[str] = None
60
+ """
61
+ The short name of the application. e.g. qe
62
+ """
63
+ summary: Optional[str] = None
64
+ """
65
+ Application's short description.
66
+ """
67
+ version: Optional[str] = None
68
+ """
69
+ Application version. e.g. 5.3.5
70
+ """
71
+ build: Optional[str] = None
72
+ """
73
+ Application build. e.g. VTST
74
+ """
75
+ hasAdvancedComputeOptions: Optional[bool] = None
76
+ """
77
+ Whether advanced compute options are present
78
+ """
79
+ isLicensed: Optional[bool] = None
80
+ """
81
+ Whether licensing is present
82
+ """
83
+ field_id: Optional[str] = Field(None, alias="_id")
84
+ """
85
+ entity identity
86
+ """
87
+ slug: Optional[str] = None
88
+ """
89
+ entity slug
90
+ """
91
+ systemName: Optional[str] = None
92
+ consistencyChecks: Optional[List[ConsistencyCheck]] = None
93
+ schemaVersion: Optional[str] = "2022.8.16"
94
+ """
95
+ entity's schema version. Used to distinct between different schemas.
96
+ """
97
+ name: Optional[str] = None
98
+ """
99
+ entity name
100
+ """
101
+ isDefault: Optional[bool] = False
102
+ """
103
+ Identifies that entity is defaultable
104
+ """
105
+
106
+
107
+ class ConsistencyCheck31(BaseModel):
108
+ key: str
109
+ """
110
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
111
+ """
112
+ name: Name
113
+ """
114
+ Name of the consistency check that is performed, which is listed in an enum.
115
+ """
116
+ severity: Severity
117
+ """
118
+ Severity level of the problem, which is used in UI to differentiate.
119
+ """
120
+ message: str
121
+ """
122
+ Message generated by the consistency check describing the problem.
123
+ """
124
+
125
+
126
+ class NameResultSchema(BaseModel):
127
+ name: str
128
+ """
129
+ The name of this item. e.g. scf_accuracy
130
+ """
131
+
132
+
133
+ class ExecutableSchema(BaseModel):
134
+ name: str
135
+ """
136
+ The name of the executable. e.g. pw.x
137
+ """
138
+ applicationId: Optional[List[str]] = None
139
+ """
140
+ _ids of the application this executable belongs to
141
+ """
142
+ hasAdvancedComputeOptions: Optional[bool] = None
143
+ """
144
+ Whether advanced compute options are present
145
+ """
146
+ field_id: Optional[str] = Field(None, alias="_id")
147
+ """
148
+ entity identity
149
+ """
150
+ slug: Optional[str] = None
151
+ """
152
+ entity slug
153
+ """
154
+ systemName: Optional[str] = None
155
+ consistencyChecks: Optional[List[ConsistencyCheck31]] = None
156
+ schemaVersion: Optional[str] = "2022.8.16"
157
+ """
158
+ entity's schema version. Used to distinct between different schemas.
159
+ """
160
+ isDefault: Optional[bool] = False
161
+ """
162
+ Identifies that entity is defaultable
163
+ """
164
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
165
+ """
166
+ names of the pre-processors for this calculation
167
+ """
168
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
169
+ """
170
+ names of the post-processors for this calculation
171
+ """
172
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
173
+ """
174
+ names of the monitors for this calculation
175
+ """
176
+ results: Optional[List[Union[NameResultSchema, str]]] = None
177
+ """
178
+ names of the results for this calculation
179
+ """
180
+
181
+
182
+ class ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines(BaseModel):
183
+ model_config = ConfigDict(
184
+ extra="forbid",
185
+ )
186
+ templateId: Optional[str] = None
187
+ templateName: Optional[str] = None
188
+ name: Optional[str] = None
189
+ """
190
+ name of the resulting input file, if different than template name
191
+ """
192
+
193
+
194
+ class ConsistencyCheck32(BaseModel):
195
+ key: str
196
+ """
197
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
198
+ """
199
+ name: Name
200
+ """
201
+ Name of the consistency check that is performed, which is listed in an enum.
202
+ """
203
+ severity: Severity
204
+ """
205
+ Severity level of the problem, which is used in UI to differentiate.
206
+ """
207
+ message: str
208
+ """
209
+ Message generated by the consistency check describing the problem.
210
+ """
211
+
212
+
213
+ class FlavorSchema(BaseModel):
214
+ executableId: Optional[str] = None
215
+ """
216
+ _id of the executable this flavor belongs to
217
+ """
218
+ executableName: Optional[str] = None
219
+ """
220
+ name of the executable this flavor belongs to
221
+ """
222
+ applicationName: Optional[str] = None
223
+ """
224
+ name of the application this flavor belongs to
225
+ """
226
+ input: Optional[List[ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines]] = Field(
227
+ None, title="execution unit input schema"
228
+ )
229
+ field_id: Optional[str] = Field(None, alias="_id")
230
+ """
231
+ entity identity
232
+ """
233
+ slug: Optional[str] = None
234
+ """
235
+ entity slug
236
+ """
237
+ systemName: Optional[str] = None
238
+ consistencyChecks: Optional[List[ConsistencyCheck32]] = None
239
+ schemaVersion: Optional[str] = "2022.8.16"
240
+ """
241
+ entity's schema version. Used to distinct between different schemas.
242
+ """
243
+ name: Optional[str] = None
244
+ """
245
+ entity name
246
+ """
247
+ isDefault: Optional[bool] = False
248
+ """
249
+ Identifies that entity is defaultable
250
+ """
251
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
252
+ """
253
+ names of the pre-processors for this calculation
254
+ """
255
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
256
+ """
257
+ names of the post-processors for this calculation
258
+ """
259
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
260
+ """
261
+ names of the monitors for this calculation
262
+ """
263
+ results: Optional[List[Union[NameResultSchema, str]]] = None
264
+ """
265
+ names of the results for this calculation
266
+ """
267
+
268
+
269
+ class Status(Enum):
270
+ idle = "idle"
271
+ active = "active"
272
+ warning = "warning"
273
+ error = "error"
274
+ finished = "finished"
275
+
276
+
277
+ class ConsistencyCheck33(BaseModel):
278
+ key: str
279
+ """
280
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
281
+ """
282
+ name: Name
283
+ """
284
+ Name of the consistency check that is performed, which is listed in an enum.
285
+ """
286
+ severity: Severity
287
+ """
288
+ Severity level of the problem, which is used in UI to differentiate.
289
+ """
290
+ message: str
291
+ """
292
+ Message generated by the consistency check describing the problem.
293
+ """
294
+
295
+
296
+ class StatusTrackItem(BaseModel):
297
+ trackedAt: float
298
+ status: str
299
+ repetition: Optional[float] = None
300
+
301
+
302
+ class CrossValidationUnitSchema(BaseModel):
303
+ model_config = ConfigDict(
304
+ extra="allow",
305
+ )
306
+ input: Input
307
+ """
308
+ TODO: consider keeping executable `evaluate` and flavor `cross-validate` as before
309
+ """
310
+ type: Type
311
+ """
312
+ type of the unit
313
+ """
314
+ application: ApplicationSchemaBase = Field(..., title="application schema (base)")
315
+ executable: Optional[ExecutableSchema] = Field(None, title="executable schema")
316
+ flavor: Optional[FlavorSchema] = Field(None, title="flavor schema")
317
+ field_id: Optional[str] = Field(None, alias="_id")
318
+ """
319
+ entity identity
320
+ """
321
+ isDraft: Optional[bool] = None
322
+ name: Optional[str] = None
323
+ """
324
+ name of the unit. e.g. pw_scf
325
+ """
326
+ status: Optional[Status] = None
327
+ """
328
+ Status of the unit.
329
+ """
330
+ head: Optional[bool] = None
331
+ """
332
+ Whether this unit is the first one to be executed.
333
+ """
334
+ flowchartId: str
335
+ """
336
+ Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
337
+ """
338
+ next: Optional[str] = None
339
+ """
340
+ Next unit's flowchartId. If empty, the current unit is the last.
341
+ """
342
+ enableRender: Optional[bool] = None
343
+ """
344
+ Whether Rupy should attempt to use Jinja templating to add context variables into the unit
345
+ """
346
+ context: Optional[Dict[str, Any]] = None
347
+ slug: Optional[str] = None
348
+ """
349
+ entity slug
350
+ """
351
+ systemName: Optional[str] = None
352
+ consistencyChecks: Optional[List[ConsistencyCheck33]] = None
353
+ schemaVersion: Optional[str] = "2022.8.16"
354
+ """
355
+ entity's schema version. Used to distinct between different schemas.
356
+ """
357
+ isDefault: Optional[bool] = False
358
+ """
359
+ Identifies that entity is defaultable
360
+ """
361
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
362
+ """
363
+ names of the pre-processors for this calculation
364
+ """
365
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
366
+ """
367
+ names of the post-processors for this calculation
368
+ """
369
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
370
+ """
371
+ names of the monitors for this calculation
372
+ """
373
+ results: Optional[List[Union[NameResultSchema, str]]] = None
374
+ """
375
+ names of the results for this calculation
376
+ """
377
+ tags: Optional[List[str]] = None
378
+ """
379
+ entity tags
380
+ """
381
+ statusTrack: Optional[List[StatusTrackItem]] = None
382
+
383
+
384
+ class Input2(BaseModel):
385
+ features: List[str]
386
+ """
387
+ material features used for model fitting
388
+ """
389
+ targets: List[str]
390
+ """
391
+ target properties to train for
392
+ """
393
+
394
+
395
+ class ConsistencyCheck34(BaseModel):
396
+ key: str
397
+ """
398
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
399
+ """
400
+ name: Name
401
+ """
402
+ Name of the consistency check that is performed, which is listed in an enum.
403
+ """
404
+ severity: Severity
405
+ """
406
+ Severity level of the problem, which is used in UI to differentiate.
407
+ """
408
+ message: str
409
+ """
410
+ Message generated by the consistency check describing the problem.
411
+ """
412
+
413
+
414
+ class ApplicationSchemaBase6(BaseModel):
415
+ model_config = ConfigDict(
416
+ extra="allow",
417
+ )
418
+ shortName: Optional[str] = None
419
+ """
420
+ The short name of the application. e.g. qe
421
+ """
422
+ summary: Optional[str] = None
423
+ """
424
+ Application's short description.
425
+ """
426
+ version: Optional[str] = None
427
+ """
428
+ Application version. e.g. 5.3.5
429
+ """
430
+ build: Optional[str] = None
431
+ """
432
+ Application build. e.g. VTST
433
+ """
434
+ hasAdvancedComputeOptions: Optional[bool] = None
435
+ """
436
+ Whether advanced compute options are present
437
+ """
438
+ isLicensed: Optional[bool] = None
439
+ """
440
+ Whether licensing is present
441
+ """
442
+ field_id: Optional[str] = Field(None, alias="_id")
443
+ """
444
+ entity identity
445
+ """
446
+ slug: Optional[str] = None
447
+ """
448
+ entity slug
449
+ """
450
+ systemName: Optional[str] = None
451
+ consistencyChecks: Optional[List[ConsistencyCheck34]] = None
452
+ schemaVersion: Optional[str] = "2022.8.16"
453
+ """
454
+ entity's schema version. Used to distinct between different schemas.
455
+ """
456
+ name: Optional[str] = None
457
+ """
458
+ entity name
459
+ """
460
+ isDefault: Optional[bool] = False
461
+ """
462
+ Identifies that entity is defaultable
463
+ """
464
+
465
+
466
+ class ConsistencyCheck35(BaseModel):
467
+ key: str
468
+ """
469
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
470
+ """
471
+ name: Name
472
+ """
473
+ Name of the consistency check that is performed, which is listed in an enum.
474
+ """
475
+ severity: Severity
476
+ """
477
+ Severity level of the problem, which is used in UI to differentiate.
478
+ """
479
+ message: str
480
+ """
481
+ Message generated by the consistency check describing the problem.
482
+ """
483
+
484
+
485
+ class ExecutableSchema6(BaseModel):
486
+ name: str
487
+ """
488
+ The name of the executable. e.g. pw.x
489
+ """
490
+ applicationId: Optional[List[str]] = None
491
+ """
492
+ _ids of the application this executable belongs to
493
+ """
494
+ hasAdvancedComputeOptions: Optional[bool] = None
495
+ """
496
+ Whether advanced compute options are present
497
+ """
498
+ field_id: Optional[str] = Field(None, alias="_id")
499
+ """
500
+ entity identity
501
+ """
502
+ slug: Optional[str] = None
503
+ """
504
+ entity slug
505
+ """
506
+ systemName: Optional[str] = None
507
+ consistencyChecks: Optional[List[ConsistencyCheck35]] = None
508
+ schemaVersion: Optional[str] = "2022.8.16"
509
+ """
510
+ entity's schema version. Used to distinct between different schemas.
511
+ """
512
+ isDefault: Optional[bool] = False
513
+ """
514
+ Identifies that entity is defaultable
515
+ """
516
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
517
+ """
518
+ names of the pre-processors for this calculation
519
+ """
520
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
521
+ """
522
+ names of the post-processors for this calculation
523
+ """
524
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
525
+ """
526
+ names of the monitors for this calculation
527
+ """
528
+ results: Optional[List[Union[NameResultSchema, str]]] = None
529
+ """
530
+ names of the results for this calculation
531
+ """
532
+
533
+
534
+ class ConsistencyCheck36(BaseModel):
535
+ key: str
536
+ """
537
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
538
+ """
539
+ name: Name
540
+ """
541
+ Name of the consistency check that is performed, which is listed in an enum.
542
+ """
543
+ severity: Severity
544
+ """
545
+ Severity level of the problem, which is used in UI to differentiate.
546
+ """
547
+ message: str
548
+ """
549
+ Message generated by the consistency check describing the problem.
550
+ """
551
+
552
+
553
+ class FlavorSchema5(BaseModel):
554
+ executableId: Optional[str] = None
555
+ """
556
+ _id of the executable this flavor belongs to
557
+ """
558
+ executableName: Optional[str] = None
559
+ """
560
+ name of the executable this flavor belongs to
561
+ """
562
+ applicationName: Optional[str] = None
563
+ """
564
+ name of the application this flavor belongs to
565
+ """
566
+ input: Optional[List[ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines]] = Field(
567
+ None, title="execution unit input schema"
568
+ )
569
+ field_id: Optional[str] = Field(None, alias="_id")
570
+ """
571
+ entity identity
572
+ """
573
+ slug: Optional[str] = None
574
+ """
575
+ entity slug
576
+ """
577
+ systemName: Optional[str] = None
578
+ consistencyChecks: Optional[List[ConsistencyCheck36]] = None
579
+ schemaVersion: Optional[str] = "2022.8.16"
580
+ """
581
+ entity's schema version. Used to distinct between different schemas.
582
+ """
583
+ name: Optional[str] = None
584
+ """
585
+ entity name
586
+ """
587
+ isDefault: Optional[bool] = False
588
+ """
589
+ Identifies that entity is defaultable
590
+ """
591
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
592
+ """
593
+ names of the pre-processors for this calculation
594
+ """
595
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
596
+ """
597
+ names of the post-processors for this calculation
598
+ """
599
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
600
+ """
601
+ names of the monitors for this calculation
602
+ """
603
+ results: Optional[List[Union[NameResultSchema, str]]] = None
604
+ """
605
+ names of the results for this calculation
606
+ """
607
+
608
+
609
+ class ConsistencyCheck37(BaseModel):
610
+ key: str
611
+ """
612
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
613
+ """
614
+ name: Name
615
+ """
616
+ Name of the consistency check that is performed, which is listed in an enum.
617
+ """
618
+ severity: Severity
619
+ """
620
+ Severity level of the problem, which is used in UI to differentiate.
621
+ """
622
+ message: str
623
+ """
624
+ Message generated by the consistency check describing the problem.
625
+ """
626
+
627
+
628
+ class TrainUnitSchema(BaseModel):
629
+ model_config = ConfigDict(
630
+ extra="allow",
631
+ )
632
+ input: Input2
633
+ """
634
+ model train unit (NOTE: info about method, eg. regression/linear is taken from (sub)workflow)
635
+ """
636
+ type: Type
637
+ """
638
+ type of the unit
639
+ """
640
+ application: ApplicationSchemaBase6 = Field(..., title="application schema (base)")
641
+ executable: Optional[ExecutableSchema6] = Field(None, title="executable schema")
642
+ flavor: Optional[FlavorSchema5] = Field(None, title="flavor schema")
643
+ field_id: Optional[str] = Field(None, alias="_id")
644
+ """
645
+ entity identity
646
+ """
647
+ isDraft: Optional[bool] = None
648
+ name: Optional[str] = None
649
+ """
650
+ name of the unit. e.g. pw_scf
651
+ """
652
+ status: Optional[Status] = None
653
+ """
654
+ Status of the unit.
655
+ """
656
+ head: Optional[bool] = None
657
+ """
658
+ Whether this unit is the first one to be executed.
659
+ """
660
+ flowchartId: str
661
+ """
662
+ Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
663
+ """
664
+ next: Optional[str] = None
665
+ """
666
+ Next unit's flowchartId. If empty, the current unit is the last.
667
+ """
668
+ enableRender: Optional[bool] = None
669
+ """
670
+ Whether Rupy should attempt to use Jinja templating to add context variables into the unit
671
+ """
672
+ context: Optional[Dict[str, Any]] = None
673
+ slug: Optional[str] = None
674
+ """
675
+ entity slug
676
+ """
677
+ systemName: Optional[str] = None
678
+ consistencyChecks: Optional[List[ConsistencyCheck37]] = None
679
+ schemaVersion: Optional[str] = "2022.8.16"
680
+ """
681
+ entity's schema version. Used to distinct between different schemas.
682
+ """
683
+ isDefault: Optional[bool] = False
684
+ """
685
+ Identifies that entity is defaultable
686
+ """
687
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
688
+ """
689
+ names of the pre-processors for this calculation
690
+ """
691
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
692
+ """
693
+ names of the post-processors for this calculation
694
+ """
695
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
696
+ """
697
+ names of the monitors for this calculation
698
+ """
699
+ results: Optional[List[Union[NameResultSchema, str]]] = None
700
+ """
701
+ names of the results for this calculation
702
+ """
703
+ tags: Optional[List[str]] = None
704
+ """
705
+ entity tags
706
+ """
707
+ statusTrack: Optional[List[StatusTrackItem]] = None
708
+
709
+
710
+ class ConsistencyCheck38(BaseModel):
711
+ key: str
712
+ """
713
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
714
+ """
715
+ name: Name
716
+ """
717
+ Name of the consistency check that is performed, which is listed in an enum.
718
+ """
719
+ severity: Severity
720
+ """
721
+ Severity level of the problem, which is used in UI to differentiate.
722
+ """
723
+ message: str
724
+ """
725
+ Message generated by the consistency check describing the problem.
726
+ """
727
+
728
+
729
+ class ApplicationSchemaBase7(BaseModel):
730
+ model_config = ConfigDict(
731
+ extra="allow",
732
+ )
733
+ shortName: Optional[str] = None
734
+ """
735
+ The short name of the application. e.g. qe
736
+ """
737
+ summary: Optional[str] = None
738
+ """
739
+ Application's short description.
740
+ """
741
+ version: Optional[str] = None
742
+ """
743
+ Application version. e.g. 5.3.5
744
+ """
745
+ build: Optional[str] = None
746
+ """
747
+ Application build. e.g. VTST
748
+ """
749
+ hasAdvancedComputeOptions: Optional[bool] = None
750
+ """
751
+ Whether advanced compute options are present
752
+ """
753
+ isLicensed: Optional[bool] = None
754
+ """
755
+ Whether licensing is present
756
+ """
757
+ field_id: Optional[str] = Field(None, alias="_id")
758
+ """
759
+ entity identity
760
+ """
761
+ slug: Optional[str] = None
762
+ """
763
+ entity slug
764
+ """
765
+ systemName: Optional[str] = None
766
+ consistencyChecks: Optional[List[ConsistencyCheck38]] = None
767
+ schemaVersion: Optional[str] = "2022.8.16"
768
+ """
769
+ entity's schema version. Used to distinct between different schemas.
770
+ """
771
+ name: Optional[str] = None
772
+ """
773
+ entity name
774
+ """
775
+ isDefault: Optional[bool] = False
776
+ """
777
+ Identifies that entity is defaultable
778
+ """
779
+
780
+
781
+ class ConsistencyCheck39(BaseModel):
782
+ key: str
783
+ """
784
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
785
+ """
786
+ name: Name
787
+ """
788
+ Name of the consistency check that is performed, which is listed in an enum.
789
+ """
790
+ severity: Severity
791
+ """
792
+ Severity level of the problem, which is used in UI to differentiate.
793
+ """
794
+ message: str
795
+ """
796
+ Message generated by the consistency check describing the problem.
797
+ """
798
+
799
+
800
+ class ExecutableSchema7(BaseModel):
801
+ name: str
802
+ """
803
+ The name of the executable. e.g. pw.x
804
+ """
805
+ applicationId: Optional[List[str]] = None
806
+ """
807
+ _ids of the application this executable belongs to
808
+ """
809
+ hasAdvancedComputeOptions: Optional[bool] = None
810
+ """
811
+ Whether advanced compute options are present
812
+ """
813
+ field_id: Optional[str] = Field(None, alias="_id")
814
+ """
815
+ entity identity
816
+ """
817
+ slug: Optional[str] = None
818
+ """
819
+ entity slug
820
+ """
821
+ systemName: Optional[str] = None
822
+ consistencyChecks: Optional[List[ConsistencyCheck39]] = None
823
+ schemaVersion: Optional[str] = "2022.8.16"
824
+ """
825
+ entity's schema version. Used to distinct between different schemas.
826
+ """
827
+ isDefault: Optional[bool] = False
828
+ """
829
+ Identifies that entity is defaultable
830
+ """
831
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
832
+ """
833
+ names of the pre-processors for this calculation
834
+ """
835
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
836
+ """
837
+ names of the post-processors for this calculation
838
+ """
839
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
840
+ """
841
+ names of the monitors for this calculation
842
+ """
843
+ results: Optional[List[Union[NameResultSchema, str]]] = None
844
+ """
845
+ names of the results for this calculation
846
+ """
847
+
848
+
849
+ class ConsistencyCheck40(BaseModel):
850
+ key: str
851
+ """
852
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
853
+ """
854
+ name: Name
855
+ """
856
+ Name of the consistency check that is performed, which is listed in an enum.
857
+ """
858
+ severity: Severity
859
+ """
860
+ Severity level of the problem, which is used in UI to differentiate.
861
+ """
862
+ message: str
863
+ """
864
+ Message generated by the consistency check describing the problem.
865
+ """
866
+
867
+
868
+ class FlavorSchema6(BaseModel):
869
+ executableId: Optional[str] = None
870
+ """
871
+ _id of the executable this flavor belongs to
872
+ """
873
+ executableName: Optional[str] = None
874
+ """
875
+ name of the executable this flavor belongs to
876
+ """
877
+ applicationName: Optional[str] = None
878
+ """
879
+ name of the application this flavor belongs to
880
+ """
881
+ input: Optional[List[ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines]] = Field(
882
+ None, title="execution unit input schema"
883
+ )
884
+ field_id: Optional[str] = Field(None, alias="_id")
885
+ """
886
+ entity identity
887
+ """
888
+ slug: Optional[str] = None
889
+ """
890
+ entity slug
891
+ """
892
+ systemName: Optional[str] = None
893
+ consistencyChecks: Optional[List[ConsistencyCheck40]] = None
894
+ schemaVersion: Optional[str] = "2022.8.16"
895
+ """
896
+ entity's schema version. Used to distinct between different schemas.
897
+ """
898
+ name: Optional[str] = None
899
+ """
900
+ entity name
901
+ """
902
+ isDefault: Optional[bool] = False
903
+ """
904
+ Identifies that entity is defaultable
905
+ """
906
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
907
+ """
908
+ names of the pre-processors for this calculation
909
+ """
910
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
911
+ """
912
+ names of the post-processors for this calculation
913
+ """
914
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
915
+ """
916
+ names of the monitors for this calculation
917
+ """
918
+ results: Optional[List[Union[NameResultSchema, str]]] = None
919
+ """
920
+ names of the results for this calculation
921
+ """
922
+
923
+
924
+ class ConsistencyCheck41(BaseModel):
925
+ key: str
926
+ """
927
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
928
+ """
929
+ name: Name
930
+ """
931
+ Name of the consistency check that is performed, which is listed in an enum.
932
+ """
933
+ severity: Severity
934
+ """
935
+ Severity level of the problem, which is used in UI to differentiate.
936
+ """
937
+ message: str
938
+ """
939
+ Message generated by the consistency check describing the problem.
940
+ """
941
+
942
+
943
+ class TrainScoreSchema(BaseModel):
944
+ model_config = ConfigDict(
945
+ extra="allow",
946
+ )
947
+ input: Any
948
+ """
949
+ unit input (type to be specified by the application's execution unit)
950
+ """
951
+ type: Type
952
+ """
953
+ type of the unit
954
+ """
955
+ application: ApplicationSchemaBase7 = Field(..., title="application schema (base)")
956
+ executable: Optional[ExecutableSchema7] = Field(None, title="executable schema")
957
+ flavor: Optional[FlavorSchema6] = Field(None, title="flavor schema")
958
+ field_id: Optional[str] = Field(None, alias="_id")
959
+ """
960
+ entity identity
961
+ """
962
+ isDraft: Optional[bool] = None
963
+ name: Optional[str] = None
964
+ """
965
+ name of the unit. e.g. pw_scf
966
+ """
967
+ status: Optional[Status] = None
968
+ """
969
+ Status of the unit.
970
+ """
971
+ head: Optional[bool] = None
972
+ """
973
+ Whether this unit is the first one to be executed.
974
+ """
975
+ flowchartId: str
976
+ """
977
+ Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
978
+ """
979
+ next: Optional[str] = None
980
+ """
981
+ Next unit's flowchartId. If empty, the current unit is the last.
982
+ """
983
+ enableRender: Optional[bool] = None
984
+ """
985
+ Whether Rupy should attempt to use Jinja templating to add context variables into the unit
986
+ """
987
+ context: Optional[Dict[str, Any]] = None
988
+ slug: Optional[str] = None
989
+ """
990
+ entity slug
991
+ """
992
+ systemName: Optional[str] = None
993
+ consistencyChecks: Optional[List[ConsistencyCheck41]] = None
994
+ schemaVersion: Optional[str] = "2022.8.16"
995
+ """
996
+ entity's schema version. Used to distinct between different schemas.
997
+ """
998
+ isDefault: Optional[bool] = False
999
+ """
1000
+ Identifies that entity is defaultable
1001
+ """
1002
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1003
+ """
1004
+ names of the pre-processors for this calculation
1005
+ """
1006
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1007
+ """
1008
+ names of the post-processors for this calculation
1009
+ """
1010
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
1011
+ """
1012
+ names of the monitors for this calculation
1013
+ """
1014
+ results: Optional[List[Union[NameResultSchema, str]]] = None
1015
+ """
1016
+ names of the results for this calculation
1017
+ """
1018
+ tags: Optional[List[str]] = None
1019
+ """
1020
+ entity tags
1021
+ """
1022
+ statusTrack: Optional[List[StatusTrackItem]] = None
1023
+
1024
+
1025
+ class Input3(BaseModel):
1026
+ targets: List[str]
1027
+ """
1028
+ target properties to predict (NOTE: must be a subset of targets for which training was done)
1029
+ """
1030
+
1031
+
1032
+ class ConsistencyCheck42(BaseModel):
1033
+ key: str
1034
+ """
1035
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
1036
+ """
1037
+ name: Name
1038
+ """
1039
+ Name of the consistency check that is performed, which is listed in an enum.
1040
+ """
1041
+ severity: Severity
1042
+ """
1043
+ Severity level of the problem, which is used in UI to differentiate.
1044
+ """
1045
+ message: str
1046
+ """
1047
+ Message generated by the consistency check describing the problem.
1048
+ """
1049
+
1050
+
1051
+ class ApplicationSchemaBase8(BaseModel):
1052
+ model_config = ConfigDict(
1053
+ extra="allow",
1054
+ )
1055
+ shortName: Optional[str] = None
1056
+ """
1057
+ The short name of the application. e.g. qe
1058
+ """
1059
+ summary: Optional[str] = None
1060
+ """
1061
+ Application's short description.
1062
+ """
1063
+ version: Optional[str] = None
1064
+ """
1065
+ Application version. e.g. 5.3.5
1066
+ """
1067
+ build: Optional[str] = None
1068
+ """
1069
+ Application build. e.g. VTST
1070
+ """
1071
+ hasAdvancedComputeOptions: Optional[bool] = None
1072
+ """
1073
+ Whether advanced compute options are present
1074
+ """
1075
+ isLicensed: Optional[bool] = None
1076
+ """
1077
+ Whether licensing is present
1078
+ """
1079
+ field_id: Optional[str] = Field(None, alias="_id")
1080
+ """
1081
+ entity identity
1082
+ """
1083
+ slug: Optional[str] = None
1084
+ """
1085
+ entity slug
1086
+ """
1087
+ systemName: Optional[str] = None
1088
+ consistencyChecks: Optional[List[ConsistencyCheck42]] = None
1089
+ schemaVersion: Optional[str] = "2022.8.16"
1090
+ """
1091
+ entity's schema version. Used to distinct between different schemas.
1092
+ """
1093
+ name: Optional[str] = None
1094
+ """
1095
+ entity name
1096
+ """
1097
+ isDefault: Optional[bool] = False
1098
+ """
1099
+ Identifies that entity is defaultable
1100
+ """
1101
+
1102
+
1103
+ class ConsistencyCheck43(BaseModel):
1104
+ key: str
1105
+ """
1106
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
1107
+ """
1108
+ name: Name
1109
+ """
1110
+ Name of the consistency check that is performed, which is listed in an enum.
1111
+ """
1112
+ severity: Severity
1113
+ """
1114
+ Severity level of the problem, which is used in UI to differentiate.
1115
+ """
1116
+ message: str
1117
+ """
1118
+ Message generated by the consistency check describing the problem.
1119
+ """
1120
+
1121
+
1122
+ class ExecutableSchema8(BaseModel):
1123
+ name: str
1124
+ """
1125
+ The name of the executable. e.g. pw.x
1126
+ """
1127
+ applicationId: Optional[List[str]] = None
1128
+ """
1129
+ _ids of the application this executable belongs to
1130
+ """
1131
+ hasAdvancedComputeOptions: Optional[bool] = None
1132
+ """
1133
+ Whether advanced compute options are present
1134
+ """
1135
+ field_id: Optional[str] = Field(None, alias="_id")
1136
+ """
1137
+ entity identity
1138
+ """
1139
+ slug: Optional[str] = None
1140
+ """
1141
+ entity slug
1142
+ """
1143
+ systemName: Optional[str] = None
1144
+ consistencyChecks: Optional[List[ConsistencyCheck43]] = None
1145
+ schemaVersion: Optional[str] = "2022.8.16"
1146
+ """
1147
+ entity's schema version. Used to distinct between different schemas.
1148
+ """
1149
+ isDefault: Optional[bool] = False
1150
+ """
1151
+ Identifies that entity is defaultable
1152
+ """
1153
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1154
+ """
1155
+ names of the pre-processors for this calculation
1156
+ """
1157
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1158
+ """
1159
+ names of the post-processors for this calculation
1160
+ """
1161
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
1162
+ """
1163
+ names of the monitors for this calculation
1164
+ """
1165
+ results: Optional[List[Union[NameResultSchema, str]]] = None
1166
+ """
1167
+ names of the results for this calculation
1168
+ """
1169
+
1170
+
1171
+ class ConsistencyCheck44(BaseModel):
1172
+ key: str
1173
+ """
1174
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
1175
+ """
1176
+ name: Name
1177
+ """
1178
+ Name of the consistency check that is performed, which is listed in an enum.
1179
+ """
1180
+ severity: Severity
1181
+ """
1182
+ Severity level of the problem, which is used in UI to differentiate.
1183
+ """
1184
+ message: str
1185
+ """
1186
+ Message generated by the consistency check describing the problem.
1187
+ """
1188
+
1189
+
1190
+ class FlavorSchema7(BaseModel):
1191
+ executableId: Optional[str] = None
1192
+ """
1193
+ _id of the executable this flavor belongs to
1194
+ """
1195
+ executableName: Optional[str] = None
1196
+ """
1197
+ name of the executable this flavor belongs to
1198
+ """
1199
+ applicationName: Optional[str] = None
1200
+ """
1201
+ name of the application this flavor belongs to
1202
+ """
1203
+ input: Optional[List[ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines]] = Field(
1204
+ None, title="execution unit input schema"
1205
+ )
1206
+ field_id: Optional[str] = Field(None, alias="_id")
1207
+ """
1208
+ entity identity
1209
+ """
1210
+ slug: Optional[str] = None
1211
+ """
1212
+ entity slug
1213
+ """
1214
+ systemName: Optional[str] = None
1215
+ consistencyChecks: Optional[List[ConsistencyCheck44]] = None
1216
+ schemaVersion: Optional[str] = "2022.8.16"
1217
+ """
1218
+ entity's schema version. Used to distinct between different schemas.
1219
+ """
1220
+ name: Optional[str] = None
1221
+ """
1222
+ entity name
1223
+ """
1224
+ isDefault: Optional[bool] = False
1225
+ """
1226
+ Identifies that entity is defaultable
1227
+ """
1228
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1229
+ """
1230
+ names of the pre-processors for this calculation
1231
+ """
1232
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1233
+ """
1234
+ names of the post-processors for this calculation
1235
+ """
1236
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
1237
+ """
1238
+ names of the monitors for this calculation
1239
+ """
1240
+ results: Optional[List[Union[NameResultSchema, str]]] = None
1241
+ """
1242
+ names of the results for this calculation
1243
+ """
1244
+
1245
+
1246
+ class ConsistencyCheck45(BaseModel):
1247
+ key: str
1248
+ """
1249
+ Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
1250
+ """
1251
+ name: Name
1252
+ """
1253
+ Name of the consistency check that is performed, which is listed in an enum.
1254
+ """
1255
+ severity: Severity
1256
+ """
1257
+ Severity level of the problem, which is used in UI to differentiate.
1258
+ """
1259
+ message: str
1260
+ """
1261
+ Message generated by the consistency check describing the problem.
1262
+ """
1263
+
1264
+
1265
+ class InitializeUnitSchema(BaseModel):
1266
+ model_config = ConfigDict(
1267
+ extra="allow",
1268
+ )
1269
+ input: Input3
1270
+ """
1271
+ model init unit (NOTE: info about method, eg. regression/linear is taken from (sub)workflow)
1272
+ """
1273
+ type: Type
1274
+ """
1275
+ type of the unit
1276
+ """
1277
+ application: ApplicationSchemaBase8 = Field(..., title="application schema (base)")
1278
+ executable: Optional[ExecutableSchema8] = Field(None, title="executable schema")
1279
+ flavor: Optional[FlavorSchema7] = Field(None, title="flavor schema")
1280
+ field_id: Optional[str] = Field(None, alias="_id")
1281
+ """
1282
+ entity identity
1283
+ """
1284
+ isDraft: Optional[bool] = None
1285
+ name: Optional[str] = None
1286
+ """
1287
+ name of the unit. e.g. pw_scf
1288
+ """
1289
+ status: Optional[Status] = None
1290
+ """
1291
+ Status of the unit.
1292
+ """
1293
+ head: Optional[bool] = None
1294
+ """
1295
+ Whether this unit is the first one to be executed.
1296
+ """
1297
+ flowchartId: str
1298
+ """
1299
+ Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
1300
+ """
1301
+ next: Optional[str] = None
1302
+ """
1303
+ Next unit's flowchartId. If empty, the current unit is the last.
1304
+ """
1305
+ enableRender: Optional[bool] = None
1306
+ """
1307
+ Whether Rupy should attempt to use Jinja templating to add context variables into the unit
1308
+ """
1309
+ context: Optional[Dict[str, Any]] = None
1310
+ slug: Optional[str] = None
1311
+ """
1312
+ entity slug
1313
+ """
1314
+ systemName: Optional[str] = None
1315
+ consistencyChecks: Optional[List[ConsistencyCheck45]] = None
1316
+ schemaVersion: Optional[str] = "2022.8.16"
1317
+ """
1318
+ entity's schema version. Used to distinct between different schemas.
1319
+ """
1320
+ isDefault: Optional[bool] = False
1321
+ """
1322
+ Identifies that entity is defaultable
1323
+ """
1324
+ preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1325
+ """
1326
+ names of the pre-processors for this calculation
1327
+ """
1328
+ postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
1329
+ """
1330
+ names of the post-processors for this calculation
1331
+ """
1332
+ monitors: Optional[List[Union[NameResultSchema, str]]] = None
1333
+ """
1334
+ names of the monitors for this calculation
1335
+ """
1336
+ results: Optional[List[Union[NameResultSchema, str]]] = None
1337
+ """
1338
+ names of the results for this calculation
1339
+ """
1340
+ tags: Optional[List[str]] = None
1341
+ """
1342
+ entity tags
1343
+ """
1344
+ statusTrack: Optional[List[StatusTrackItem]] = None
1345
+
1346
+
1347
+ class ESSE(RootModel[Union[CrossValidationUnitSchema, TrainUnitSchema, TrainScoreSchema, InitializeUnitSchema]]):
1348
+ root: Union[CrossValidationUnitSchema, TrainUnitSchema, TrainScoreSchema, InitializeUnitSchema]