@mat3ra/esse 2024.3.25-6 → 2024.4.8-0

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.
Files changed (450) hide show
  1. package/.pre-commit-config.yaml +18 -5
  2. package/build_schemas.py +0 -1
  3. package/dist/js/schema/3pse/db/nist_jarvis/2024.3.13/atoms.json +2 -1
  4. package/dist/js/schema/3pse/db/nist_jarvis/2024.3.13/db_entry.json +4 -2
  5. package/dist/js/schemas.json +1 -1
  6. package/dist/js/types.ts +11 -2
  7. package/dist/py/__init__.py +3 -0
  8. package/dist/py/core/__init__.py +3 -0
  9. package/dist/py/core/abstract/2d_data.py +17 -0
  10. package/dist/py/core/abstract/2d_plot.py +34 -0
  11. package/dist/py/core/abstract/3d_grid.py +14 -0
  12. package/dist/py/core/abstract/3d_tensor.py +19 -0
  13. package/dist/py/core/abstract/3d_vector_basis.py +15 -0
  14. package/dist/py/core/abstract/__init__.py +3 -0
  15. package/dist/py/core/abstract/point.py +13 -0
  16. package/dist/py/core/abstract/vector.py +13 -0
  17. package/dist/py/core/primitive/1d_data_series.py +13 -0
  18. package/dist/py/core/primitive/3d_lattice.py +34 -0
  19. package/dist/py/core/primitive/__init__.py +3 -0
  20. package/dist/py/core/primitive/array_of_3_booleans.py +13 -0
  21. package/dist/py/core/primitive/array_of_3_numbers.py +13 -0
  22. package/dist/py/core/primitive/array_of_ids.py +23 -0
  23. package/dist/py/core/primitive/array_of_strings.py +16 -0
  24. package/dist/py/core/primitive/axis.py +20 -0
  25. package/dist/py/core/primitive/group_info.py +20 -0
  26. package/dist/py/core/primitive/integer_one_or_zero.py +11 -0
  27. package/dist/py/core/primitive/linked_list/__init__.py +33 -0
  28. package/dist/py/core/primitive/linked_list/base_node.py +31 -0
  29. package/dist/py/core/primitive/linked_list/named_node.py +35 -0
  30. package/dist/py/core/primitive/linked_list/named_node_in_group.py +43 -0
  31. package/dist/py/core/primitive/linked_list/node_with_type.py +32 -0
  32. package/dist/py/core/primitive/scalar.py +11 -0
  33. package/dist/py/core/primitive/slugified_entry.py +18 -0
  34. package/dist/py/core/primitive/slugified_entry_or_slug.py +27 -0
  35. package/dist/py/core/primitive/string.py +11 -0
  36. package/dist/py/core/reference/__init__.py +260 -0
  37. package/dist/py/core/reference/exabyte.py +24 -0
  38. package/dist/py/core/reference/experiment/__init__.py +150 -0
  39. package/dist/py/core/reference/experiment/condition.py +28 -0
  40. package/dist/py/core/reference/experiment/location.py +18 -0
  41. package/dist/py/core/reference/literature/__init__.py +86 -0
  42. package/dist/py/core/reference/literature/name.py +16 -0
  43. package/dist/py/core/reference/literature/pages.py +14 -0
  44. package/dist/py/core/reference/modeling/__init__.py +49 -0
  45. package/dist/py/core/reference/modeling/exabyte.py +42 -0
  46. package/dist/py/core/reusable/__init__.py +3 -0
  47. package/dist/py/core/reusable/atomic_data/__init__.py +3 -0
  48. package/dist/py/core/reusable/atomic_data/per_orbital.py +21 -0
  49. package/dist/py/core/reusable/atomic_data/per_orbital_pair.py +34 -0
  50. package/dist/py/core/reusable/atomic_data/value_number.py +16 -0
  51. package/dist/py/core/reusable/atomic_data/value_string.py +16 -0
  52. package/dist/py/core/reusable/atomic_data_per_orbital_numeric.py +25 -0
  53. package/dist/py/core/reusable/atomic_data_per_orbital_pair_numeric.py +38 -0
  54. package/dist/py/core/reusable/atomic_orbital.py +20 -0
  55. package/dist/py/core/reusable/atomic_scalars.py +28 -0
  56. package/dist/py/core/reusable/atomic_strings.py +24 -0
  57. package/dist/py/core/reusable/atomic_vectors.py +24 -0
  58. package/dist/py/core/reusable/band_gap.py +42 -0
  59. package/dist/py/core/reusable/categories.py +43 -0
  60. package/dist/py/core/reusable/category_path.py +14 -0
  61. package/dist/py/core/reusable/dielectric_tensor_component.py +31 -0
  62. package/dist/py/core/reusable/energy.py +30 -0
  63. package/dist/py/core/reusable/file_metadata.py +24 -0
  64. package/dist/py/core/reusable/frequency_function_matrix.py +20 -0
  65. package/dist/py/core/reusable/object_storage_container_data.py +36 -0
  66. package/dist/py/definitions/__init__.py +3 -0
  67. package/dist/py/definitions/units.py +13 -0
  68. package/dist/py/element.py +74 -0
  69. package/dist/py/in_memory_entity/__init__.py +3 -0
  70. package/dist/py/in_memory_entity/base.py +58 -0
  71. package/dist/py/in_memory_entity/defaultable.py +62 -0
  72. package/dist/py/in_memory_entity/named.py +62 -0
  73. package/dist/py/in_memory_entity/named_defaultable.py +66 -0
  74. package/dist/py/in_memory_entity/named_defaultable_has_metadata.py +67 -0
  75. package/dist/py/in_memory_entity/named_defaultable_runtime_items.py +89 -0
  76. package/dist/py/job/__init__.py +3006 -0
  77. package/dist/py/job/base.py +287 -0
  78. package/dist/py/job/compute.py +161 -0
  79. package/dist/py/material/__init__.py +420 -0
  80. package/dist/py/material/conventional.py +13 -0
  81. package/dist/py/method/__init__.py +28 -0
  82. package/dist/py/method/categorized_method.py +86 -0
  83. package/dist/py/method/method_parameters.py +48 -0
  84. package/dist/py/method/unit_method.py +70 -0
  85. package/dist/py/methods_category/mathematical/__init__.py +3 -0
  86. package/dist/py/methods_category/mathematical/diff/__init__.py +48 -0
  87. package/dist/py/methods_category/mathematical/diff/enum_options.py +13 -0
  88. package/dist/py/methods_category/mathematical/diff/fd.py +52 -0
  89. package/dist/py/methods_category/mathematical/discr/__init__.py +48 -0
  90. package/dist/py/methods_category/mathematical/discr/enum_options.py +13 -0
  91. package/dist/py/methods_category/mathematical/discr/mesh/__init__.py +52 -0
  92. package/dist/py/methods_category/mathematical/discr/mesh/enum_options.py +13 -0
  93. package/dist/py/methods_category/mathematical/discr/mesh/hybrid.py +56 -0
  94. package/dist/py/methods_category/mathematical/discr/mesh/nstruct.py +56 -0
  95. package/dist/py/methods_category/mathematical/discr/mesh/struct/__init__.py +56 -0
  96. package/dist/py/methods_category/mathematical/discr/mesh/struct/cartesian.py +60 -0
  97. package/dist/py/methods_category/mathematical/discr/mesh/struct/enum_options.py +13 -0
  98. package/dist/py/methods_category/mathematical/enum_options.py +13 -0
  99. package/dist/py/methods_category/mathematical/fapprx/__init__.py +48 -0
  100. package/dist/py/methods_category/mathematical/fapprx/basisexp.py +52 -0
  101. package/dist/py/methods_category/mathematical/fapprx/enum_options.py +13 -0
  102. package/dist/py/methods_category/mathematical/fapprx/ipol/__init__.py +52 -0
  103. package/dist/py/methods_category/mathematical/fapprx/ipol/enum_options.py +13 -0
  104. package/dist/py/methods_category/mathematical/fapprx/ipol/lin.py +56 -0
  105. package/dist/py/methods_category/mathematical/fapprx/ipol/poly.py +56 -0
  106. package/dist/py/methods_category/mathematical/fapprx/ipol/spline.py +56 -0
  107. package/dist/py/methods_category/mathematical/intgr/__init__.py +48 -0
  108. package/dist/py/methods_category/mathematical/intgr/analytic/__init__.py +52 -0
  109. package/dist/py/methods_category/mathematical/intgr/analytic/enum_options.py +13 -0
  110. package/dist/py/methods_category/mathematical/intgr/analytic/volume.py +67 -0
  111. package/dist/py/methods_category/mathematical/intgr/diffeq/__init__.py +52 -0
  112. package/dist/py/methods_category/mathematical/intgr/diffeq/enum_options.py +13 -0
  113. package/dist/py/methods_category/mathematical/intgr/diffeq/order1.py +56 -0
  114. package/dist/py/methods_category/mathematical/intgr/diffeq/order2.py +56 -0
  115. package/dist/py/methods_category/mathematical/intgr/enum_options.py +13 -0
  116. package/dist/py/methods_category/mathematical/intgr/numquad/__init__.py +52 -0
  117. package/dist/py/methods_category/mathematical/intgr/numquad/enum_options.py +13 -0
  118. package/dist/py/methods_category/mathematical/intgr/numquad/gauss.py +56 -0
  119. package/dist/py/methods_category/mathematical/intgr/numquad/newcot.py +56 -0
  120. package/dist/py/methods_category/mathematical/intgr/transf/__init__.py +52 -0
  121. package/dist/py/methods_category/mathematical/intgr/transf/enum_options.py +13 -0
  122. package/dist/py/methods_category/mathematical/intgr/transf/fourier.py +56 -0
  123. package/dist/py/methods_category/mathematical/linalg/__init__.py +48 -0
  124. package/dist/py/methods_category/mathematical/linalg/dcomp.py +52 -0
  125. package/dist/py/methods_category/mathematical/linalg/diag/__init__.py +52 -0
  126. package/dist/py/methods_category/mathematical/linalg/diag/davidson.py +56 -0
  127. package/dist/py/methods_category/mathematical/linalg/diag/enum_options.py +13 -0
  128. package/dist/py/methods_category/mathematical/linalg/enum_options.py +13 -0
  129. package/dist/py/methods_category/mathematical/linalg/lintra.py +52 -0
  130. package/dist/py/methods_category/mathematical/linalg/matf.py +52 -0
  131. package/dist/py/methods_category/mathematical/opt/__init__.py +48 -0
  132. package/dist/py/methods_category/mathematical/opt/diff/__init__.py +52 -0
  133. package/dist/py/methods_category/mathematical/opt/diff/bracket.py +56 -0
  134. package/dist/py/methods_category/mathematical/opt/diff/enum_options.py +13 -0
  135. package/dist/py/methods_category/mathematical/opt/diff/local.py +56 -0
  136. package/dist/py/methods_category/mathematical/opt/diff/order1.py +56 -0
  137. package/dist/py/methods_category/mathematical/opt/diff/order2.py +56 -0
  138. package/dist/py/methods_category/mathematical/opt/diff/ordern/__init__.py +56 -0
  139. package/dist/py/methods_category/mathematical/opt/diff/ordern/cg.py +60 -0
  140. package/dist/py/methods_category/mathematical/opt/diff/ordern/enum_options.py +13 -0
  141. package/dist/py/methods_category/mathematical/opt/enum_options.py +13 -0
  142. package/dist/py/methods_category/mathematical/opt/ndiff/__init__.py +52 -0
  143. package/dist/py/methods_category/mathematical/opt/ndiff/direct.py +56 -0
  144. package/dist/py/methods_category/mathematical/opt/ndiff/enum_options.py +13 -0
  145. package/dist/py/methods_category/mathematical/opt/ndiff/pop.py +56 -0
  146. package/dist/py/methods_category/mathematical/opt/ndiff/stoch.py +56 -0
  147. package/dist/py/methods_category/mathematical/opt/root/__init__.py +52 -0
  148. package/dist/py/methods_category/mathematical/opt/root/bracket.py +56 -0
  149. package/dist/py/methods_category/mathematical/opt/root/enum_options.py +13 -0
  150. package/dist/py/methods_category/mathematical/opt/root/iter.py +56 -0
  151. package/dist/py/methods_category/mathematical/regression.py +54 -0
  152. package/dist/py/methods_category/physical/__init__.py +3 -0
  153. package/dist/py/methods_category/physical/enum_options.py +13 -0
  154. package/dist/py/methods_category/physical/qm/__init__.py +48 -0
  155. package/dist/py/methods_category/physical/qm/enum_options.py +13 -0
  156. package/dist/py/methods_category/physical/qm/wf/__init__.py +52 -0
  157. package/dist/py/methods_category/physical/qm/wf/ao/__init__.py +62 -0
  158. package/dist/py/methods_category/physical/qm/wf/ao/dunning.py +60 -0
  159. package/dist/py/methods_category/physical/qm/wf/ao/other.py +60 -0
  160. package/dist/py/methods_category/physical/qm/wf/ao/pople.py +60 -0
  161. package/dist/py/methods_category/physical/qm/wf/enum_options.py +13 -0
  162. package/dist/py/methods_category/physical/qm/wf/psp.py +63 -0
  163. package/dist/py/methods_category/physical/qm/wf/pw.py +56 -0
  164. package/dist/py/methods_category/physical/qm/wf/smearing.py +63 -0
  165. package/dist/py/methods_category/physical/qm/wf/tetrahedron.py +62 -0
  166. package/dist/py/methods_directory/legacy/__init__.py +3 -0
  167. package/dist/py/methods_directory/legacy/localorbital.py +37 -0
  168. package/dist/py/methods_directory/legacy/pseudopotential.py +40 -0
  169. package/dist/py/methods_directory/legacy/regression.py +118 -0
  170. package/dist/py/methods_directory/legacy/unknown.py +37 -0
  171. package/dist/py/methods_directory/mathematical/__init__.py +3 -0
  172. package/dist/py/methods_directory/mathematical/cg.py +87 -0
  173. package/dist/py/methods_directory/mathematical/davidson.py +83 -0
  174. package/dist/py/methods_directory/mathematical/regression/__init__.py +161 -0
  175. package/dist/py/methods_directory/mathematical/regression/data.py +69 -0
  176. package/dist/py/methods_directory/mathematical/regression/dataset.py +20 -0
  177. package/dist/py/methods_directory/mathematical/regression/kernel_ridge/__init__.py +3 -0
  178. package/dist/py/methods_directory/mathematical/regression/kernel_ridge/data_per_property.py +39 -0
  179. package/dist/py/methods_directory/mathematical/regression/linear/__init__.py +3 -0
  180. package/dist/py/methods_directory/mathematical/regression/linear/data_per_property.py +35 -0
  181. package/dist/py/methods_directory/mathematical/regression/per_feature_item.py +24 -0
  182. package/dist/py/methods_directory/mathematical/regression/precision.py +28 -0
  183. package/dist/py/methods_directory/mathematical/regression/precision_per_property.py +24 -0
  184. package/dist/py/methods_directory/physical/__init__.py +3 -0
  185. package/dist/py/methods_directory/physical/ao/__init__.py +3 -0
  186. package/dist/py/methods_directory/physical/ao/dunning.py +103 -0
  187. package/dist/py/methods_directory/physical/ao/enum_options.py +13 -0
  188. package/dist/py/methods_directory/physical/ao/other.py +107 -0
  189. package/dist/py/methods_directory/physical/ao/pople.py +101 -0
  190. package/dist/py/methods_directory/physical/psp/__init__.py +187 -0
  191. package/dist/py/methods_directory/physical/psp/file.py +106 -0
  192. package/dist/py/methods_directory/physical/psp/file_data_item.py +88 -0
  193. package/dist/py/methods_directory/physical/pw.py +83 -0
  194. package/dist/py/methods_directory/physical/smearing.py +90 -0
  195. package/dist/py/methods_directory/physical/tetrahedron.py +91 -0
  196. package/dist/py/model/__init__.py +43 -0
  197. package/dist/py/model/categorized_model.py +211 -0
  198. package/dist/py/model/mixins/__init__.py +3 -0
  199. package/dist/py/model/mixins/dft/__init__.py +5 -0
  200. package/dist/py/model/mixins/dft/double_hybrid_functional.py +18 -0
  201. package/dist/py/model/mixins/dft/enum_options.py +13 -0
  202. package/dist/py/model/mixins/dft/gga_functional.py +22 -0
  203. package/dist/py/model/mixins/dft/hybrid_functional.py +19 -0
  204. package/dist/py/model/mixins/dft/lda_functional.py +21 -0
  205. package/dist/py/model/mixins/dft/mgga_functional.py +21 -0
  206. package/dist/py/model/mixins/dispersion_correction.py +21 -0
  207. package/dist/py/model/mixins/enum_options.py +13 -0
  208. package/dist/py/model/mixins/hubbard.py +18 -0
  209. package/dist/py/model/mixins/spin_orbit_coupling.py +16 -0
  210. package/dist/py/model/mixins/spin_polarization.py +22 -0
  211. package/dist/py/model/model_parameters.py +123 -0
  212. package/dist/py/model/model_without_method.py +144 -0
  213. package/dist/py/models_category/__init__.py +3 -0
  214. package/dist/py/models_category/enum_options.py +13 -0
  215. package/dist/py/models_category/pb/__init__.py +48 -0
  216. package/dist/py/models_category/pb/enum_options.py +13 -0
  217. package/dist/py/models_category/pb/qm/__init__.py +52 -0
  218. package/dist/py/models_category/pb/qm/abin/__init__.py +56 -0
  219. package/dist/py/models_category/pb/qm/abin/enum_options.py +13 -0
  220. package/dist/py/models_category/pb/qm/abin/gw.py +66 -0
  221. package/dist/py/models_category/pb/qm/dft/__init__.py +56 -0
  222. package/dist/py/models_category/pb/qm/dft/enum_options.py +13 -0
  223. package/dist/py/models_category/pb/qm/dft/ksdft/__init__.py +60 -0
  224. package/dist/py/models_category/pb/qm/dft/ksdft/double_hybrid.py +64 -0
  225. package/dist/py/models_category/pb/qm/dft/ksdft/enum_options.py +13 -0
  226. package/dist/py/models_category/pb/qm/dft/ksdft/gga.py +64 -0
  227. package/dist/py/models_category/pb/qm/dft/ksdft/hybrid.py +64 -0
  228. package/dist/py/models_category/pb/qm/dft/ksdft/lda.py +64 -0
  229. package/dist/py/models_category/pb/qm/dft/ksdft/mgga.py +64 -0
  230. package/dist/py/models_category/pb/qm/enum_options.py +13 -0
  231. package/dist/py/models_category/pb/qm/semp.py +56 -0
  232. package/dist/py/models_category/st/__init__.py +48 -0
  233. package/dist/py/models_category/st/det/__init__.py +52 -0
  234. package/dist/py/models_category/st/det/enum_options.py +13 -0
  235. package/dist/py/models_category/st/det/ml/__init__.py +56 -0
  236. package/dist/py/models_category/st/det/ml/enum_options.py +13 -0
  237. package/dist/py/models_category/st/det/ml/re.py +60 -0
  238. package/dist/py/models_category/st/enum_options.py +13 -0
  239. package/dist/py/models_directory/__init__.py +3 -0
  240. package/dist/py/models_directory/double_hybrid.py +205 -0
  241. package/dist/py/models_directory/gga.py +219 -0
  242. package/dist/py/models_directory/gw.py +272 -0
  243. package/dist/py/models_directory/hybrid.py +213 -0
  244. package/dist/py/models_directory/lda.py +218 -0
  245. package/dist/py/models_directory/legacy/__init__.py +3 -0
  246. package/dist/py/models_directory/legacy/dft.py +170 -0
  247. package/dist/py/models_directory/legacy/ml.py +52 -0
  248. package/dist/py/models_directory/legacy/unknown.py +52 -0
  249. package/dist/py/models_directory/mgga.py +218 -0
  250. package/dist/py/models_directory/re.py +160 -0
  251. package/dist/py/project.py +82 -0
  252. package/dist/py/properties_directory/__init__.py +3 -0
  253. package/dist/py/properties_directory/derived_properties.py +140 -0
  254. package/dist/py/properties_directory/electronic_configuration.py +20 -0
  255. package/dist/py/properties_directory/elemental/__init__.py +3 -0
  256. package/dist/py/properties_directory/elemental/atomic_radius.py +34 -0
  257. package/dist/py/properties_directory/elemental/electronegativity.py +19 -0
  258. package/dist/py/properties_directory/elemental/ionization_potential.py +30 -0
  259. package/dist/py/properties_directory/non_scalar/__init__.py +3 -0
  260. package/dist/py/properties_directory/non_scalar/average_potential_profile.py +83 -0
  261. package/dist/py/properties_directory/non_scalar/band_gaps.py +64 -0
  262. package/dist/py/properties_directory/non_scalar/band_structure.py +92 -0
  263. package/dist/py/properties_directory/non_scalar/charge_density_profile.py +63 -0
  264. package/dist/py/properties_directory/non_scalar/density_of_states.py +97 -0
  265. package/dist/py/properties_directory/non_scalar/dielectric_tensor.py +40 -0
  266. package/dist/py/properties_directory/non_scalar/file_content.py +64 -0
  267. package/dist/py/properties_directory/non_scalar/hubbard_u.py +40 -0
  268. package/dist/py/properties_directory/non_scalar/hubbard_v.py +54 -0
  269. package/dist/py/properties_directory/non_scalar/hubbard_v_nn.py +54 -0
  270. package/dist/py/properties_directory/non_scalar/phonon_dispersions.py +79 -0
  271. package/dist/py/properties_directory/non_scalar/phonon_dos.py +71 -0
  272. package/dist/py/properties_directory/non_scalar/potential_profile.py +69 -0
  273. package/dist/py/properties_directory/non_scalar/reaction_energy_profile.py +69 -0
  274. package/dist/py/properties_directory/non_scalar/stress_tensor.py +31 -0
  275. package/dist/py/properties_directory/non_scalar/total_energy_contributions.py +198 -0
  276. package/dist/py/properties_directory/non_scalar/vibrational_spectrum.py +75 -0
  277. package/dist/py/properties_directory/scalar/__init__.py +3 -0
  278. package/dist/py/properties_directory/scalar/electron_affinity.py +34 -0
  279. package/dist/py/properties_directory/scalar/fermi_energy.py +34 -0
  280. package/dist/py/properties_directory/scalar/formation_energy.py +34 -0
  281. package/dist/py/properties_directory/scalar/ionization_potential.py +34 -0
  282. package/dist/py/properties_directory/scalar/pressure.py +25 -0
  283. package/dist/py/properties_directory/scalar/reaction_energy_barrier.py +34 -0
  284. package/dist/py/properties_directory/scalar/surface_energy.py +34 -0
  285. package/dist/py/properties_directory/scalar/total_energy.py +34 -0
  286. package/dist/py/properties_directory/scalar/total_force.py +29 -0
  287. package/dist/py/properties_directory/scalar/valence_band_offset.py +34 -0
  288. package/dist/py/properties_directory/scalar/zero_point_energy.py +34 -0
  289. package/dist/py/properties_directory/structural/__init__.py +3 -0
  290. package/dist/py/properties_directory/structural/atomic_forces.py +40 -0
  291. package/dist/py/properties_directory/structural/basis/__init__.py +68 -0
  292. package/dist/py/properties_directory/structural/basis/atomic_constraints.py +30 -0
  293. package/dist/py/properties_directory/structural/basis/atomic_coordinate.py +14 -0
  294. package/dist/py/properties_directory/structural/basis/atomic_coordinates.py +39 -0
  295. package/dist/py/properties_directory/structural/basis/atomic_element.py +19 -0
  296. package/dist/py/properties_directory/structural/basis/bonds.py +40 -0
  297. package/dist/py/properties_directory/structural/density.py +24 -0
  298. package/dist/py/properties_directory/structural/elemental_ratio.py +23 -0
  299. package/dist/py/properties_directory/structural/inchi.py +19 -0
  300. package/dist/py/properties_directory/structural/inchi_key.py +19 -0
  301. package/dist/py/properties_directory/structural/lattice/__init__.py +102 -0
  302. package/dist/py/properties_directory/structural/lattice/lattice_bravais.py +71 -0
  303. package/dist/py/properties_directory/structural/lattice/lattice_vectors.py +35 -0
  304. package/dist/py/properties_directory/structural/lattice/type_enum.py +24 -0
  305. package/dist/py/properties_directory/structural/lattice/type_extended_enum.py +34 -0
  306. package/dist/py/properties_directory/structural/magnetic_moments.py +35 -0
  307. package/dist/py/properties_directory/structural/molecular_pattern.py +70 -0
  308. package/dist/py/properties_directory/structural/p_norm.py +23 -0
  309. package/dist/py/properties_directory/structural/patterns/__init__.py +3 -0
  310. package/dist/py/properties_directory/structural/patterns/functional_group.py +37 -0
  311. package/dist/py/properties_directory/structural/patterns/ring.py +34 -0
  312. package/dist/py/properties_directory/structural/patterns/special_bond.py +33 -0
  313. package/dist/py/properties_directory/structural/symmetry.py +39 -0
  314. package/dist/py/properties_directory/structural/volume.py +24 -0
  315. package/dist/py/properties_directory/workflow/convergence/__init__.py +3 -0
  316. package/dist/py/properties_directory/workflow/convergence/electronic.py +26 -0
  317. package/dist/py/properties_directory/workflow/convergence/ionic.py +63 -0
  318. package/dist/py/properties_directory/workflow/convergence/kpoint.py +43 -0
  319. package/dist/py/property/__init__.py +3 -0
  320. package/dist/py/property/base/The_source_of_a_property/__init__.py +5 -0
  321. package/dist/py/property/base/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  322. package/dist/py/property/base/__init__.py +232 -0
  323. package/dist/py/property/meta/The_source_of_a_property/__init__.py +5 -0
  324. package/dist/py/property/meta/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  325. package/dist/py/property/meta/__init__.py +232 -0
  326. package/dist/py/property/raw/The_source_of_a_property/__init__.py +5 -0
  327. package/dist/py/property/raw/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  328. package/dist/py/property/raw/__init__.py +232 -0
  329. package/dist/py/property/source/The_source_of_a_property/__init__.py +5 -0
  330. package/dist/py/property/source/The_source_of_a_property/field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.py +38 -0
  331. package/dist/py/property/source/__init__.py +150 -0
  332. package/dist/py/software/__init__.py +3 -0
  333. package/dist/py/software/application.py +93 -0
  334. package/dist/py/software/executable.py +97 -0
  335. package/dist/py/software/flavor.py +116 -0
  336. package/dist/py/software/template.py +77 -0
  337. package/dist/py/software_directory/ml/__init__.py +3 -0
  338. package/dist/py/software_directory/ml/exabyteml.py +28 -0
  339. package/dist/py/software_directory/ml/unit/__init__.py +3 -0
  340. package/dist/py/software_directory/ml/unit/execution/__init__.py +1348 -0
  341. package/dist/py/software_directory/ml/unit/execution/evaluate/__init__.py +5 -0
  342. package/dist/py/software_directory/ml/unit/execution/evaluate/cross_validate.py +381 -0
  343. package/dist/py/software_directory/ml/unit/execution/initialize.py +381 -0
  344. package/dist/py/software_directory/ml/unit/execution/score.py +374 -0
  345. package/dist/py/software_directory/ml/unit/execution/train.py +385 -0
  346. package/dist/py/software_directory/ml/unit/processing/__init__.py +328 -0
  347. package/dist/py/software_directory/ml/unit/processing/data_transformation/__init__.py +199 -0
  348. package/dist/py/software_directory/ml/unit/processing/data_transformation/manipulation.py +176 -0
  349. package/dist/py/software_directory/ml/unit/processing/data_transformation/scale_and_reduce.py +195 -0
  350. package/dist/py/software_directory/ml/unit/processing/feature_selection/__init__.py +180 -0
  351. package/dist/py/software_directory/ml/unit/processing/feature_selection/filter_based.py +176 -0
  352. package/dist/py/software_directory/modeling/__init__.py +3 -0
  353. package/dist/py/software_directory/modeling/deepmd.py +112 -0
  354. package/dist/py/software_directory/modeling/espresso/__init__.py +39 -0
  355. package/dist/py/software_directory/modeling/espresso/arguments.py +35 -0
  356. package/dist/py/software_directory/modeling/nwchem.py +113 -0
  357. package/dist/py/software_directory/modeling/unit/__init__.py +3 -0
  358. package/dist/py/software_directory/modeling/unit/execution.py +390 -0
  359. package/dist/py/software_directory/modeling/vasp.py +117 -0
  360. package/dist/py/software_directory/scripting/__init__.py +3 -0
  361. package/dist/py/software_directory/scripting/jupyter_lab.py +115 -0
  362. package/dist/py/software_directory/scripting/python.py +129 -0
  363. package/dist/py/software_directory/scripting/shell.py +129 -0
  364. package/dist/py/software_directory/scripting/unit/__init__.py +3 -0
  365. package/dist/py/software_directory/scripting/unit/execution.py +390 -0
  366. package/dist/py/system/__init__.py +3 -0
  367. package/dist/py/system/_material.py +29 -0
  368. package/dist/py/system/_parent_job.py +29 -0
  369. package/dist/py/system/_project.py +29 -0
  370. package/dist/py/system/bankable.py +20 -0
  371. package/dist/py/system/consistency_check.py +40 -0
  372. package/dist/py/system/creator.py +29 -0
  373. package/dist/py/system/creator_account.py +28 -0
  374. package/dist/py/system/database_source.py +36 -0
  375. package/dist/py/system/defaultable.py +16 -0
  376. package/dist/py/system/description.py +17 -0
  377. package/dist/py/system/entity_reference.py +24 -0
  378. package/dist/py/system/file_source.py +28 -0
  379. package/dist/py/system/history.py +18 -0
  380. package/dist/py/system/iframe_message.py +36 -0
  381. package/dist/py/system/in_set.py +30 -0
  382. package/dist/py/system/is_multi_material.py +13 -0
  383. package/dist/py/system/is_outdated.py +13 -0
  384. package/dist/py/system/job_extended.py +36 -0
  385. package/dist/py/system/message.py +59 -0
  386. package/dist/py/system/metadata.py +13 -0
  387. package/dist/py/system/name.py +16 -0
  388. package/dist/py/system/owner.py +29 -0
  389. package/dist/py/system/path.py +16 -0
  390. package/dist/py/system/path_entity.py +20 -0
  391. package/dist/py/system/schema_version.py +16 -0
  392. package/dist/py/system/scope.py +13 -0
  393. package/dist/py/system/set.py +15 -0
  394. package/dist/py/system/sharing.py +13 -0
  395. package/dist/py/system/soft_removable.py +20 -0
  396. package/dist/py/system/status.py +20 -0
  397. package/dist/py/system/tags.py +16 -0
  398. package/dist/py/system/timestampable.py +22 -0
  399. package/dist/py/system/use_values.py +13 -0
  400. package/dist/py/third_party/db/nist_jarvis/2024.3.13/__init__.py +3 -0
  401. package/dist/py/third_party/db/nist_jarvis/2024.3.13/atoms.py +41 -0
  402. package/dist/py/third_party/db/nist_jarvis/2024.3.13/db_entry.py +55 -0
  403. package/dist/py/third_party/file/applications/espresso/7.2/__init__.py +3 -0
  404. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/__init__.py +1990 -0
  405. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/atomic_positions.py +51 -0
  406. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/atomic_species.py +34 -0
  407. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/cell.py +111 -0
  408. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/cell_parameters.py +36 -0
  409. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/control.py +169 -0
  410. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/electrons.py +139 -0
  411. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/hubbard.py +194 -0
  412. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/ions.py +422 -0
  413. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/k_points.py +73 -0
  414. package/dist/py/third_party/file/applications/espresso/7.2/pw.x/system.py +841 -0
  415. package/dist/py/workflow/__init__.py +2817 -0
  416. package/dist/py/workflow/base.py +79 -0
  417. package/dist/py/workflow/base_flow.py +180 -0
  418. package/dist/py/workflow/scope.py +14 -0
  419. package/dist/py/workflow/subworkflow/__init__.py +1472 -0
  420. package/dist/py/workflow/subworkflow/unit.py +1187 -0
  421. package/dist/py/workflow/unit/__init__.py +1415 -0
  422. package/dist/py/workflow/unit/assertion.py +149 -0
  423. package/dist/py/workflow/unit/assignment.py +165 -0
  424. package/dist/py/workflow/unit/base.py +137 -0
  425. package/dist/py/workflow/unit/condition.py +176 -0
  426. package/dist/py/workflow/unit/execution.py +374 -0
  427. package/dist/py/workflow/unit/input/__init__.py +3 -0
  428. package/dist/py/workflow/unit/input/_input.py +43 -0
  429. package/dist/py/workflow/unit/input/_inputItem.py +18 -0
  430. package/dist/py/workflow/unit/input/_inputItemId.py +21 -0
  431. package/dist/py/workflow/unit/input/_inputItemScope.py +18 -0
  432. package/dist/py/workflow/unit/input/_map_input/__init__.py +17 -0
  433. package/dist/py/workflow/unit/input/_map_input/values.py +13 -0
  434. package/dist/py/workflow/unit/io/__init__.py +254 -0
  435. package/dist/py/workflow/unit/io/api.py +27 -0
  436. package/dist/py/workflow/unit/io/db.py +39 -0
  437. package/dist/py/workflow/unit/io/object_storage.py +59 -0
  438. package/dist/py/workflow/unit/map.py +169 -0
  439. package/dist/py/workflow/unit/processing.py +153 -0
  440. package/dist/py/workflow/unit/reduce.py +160 -0
  441. package/dist/py/workflow/unit/runtime/__init__.py +3 -0
  442. package/dist/py/workflow/unit/runtime/_runtime_item_full_object.py +14 -0
  443. package/dist/py/workflow/unit/runtime/_runtime_item_name_object.py +14 -0
  444. package/dist/py/workflow/unit/runtime/_runtime_item_string.py +14 -0
  445. package/dist/py/workflow/unit/runtime/runtime_item.py +20 -0
  446. package/dist/py/workflow/unit/runtime/runtime_items.py +35 -0
  447. package/dist/py/workflow/unit/subworkflow.py +141 -0
  448. package/package.json +1 -1
  449. package/schema/3pse/db/nist_jarvis/2024.3.13/atoms.json +2 -1
  450. package/schema/3pse/db/nist_jarvis/2024.3.13/db_entry.json +2 -1
@@ -3,18 +3,31 @@ repos:
3
3
  rev: 2023.6.13
4
4
  hooks:
5
5
  - id: ruff
6
- exclude: ^src/py/mat3ra/esse/data
6
+ exclude: ^src/py/mat3ra/esse/data|^dist*
7
7
  - id: black
8
- exclude: ^src/py/mat3ra/esse/data
8
+ exclude: ^src/py/mat3ra/esse/data|^dist*
9
9
  - repo: local
10
10
  hooks:
11
+ # Note: only python 3.8.12 is tested for the model generation
11
12
  - id: generate-python-modules
12
13
  name: Regenerate data modules classes from static assets
13
14
  # yamllint disable rule:line-length
14
15
  entry: |
15
- bash -c 'if ! [ "$(git diff --cached --name-only | grep -e "example|schema")" ]; then echo "Skipping model generation because static files were not changed."; exit 0; fi'
16
- bash -c 'python build_schemas.py'
17
- # yamllint enable rule:line-length
16
+ bash -c 'if ! [ "$(git diff --cached --name-only | grep "schema/")" ]; then echo "Skipping model generation because schemas were not changed."; exit 0; fi && \
17
+ datamodel-codegen \
18
+ --input ./dist/js/schema/ \
19
+ --input-file-type jsonschema \
20
+ --output ./dist/py \
21
+ --output-model-type pydantic_v2.BaseModel \
22
+ --use-field-description \
23
+ --use-double-quotes \
24
+ --enable-version-header \
25
+ --use-title-as-name \
26
+ --class-name ESSE \
27
+ --disable-timestamp && \
28
+ # Move 3rd party modules to a separate directory with a PEP8 compliant name
29
+ rm -rf ./dist/py/third_party && \
30
+ mv ./dist/py/3pse ./dist/py/third_party'
18
31
  language: system
19
32
  pass_filenames: false
20
33
  verbose: true
package/build_schemas.py CHANGED
@@ -58,4 +58,3 @@ for example in EXAMPLES:
58
58
  Path(full_path).parent.mkdir(parents=True, exist_ok=True)
59
59
  with open(full_path, "w") as f:
60
60
  f.write(json.dumps(example, sort_keys=True, indent=4, separators=(",", ": ")))
61
-
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "$id": "3pse/db/nist-jarvis/2024.3.13/atoms",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571",
4
+ "title": "NIST JARVIS Atoms schema",
5
+ "description": "NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571",
5
6
  "type": "object",
6
7
  "additionalProperties": false,
7
8
  "properties": {
@@ -1,13 +1,15 @@
1
1
  {
2
2
  "$id": "3pse/db/nist-jarvis/2024.3.13/db-entry",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
- "title": "NIST J.A.R.V.I.S. db entry schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571",
4
+ "title": "NIST JARVIS Atoms schema",
5
+ "description": "NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571",
5
6
  "type": "object",
6
7
  "additionalProperties": true,
7
8
  "properties": {
8
9
  "atoms": {
9
10
  "$schema": "http://json-schema.org/draft-07/schema#",
10
- "title": "NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571",
11
+ "title": "NIST JARVIS Atoms schema",
12
+ "description": "NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571",
11
13
  "type": "object",
12
14
  "additionalProperties": false,
13
15
  "properties": {