@mat3ra/made 2026.8.13-0 → 2026.8.26-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 (493) hide show
  1. package/package.json +9 -5
  2. package/.babelrc +0 -10
  3. package/.eslintrc.json +0 -11
  4. package/.gitattributes +0 -1
  5. package/.husky/post-checkout +0 -3
  6. package/.husky/post-commit +0 -3
  7. package/.husky/post-merge +0 -3
  8. package/.husky/pre-commit +0 -6
  9. package/.husky/pre-push +0 -3
  10. package/.mocharc.json +0 -5
  11. package/.pre-commit-config.yaml +0 -26
  12. package/.prettierignore +0 -2
  13. package/.prettierrc +0 -6
  14. package/AGENTS.md +0 -133
  15. package/MANIFEST.in +0 -1
  16. package/data/constants.json +0 -13
  17. package/data/reciprocal_paths.json +0 -111
  18. package/images/made/tools/tools_diagram_general.png +0 -3
  19. package/images/made/tools/tools_diagram_interface.png +0 -3
  20. package/pyproject.toml +0 -123
  21. package/scripts/generate-mixins.ts +0 -28
  22. package/src/__init__.py +0 -0
  23. package/src/js/Material.ts +0 -618
  24. package/src/js/basis/basis.ts +0 -634
  25. package/src/js/basis/constrained_basis.ts +0 -115
  26. package/src/js/basis/coordinates.ts +0 -92
  27. package/src/js/basis/elements.ts +0 -24
  28. package/src/js/basis/helpers.ts +0 -20
  29. package/src/js/basis/labels.ts +0 -6
  30. package/src/js/cell/cell.ts +0 -149
  31. package/src/js/cell/conventional_cell.ts +0 -86
  32. package/src/js/cell/primitive_cell.ts +0 -166
  33. package/src/js/constants/molecule.ts +0 -18
  34. package/src/js/constants.ts +0 -4
  35. package/src/js/constraints/constraints.ts +0 -45
  36. package/src/js/generated/MaterialSchemaMixin.ts +0 -79
  37. package/src/js/lattice/lattice.ts +0 -308
  38. package/src/js/lattice/lattice_types.ts +0 -134
  39. package/src/js/lattice/reciprocal/lattice_reciprocal.ts +0 -206
  40. package/src/js/lattice/reciprocal/paths.ts +0 -39
  41. package/src/js/lattice/reciprocal/symmetry_points.ts +0 -886
  42. package/src/js/lattice/unit_cell.ts +0 -66
  43. package/src/js/made.ts +0 -62
  44. package/src/js/parsers/cif.ts +0 -25
  45. package/src/js/parsers/errors.ts +0 -6
  46. package/src/js/parsers/espresso.ts +0 -29
  47. package/src/js/parsers/native_format_parsers.ts +0 -52
  48. package/src/js/parsers/parsers.ts +0 -13
  49. package/src/js/parsers/poscar.ts +0 -218
  50. package/src/js/parsers/xyz.ts +0 -190
  51. package/src/js/parsers/xyz_combinatorial_basis.ts +0 -268
  52. package/src/js/tools/basis.ts +0 -131
  53. package/src/js/tools/cell.ts +0 -40
  54. package/src/js/tools/index.ts +0 -11
  55. package/src/js/tools/material.ts +0 -64
  56. package/src/js/tools/supercell.ts +0 -89
  57. package/src/js/tools/surface.ts +0 -213
  58. package/src/py/__init__.py +0 -0
  59. package/src/py/mat3ra/__init__.py +0 -1
  60. package/src/py/mat3ra/made/__init__.py +0 -7
  61. package/src/py/mat3ra/made/basis/__init__.py +0 -255
  62. package/src/py/mat3ra/made/basis/coordinates.py +0 -43
  63. package/src/py/mat3ra/made/cell/__init__.py +0 -55
  64. package/src/py/mat3ra/made/cell/primitive_cell.py +0 -156
  65. package/src/py/mat3ra/made/data_helper.py +0 -5
  66. package/src/py/mat3ra/made/lattice.py +0 -195
  67. package/src/py/mat3ra/made/material.py +0 -135
  68. package/src/py/mat3ra/made/metadata.py +0 -45
  69. package/src/py/mat3ra/made/reciprocal/__init__.py +0 -5
  70. package/src/py/mat3ra/made/reciprocal/lattice_reciprocal.py +0 -147
  71. package/src/py/mat3ra/made/reciprocal/paths.py +0 -30
  72. package/src/py/mat3ra/made/reciprocal/symmetry_points.py +0 -385
  73. package/src/py/mat3ra/made/tools/README.md +0 -173
  74. package/src/py/mat3ra/made/tools/__init__.py +0 -0
  75. package/src/py/mat3ra/made/tools/analyze/__init__.py +0 -31
  76. package/src/py/mat3ra/made/tools/analyze/basis/__init__.py +0 -3
  77. package/src/py/mat3ra/made/tools/analyze/basis/analyzer.py +0 -50
  78. package/src/py/mat3ra/made/tools/analyze/build_metadata_analyzer.py +0 -32
  79. package/src/py/mat3ra/made/tools/analyze/build_metadata_analyzer_factory.py +0 -31
  80. package/src/py/mat3ra/made/tools/analyze/coordination.py +0 -56
  81. package/src/py/mat3ra/made/tools/analyze/crystal_site/__init__.py +0 -0
  82. package/src/py/mat3ra/made/tools/analyze/crystal_site/adatom_crystal_site_material_analyzer.py +0 -35
  83. package/src/py/mat3ra/made/tools/analyze/crystal_site/adatom_material_analyzer.py +0 -49
  84. package/src/py/mat3ra/made/tools/analyze/crystal_site/crystal_site_analyzer.py +0 -65
  85. package/src/py/mat3ra/made/tools/analyze/crystal_site/voronoi_crystal_site_analyzer.py +0 -47
  86. package/src/py/mat3ra/made/tools/analyze/enums.py +0 -33
  87. package/src/py/mat3ra/made/tools/analyze/fingerprint/__init__.py +0 -4
  88. package/src/py/mat3ra/made/tools/analyze/fingerprint/layers/__init__.py +0 -0
  89. package/src/py/mat3ra/made/tools/analyze/fingerprint/layers/layered_fingerprint_along_axis.py +0 -83
  90. package/src/py/mat3ra/made/tools/analyze/fingerprint/layers/unique_element_string_per_layer.py +0 -9
  91. package/src/py/mat3ra/made/tools/analyze/interface/__init__.py +0 -20
  92. package/src/py/mat3ra/made/tools/analyze/interface/commensurate.py +0 -156
  93. package/src/py/mat3ra/made/tools/analyze/interface/enums.py +0 -60
  94. package/src/py/mat3ra/made/tools/analyze/interface/grain_boundary.py +0 -80
  95. package/src/py/mat3ra/made/tools/analyze/interface/simple.py +0 -251
  96. package/src/py/mat3ra/made/tools/analyze/interface/twisted_nanoribbons.py +0 -91
  97. package/src/py/mat3ra/made/tools/analyze/interface/utils/__init__.py +0 -77
  98. package/src/py/mat3ra/made/tools/analyze/interface/utils/holders.py +0 -14
  99. package/src/py/mat3ra/made/tools/analyze/interface/utils/vector.py +0 -56
  100. package/src/py/mat3ra/made/tools/analyze/interface/zsl.py +0 -259
  101. package/src/py/mat3ra/made/tools/analyze/interface_material.py +0 -45
  102. package/src/py/mat3ra/made/tools/analyze/lattice/__init__.py +0 -2
  103. package/src/py/mat3ra/made/tools/analyze/lattice/analyzer.py +0 -126
  104. package/src/py/mat3ra/made/tools/analyze/lattice/helpers.py +0 -31
  105. package/src/py/mat3ra/made/tools/analyze/lattice_lines.py +0 -30
  106. package/src/py/mat3ra/made/tools/analyze/lattice_planes.py +0 -192
  107. package/src/py/mat3ra/made/tools/analyze/lattice_swap_analyzer.py +0 -105
  108. package/src/py/mat3ra/made/tools/analyze/material.py +0 -276
  109. package/src/py/mat3ra/made/tools/analyze/other.py +0 -434
  110. package/src/py/mat3ra/made/tools/analyze/rdf.py +0 -74
  111. package/src/py/mat3ra/made/tools/analyze/slab.py +0 -76
  112. package/src/py/mat3ra/made/tools/analyze/solid_solution_analyzer.py +0 -171
  113. package/src/py/mat3ra/made/tools/analyze/terrace.py +0 -105
  114. package/src/py/mat3ra/made/tools/analyze/utils.py +0 -162
  115. package/src/py/mat3ra/made/tools/bond_directions/__init__.py +0 -0
  116. package/src/py/mat3ra/made/tools/bond_directions/bond_directions.py +0 -150
  117. package/src/py/mat3ra/made/tools/bond_directions/bond_directions_for_element_list.py +0 -7
  118. package/src/py/mat3ra/made/tools/bond_directions/bond_directions_templates_enum.py +0 -8
  119. package/src/py/mat3ra/made/tools/bond_directions/bond_directions_templates_for_element.py +0 -16
  120. package/src/py/mat3ra/made/tools/build/__init__.py +0 -25
  121. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/heterostructure/__init__.py +0 -7
  122. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/heterostructure/helpers.py +0 -59
  123. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/heterostructure/types.py +0 -26
  124. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/heterostructure/utils.py +0 -139
  125. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/__init__.py +0 -47
  126. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/base/__init__.py +0 -11
  127. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/base/build_parameters.py +0 -5
  128. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/base/builder.py +0 -164
  129. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/base/configuration.py +0 -48
  130. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/base/helpers.py +0 -134
  131. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/commensurate/__init__.py +0 -6
  132. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/commensurate/helpers.py +0 -157
  133. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/enums.py +0 -7
  134. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/twisted/__init__.py +0 -7
  135. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/twisted/configuration.py +0 -13
  136. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/twisted/helpers.py +0 -70
  137. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/utils.py +0 -87
  138. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/zsl/__init__.py +0 -6
  139. package/src/py/mat3ra/made/tools/build/compound_pristine_structures/two_dimensional/interface/zsl/helpers.py +0 -129
  140. package/src/py/mat3ra/made/tools/build/defective_structures/__init__.py +0 -0
  141. package/src/py/mat3ra/made/tools/build/defective_structures/one_dimensional/__init__.py +0 -0
  142. package/src/py/mat3ra/made/tools/build/defective_structures/one_dimensional/grain_boundary_linear/__init__.py +0 -0
  143. package/src/py/mat3ra/made/tools/build/defective_structures/one_dimensional/grain_boundary_linear/build_parameters.py +0 -12
  144. package/src/py/mat3ra/made/tools/build/defective_structures/one_dimensional/grain_boundary_linear/builder.py +0 -17
  145. package/src/py/mat3ra/made/tools/build/defective_structures/one_dimensional/grain_boundary_linear/configuration.py +0 -40
  146. package/src/py/mat3ra/made/tools/build/defective_structures/one_dimensional/grain_boundary_linear/helpers.py +0 -82
  147. package/src/py/mat3ra/made/tools/build/defective_structures/three_dimensional/__init__.py +0 -1
  148. package/src/py/mat3ra/made/tools/build/defective_structures/three_dimensional/solid_solution/__init__.py +0 -9
  149. package/src/py/mat3ra/made/tools/build/defective_structures/three_dimensional/solid_solution/builder.py +0 -37
  150. package/src/py/mat3ra/made/tools/build/defective_structures/three_dimensional/solid_solution/configuration.py +0 -30
  151. package/src/py/mat3ra/made/tools/build/defective_structures/three_dimensional/solid_solution/enums.py +0 -8
  152. package/src/py/mat3ra/made/tools/build/defective_structures/three_dimensional/solid_solution/helpers.py +0 -76
  153. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/__init__.py +0 -0
  154. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/adatom/__init__.py +0 -0
  155. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/adatom/builder.py +0 -11
  156. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/adatom/configuration.py +0 -18
  157. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/adatom/helpers.py +0 -137
  158. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/adatom/types.py +0 -22
  159. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/grain_boundary_planar/__init__.py +0 -0
  160. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/grain_boundary_planar/builder.py +0 -28
  161. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/grain_boundary_planar/configuration.py +0 -55
  162. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/grain_boundary_planar/helpers.py +0 -75
  163. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/island/builder.py +0 -15
  164. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/island/configuration.py +0 -16
  165. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/island/helpers.py +0 -116
  166. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/terrace/build_parameters.py +0 -10
  167. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/terrace/builder.py +0 -30
  168. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/terrace/configuration.py +0 -11
  169. package/src/py/mat3ra/made/tools/build/defective_structures/two_dimensional/terrace/helpers.py +0 -78
  170. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/__init__.py +0 -0
  171. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/pair_defect/__init__.py +0 -0
  172. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/pair_defect/builder.py +0 -31
  173. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/pair_defect/configuration.py +0 -45
  174. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/pair_defect/helpers.py +0 -80
  175. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/__init__.py +0 -40
  176. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/atom_placement_method_enum.py +0 -14
  177. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/base/__init__.py +0 -7
  178. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/base/builder.py +0 -42
  179. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/base/configuration.py +0 -27
  180. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/complex_defect_type_enum.py +0 -5
  181. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/factories.py +0 -69
  182. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/helpers.py +0 -92
  183. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/interstitial/__init__.py +0 -7
  184. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/interstitial/builder.py +0 -8
  185. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/interstitial/configuration.py +0 -29
  186. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/interstitial/helpers.py +0 -48
  187. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/interstitial/interstitial_placement_method_enum.py +0 -8
  188. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/point_defect_type_enum.py +0 -8
  189. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/substitutional/__init__.py +0 -7
  190. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/substitutional/builder.py +0 -6
  191. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/substitutional/configuration.py +0 -41
  192. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/substitutional/helpers.py +0 -43
  193. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/substitutional/substitution_placement_method_enum.py +0 -7
  194. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/types.py +0 -24
  195. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/vacancy/__init__.py +0 -7
  196. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/vacancy/builder.py +0 -19
  197. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/vacancy/configuration.py +0 -27
  198. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/vacancy/helpers.py +0 -42
  199. package/src/py/mat3ra/made/tools/build/defective_structures/zero_dimensional/point_defect/vacancy/vacancy_placement_method_enum.py +0 -7
  200. package/src/py/mat3ra/made/tools/build/pristine_structures/__init__.py +0 -0
  201. package/src/py/mat3ra/made/tools/build/pristine_structures/three_dimensional/ideal_crystal/__init__.py +0 -0
  202. package/src/py/mat3ra/made/tools/build/pristine_structures/three_dimensional/ideal_crystal/builder.py +0 -80
  203. package/src/py/mat3ra/made/tools/build/pristine_structures/three_dimensional/ideal_crystal/configurations.py +0 -22
  204. package/src/py/mat3ra/made/tools/build/pristine_structures/three_dimensional/ideal_crystal/helpers.py +0 -40
  205. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/__init__.py +0 -0
  206. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanoribbon/__init__.py +0 -29
  207. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanoribbon/build_parameters.py +0 -5
  208. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanoribbon/builders.py +0 -56
  209. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanoribbon/configuration.py +0 -33
  210. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanoribbon/helpers.py +0 -76
  211. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanotape/__init__.py +0 -11
  212. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanotape/build_parameters.py +0 -9
  213. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanotape/builders.py +0 -83
  214. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanotape/configuration.py +0 -35
  215. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/nanotape/helpers.py +0 -62
  216. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/__init__.py +0 -9
  217. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/build_parameters.py +0 -8
  218. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/builder.py +0 -42
  219. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/configuration.py +0 -99
  220. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/helpers.py +0 -95
  221. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/termination_utils.py +0 -14
  222. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab/utils.py +0 -61
  223. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab_strained_supercell/builder.py +0 -22
  224. package/src/py/mat3ra/made/tools/build/pristine_structures/two_dimensional/slab_strained_supercell/configuration.py +0 -17
  225. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/__init__.py +0 -0
  226. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/__init__.py +0 -19
  227. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/analyzer.py +0 -86
  228. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/ase_based/__init__.py +0 -7
  229. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/ase_based/builder.py +0 -54
  230. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/ase_based/configuration.py +0 -19
  231. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/enums.py +0 -42
  232. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/helpers.py +0 -127
  233. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/merge_based/__init__.py +0 -7
  234. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/merge_based/builder.py +0 -33
  235. package/src/py/mat3ra/made/tools/build/pristine_structures/zero_dimensional/nanoparticle/merge_based/configuration.py +0 -16
  236. package/src/py/mat3ra/made/tools/build/processed_structures/__init__.py +0 -0
  237. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/__init__.py +0 -0
  238. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/__init__.py +0 -0
  239. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/analyzers/__init__.py +0 -9
  240. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/analyzers/coordination_based_passivation_material_analyzer.py +0 -112
  241. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/analyzers/passivation_material_analyzer.py +0 -16
  242. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/analyzers/surface_passivation_material_analyzer.py +0 -32
  243. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/builder.py +0 -23
  244. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/configuration.py +0 -31
  245. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/enums.py +0 -7
  246. package/src/py/mat3ra/made/tools/build/processed_structures/two_dimensional/passivation/helpers.py +0 -151
  247. package/src/py/mat3ra/made/tools/build_components/__init__.py +0 -10
  248. package/src/py/mat3ra/made/tools/build_components/entities/__init__.py +0 -0
  249. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/__init__.py +0 -0
  250. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/one_dimensional/miller_indices_2d.py +0 -0
  251. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/two_dimensional/miller_indices.py +0 -18
  252. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/two_dimensional/termination.py +0 -33
  253. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/__init__.py +0 -0
  254. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/crystal_site/__init__.py +0 -2
  255. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/crystal_site/crystal_site.py +0 -24
  256. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/crystal_site/crystal_site_list.py +0 -9
  257. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/point_defect_site/builder.py +0 -32
  258. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/point_defect_site/configuration.py +0 -14
  259. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/void_region/__init__.py +0 -0
  260. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/void_region/builder.py +0 -29
  261. package/src/py/mat3ra/made/tools/build_components/entities/auxiliary/zero_dimensional/void_region/configuration.py +0 -19
  262. package/src/py/mat3ra/made/tools/build_components/entities/core/two_dimensional/vacuum/builder.py +0 -48
  263. package/src/py/mat3ra/made/tools/build_components/entities/core/two_dimensional/vacuum/configuration.py +0 -17
  264. package/src/py/mat3ra/made/tools/build_components/entities/core/zero_dimensional/atom/builder.py +0 -25
  265. package/src/py/mat3ra/made/tools/build_components/entities/core/zero_dimensional/atom/configuration.py +0 -8
  266. package/src/py/mat3ra/made/tools/build_components/entities/reusable/__init__.py +0 -0
  267. package/src/py/mat3ra/made/tools/build_components/entities/reusable/base_builder/__init__.py +0 -16
  268. package/src/py/mat3ra/made/tools/build_components/entities/reusable/base_builder/base_configuration_pydantic.py +0 -5
  269. package/src/py/mat3ra/made/tools/build_components/entities/reusable/base_builder/base_single_builder.py +0 -87
  270. package/src/py/mat3ra/made/tools/build_components/entities/reusable/base_builder/build_parameters.py +0 -5
  271. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/__init__.py +0 -0
  272. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines/__init__.py +0 -4
  273. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines/builder.py +0 -46
  274. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines/configuration.py +0 -19
  275. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines/edge_types.py +0 -51
  276. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines/helpers.py +0 -58
  277. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated/__init__.py +0 -4
  278. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated/builder.py +0 -42
  279. package/src/py/mat3ra/made/tools/build_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated/configuration.py +0 -21
  280. package/src/py/mat3ra/made/tools/build_components/entities/reusable/three_dimensional/supercell/__init__.py +0 -0
  281. package/src/py/mat3ra/made/tools/build_components/entities/reusable/three_dimensional/supercell/configuration.py +0 -11
  282. package/src/py/mat3ra/made/tools/build_components/entities/reusable/three_dimensional/supercell/helpers.py +0 -38
  283. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/__init__.py +0 -24
  284. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/atomic_layers_unique_repeated/__init__.py +0 -7
  285. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/atomic_layers_unique_repeated/builder.py +0 -62
  286. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/atomic_layers_unique_repeated/configuration.py +0 -14
  287. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/atomic_layers_unique_repeated/helpers.py +0 -42
  288. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/crystal_lattice_planes/__init__.py +0 -7
  289. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/crystal_lattice_planes/builder.py +0 -39
  290. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/crystal_lattice_planes/configuration.py +0 -24
  291. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/slab_stack/__init__.py +0 -10
  292. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/slab_stack/builder.py +0 -36
  293. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/slab_stack/configuration.py +0 -31
  294. package/src/py/mat3ra/made/tools/build_components/entities/reusable/two_dimensional/slab_stack/helpers.py +0 -80
  295. package/src/py/mat3ra/made/tools/build_components/entities/reusable/zero_dimensional/__init__.py +0 -0
  296. package/src/py/mat3ra/made/tools/build_components/entities/reusable/zero_dimensional/coordinates_shape_enum.py +0 -8
  297. package/src/py/mat3ra/made/tools/build_components/metadata/__init__.py +0 -2
  298. package/src/py/mat3ra/made/tools/build_components/metadata/build_metadata.py +0 -7
  299. package/src/py/mat3ra/made/tools/build_components/metadata/material_build_metadata.py +0 -35
  300. package/src/py/mat3ra/made/tools/build_components/metadata/material_with_build_metadata.py +0 -8
  301. package/src/py/mat3ra/made/tools/build_components/mixins/__init__.py +0 -2
  302. package/src/py/mat3ra/made/tools/build_components/mixins/convert_generated_items_ase_atoms_mixin.py +0 -8
  303. package/src/py/mat3ra/made/tools/build_components/mixins/convert_generated_items_pymatgen_structure_mixin.py +0 -8
  304. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/__init__.py +0 -0
  305. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/enums.py +0 -11
  306. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/merge/__init__.py +0 -6
  307. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/merge/build_parameters.py +0 -18
  308. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/merge/builder.py +0 -93
  309. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/merge/configuration.py +0 -20
  310. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/stack/builder.py +0 -83
  311. package/src/py/mat3ra/made/tools/build_components/operations/core/combinations/stack/configuration.py +0 -24
  312. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/__init__.py +0 -15
  313. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/build_parameters.py +0 -5
  314. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/builders/base.py +0 -33
  315. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/builders/isometric.py +0 -25
  316. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/configuration.py +0 -24
  317. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/functions/__init__.py +0 -13
  318. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/functions/atomic_mass_dependent_function_holder.py +0 -32
  319. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/functions/function_holder.py +0 -80
  320. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/functions/maxwell_boltzmann.py +0 -39
  321. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/functions/perturbation_function_holder.py +0 -45
  322. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/functions/sine_wave_perturbation_function_holder.py +0 -29
  323. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/perturb/helpers.py +0 -83
  324. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/strain/__init__.py +0 -5
  325. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/strain/builder.py +0 -25
  326. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/strain/configuration.py +0 -23
  327. package/src/py/mat3ra/made/tools/build_components/operations/core/modifications/strain/helpers.py +0 -49
  328. package/src/py/mat3ra/made/tools/build_components/utils.py +0 -44
  329. package/src/py/mat3ra/made/tools/calculate/__init__.py +0 -149
  330. package/src/py/mat3ra/made/tools/calculate/ase/__init__.py +0 -133
  331. package/src/py/mat3ra/made/tools/calculate/ase/constraints.py +0 -91
  332. package/src/py/mat3ra/made/tools/calculate/calculators/__init__.py +0 -4
  333. package/src/py/mat3ra/made/tools/calculate/calculators/interface_material_calculator.py +0 -70
  334. package/src/py/mat3ra/made/tools/calculate/calculators/interface_material_calculator_parameters.py +0 -14
  335. package/src/py/mat3ra/made/tools/calculate/calculators/material_calculator.py +0 -32
  336. package/src/py/mat3ra/made/tools/calculate/calculators/material_calculator_parameters.py +0 -17
  337. package/src/py/mat3ra/made/tools/calculate/interaction_functions.py +0 -23
  338. package/src/py/mat3ra/made/tools/convert/__init__.py +0 -286
  339. package/src/py/mat3ra/made/tools/convert/interface_parts_enum.py +0 -9
  340. package/src/py/mat3ra/made/tools/convert/utils.py +0 -96
  341. package/src/py/mat3ra/made/tools/entities/__init__.py +0 -5
  342. package/src/py/mat3ra/made/tools/entities/coordinate/__init__.py +0 -14
  343. package/src/py/mat3ra/made/tools/entities/coordinate/box_coordinate_condition.py +0 -15
  344. package/src/py/mat3ra/made/tools/entities/coordinate/coordinate_condition.py +0 -16
  345. package/src/py/mat3ra/made/tools/entities/coordinate/coordinate_functions.py +0 -158
  346. package/src/py/mat3ra/made/tools/entities/coordinate/cylinder_coordinate_condition.py +0 -17
  347. package/src/py/mat3ra/made/tools/entities/coordinate/plane_coordinate_condition.py +0 -14
  348. package/src/py/mat3ra/made/tools/entities/coordinate/sphere_coordinate_condition.py +0 -15
  349. package/src/py/mat3ra/made/tools/entities/coordinate/triangular_prism_coordinate_condition.py +0 -26
  350. package/src/py/mat3ra/made/tools/entities/termination_holder.py +0 -12
  351. package/src/py/mat3ra/made/tools/helpers.py +0 -168
  352. package/src/py/mat3ra/made/tools/modify.py +0 -627
  353. package/src/py/mat3ra/made/tools/operations/core/binary.py +0 -106
  354. package/src/py/mat3ra/made/tools/operations/core/unary.py +0 -170
  355. package/src/py/mat3ra/made/tools/operations/core/utils.py +0 -138
  356. package/src/py/mat3ra/made/tools/operations/reusable/unary.py +0 -53
  357. package/src/py/mat3ra/made/tools/optimize.py +0 -55
  358. package/src/py/mat3ra/made/tools/third_party.py +0 -69
  359. package/src/py/mat3ra/made/tools/utils.py +0 -182
  360. package/src/py/mat3ra/made/utils.py +0 -144
  361. package/tests/.gitattributes +0 -1
  362. package/tests/fixtures/AsGe-basis.json +0 -3
  363. package/tests/fixtures/C2H4-translated.json +0 -3
  364. package/tests/fixtures/C2H4.json +0 -3
  365. package/tests/fixtures/FeLiSi-basis.json +0 -3
  366. package/tests/fixtures/FeO.json +0 -3
  367. package/tests/fixtures/Ge2-basis.json +0 -3
  368. package/tests/fixtures/Graphene.json +0 -3
  369. package/tests/fixtures/Graphene.poscar +0 -3
  370. package/tests/fixtures/H2+H-final.json +0 -3
  371. package/tests/fixtures/H2+H-image.json +0 -3
  372. package/tests/fixtures/H2+H-initial.json +0 -3
  373. package/tests/fixtures/H2O.poscar +0 -3
  374. package/tests/fixtures/LiFeSi-basis-labels.json +0 -3
  375. package/tests/fixtures/LiFeSi-basis.json +0 -3
  376. package/tests/fixtures/Na.json +0 -3
  377. package/tests/fixtures/Na4Cl4-cartesian.json +0 -3
  378. package/tests/fixtures/Na4Cl4.json +0 -3
  379. package/tests/fixtures/Na4Cl4.poscar +0 -3
  380. package/tests/fixtures/Ni-hex.json +0 -3
  381. package/tests/fixtures/Ni-hex.poscar +0 -3
  382. package/tests/fixtures/OSi-basis.json +0 -3
  383. package/tests/fixtures/Si-hex.poscar +0 -3
  384. package/tests/fixtures/Si-pwscf.in +0 -3
  385. package/tests/fixtures/Si-slab.json +0 -3
  386. package/tests/fixtures/Si-supercell.json +0 -3
  387. package/tests/fixtures/Si2-basis-repeated.json +0 -3
  388. package/tests/fixtures/Si2-basis.json +0 -3
  389. package/tests/fixtures/Zr1H23Zr1H1.json +0 -3
  390. package/tests/fixtures/Zr1H23Zr1H1.poscar +0 -3
  391. package/tests/fixtures/atomic-constraints.json +0 -3
  392. package/tests/fixtures/hashes.json +0 -3
  393. package/tests/fixtures/si-slab-100.json +0 -3
  394. package/tests/fixtures/si-slab-111-0-vacuum.json +0 -3
  395. package/tests/fixtures/si-slab-111-0.5-vacuum-gamma-120.json +0 -3
  396. package/tests/fixtures/si-slab-111-0.5-vacuum-ratio.json +0 -3
  397. package/tests/fixtures/si-standata.json +0 -3
  398. package/tests/js/basis/basis.ts +0 -247
  399. package/tests/js/cell/cell.ts +0 -182
  400. package/tests/js/cell/primitive_cell.ts +0 -21
  401. package/tests/js/constraints/constraints.ts +0 -11
  402. package/tests/js/fixtures.ts +0 -123
  403. package/tests/js/lattice/lattice.ts +0 -43
  404. package/tests/js/lattice/lattice_reciprocal.ts +0 -104
  405. package/tests/js/material/material.ts +0 -161
  406. package/tests/js/parsers/espresso.ts +0 -12
  407. package/tests/js/parsers/native_formats.ts +0 -35
  408. package/tests/js/parsers/poscar.ts +0 -89
  409. package/tests/js/parsers/xyz.ts +0 -33
  410. package/tests/js/parsers/xyz_combinatorial_basis.ts +0 -156
  411. package/tests/js/register-esse-schemas.cjs +0 -10
  412. package/tests/js/setup.ts +0 -6
  413. package/tests/js/tools/basis.ts +0 -22
  414. package/tests/js/tools/supercell.ts +0 -58
  415. package/tests/js/tools/surface.ts +0 -111
  416. package/tests/py/conftest.py +0 -34
  417. package/tests/py/mat3ra/debug_utils.py +0 -75
  418. package/tests/py/unit/__init__.py +0 -0
  419. package/tests/py/unit/fixtures/__init__.py +0 -0
  420. package/tests/py/unit/fixtures/adatom.py +0 -60
  421. package/tests/py/unit/fixtures/bulk.py +0 -162
  422. package/tests/py/unit/fixtures/cuts.py +0 -118
  423. package/tests/py/unit/fixtures/grain_boundary.py +0 -875
  424. package/tests/py/unit/fixtures/interface/commensurate.py +0 -498
  425. package/tests/py/unit/fixtures/interface/gaas_dia.py +0 -837
  426. package/tests/py/unit/fixtures/interface/gr_ni_111_top_hcp.py +0 -123
  427. package/tests/py/unit/fixtures/interface/simple.py +0 -84
  428. package/tests/py/unit/fixtures/interface/twisted_nanoribbons.py +0 -131
  429. package/tests/py/unit/fixtures/interface/zsl.py +0 -756
  430. package/tests/py/unit/fixtures/island.py +0 -336
  431. package/tests/py/unit/fixtures/merge.py +0 -147
  432. package/tests/py/unit/fixtures/monolayer.py +0 -46
  433. package/tests/py/unit/fixtures/nanoparticle.py +0 -116
  434. package/tests/py/unit/fixtures/nanoribbon/__init__.py +0 -0
  435. package/tests/py/unit/fixtures/nanoribbon/armchair.py +0 -102
  436. package/tests/py/unit/fixtures/nanoribbon/nanoribbon.py +0 -145
  437. package/tests/py/unit/fixtures/nanoribbon/zigzag.py +0 -54
  438. package/tests/py/unit/fixtures/pair_defects.py +0 -41
  439. package/tests/py/unit/fixtures/passivated/nanoribbon.py +0 -69
  440. package/tests/py/unit/fixtures/passivated/slab.py +0 -58
  441. package/tests/py/unit/fixtures/point_defects.py +0 -158
  442. package/tests/py/unit/fixtures/slab.py +0 -606
  443. package/tests/py/unit/fixtures/strain.py +0 -42
  444. package/tests/py/unit/fixtures/supercell.py +0 -64
  445. package/tests/py/unit/fixtures/terrace.py +0 -70
  446. package/tests/py/unit/fixtures/thrid_party/ase_atoms.py +0 -13
  447. package/tests/py/unit/test_analyze_lattice_planes.py +0 -131
  448. package/tests/py/unit/test_cell.py +0 -104
  449. package/tests/py/unit/test_data_files.py +0 -68
  450. package/tests/py/unit/test_lattice.py +0 -103
  451. package/tests/py/unit/test_lattice_type_extended.py +0 -53
  452. package/tests/py/unit/test_material.py +0 -158
  453. package/tests/py/unit/test_operations.py +0 -126
  454. package/tests/py/unit/test_primitive_cell.py +0 -118
  455. package/tests/py/unit/test_reciprocal_lattice.py +0 -86
  456. package/tests/py/unit/test_reciprocal_paths.py +0 -64
  457. package/tests/py/unit/test_symmetry_points.py +0 -151
  458. package/tests/py/unit/test_tools_analyze.py +0 -219
  459. package/tests/py/unit/test_tools_analyze_basis.py +0 -105
  460. package/tests/py/unit/test_tools_analyze_interface.py +0 -223
  461. package/tests/py/unit/test_tools_analyze_interface_material.py +0 -63
  462. package/tests/py/unit/test_tools_analyze_interface_zsl.py +0 -187
  463. package/tests/py/unit/test_tools_analyze_lattice.py +0 -74
  464. package/tests/py/unit/test_tools_analyze_swap.py +0 -80
  465. package/tests/py/unit/test_tools_build.py +0 -158
  466. package/tests/py/unit/test_tools_build_defect/__init__.py +0 -0
  467. package/tests/py/unit/test_tools_build_defect/test_adatom.py +0 -84
  468. package/tests/py/unit/test_tools_build_defect/test_island.py +0 -45
  469. package/tests/py/unit/test_tools_build_defect/test_pair_defect.py +0 -84
  470. package/tests/py/unit/test_tools_build_defect/test_point_defect.py +0 -196
  471. package/tests/py/unit/test_tools_build_defect/test_slab_stack.py +0 -30
  472. package/tests/py/unit/test_tools_build_defect/test_solid_solution.py +0 -90
  473. package/tests/py/unit/test_tools_build_defect/test_terrace.py +0 -44
  474. package/tests/py/unit/test_tools_build_grain_boundary.py +0 -133
  475. package/tests/py/unit/test_tools_build_heterostructure.py +0 -46
  476. package/tests/py/unit/test_tools_build_interface.py +0 -292
  477. package/tests/py/unit/test_tools_build_interface_zsl.py +0 -263
  478. package/tests/py/unit/test_tools_build_maxwell_disorder.py +0 -123
  479. package/tests/py/unit/test_tools_build_metadata.py +0 -79
  480. package/tests/py/unit/test_tools_build_monolayer.py +0 -33
  481. package/tests/py/unit/test_tools_build_nanoparticle.py +0 -42
  482. package/tests/py/unit/test_tools_build_nanoribbon.py +0 -45
  483. package/tests/py/unit/test_tools_build_passivation.py +0 -85
  484. package/tests/py/unit/test_tools_build_perturbation.py +0 -103
  485. package/tests/py/unit/test_tools_build_slab.py +0 -382
  486. package/tests/py/unit/test_tools_build_strain.py +0 -36
  487. package/tests/py/unit/test_tools_build_supercell.py +0 -47
  488. package/tests/py/unit/test_tools_calculate.py +0 -67
  489. package/tests/py/unit/test_tools_convert.py +0 -174
  490. package/tests/py/unit/test_tools_modify.py +0 -248
  491. package/tests/py/unit/utils.py +0 -142
  492. package/tsconfig-transpile.json +0 -3
  493. package/tsconfig.json +0 -3
@@ -1,156 +0,0 @@
1
- """
2
- Routines for calculating primitive cell vectors from conventional cell Bravais parameters.
3
- Python equivalent of src/js/cell/primitive_cell.ts.
4
-
5
- Following Setyawan, W., & Curtarolo, S. (2010). doi:10.1016/j.commatsci.2010.05.010
6
- """
7
-
8
- import math
9
- from typing import List
10
-
11
- from mat3ra.esse.models.properties_directory.structural.lattice import LatticeSchema
12
- from mat3ra.made.cell import Cell
13
-
14
- Matrix3x3 = List[List[float]]
15
-
16
-
17
- def _rhl(p: LatticeSchema) -> Matrix3x3:
18
- a = p.a
19
- alpha_rad = math.radians(p.alpha)
20
-
21
- cos_alpha = math.cos(alpha_rad)
22
- cos_half_alpha = math.cos(alpha_rad / 2.0)
23
- sin_half_alpha = math.sin(alpha_rad / 2.0)
24
-
25
- z_comp = a * math.sqrt(1.0 - (cos_alpha / cos_half_alpha) ** 2)
26
-
27
- return [
28
- [a * cos_half_alpha, -a * sin_half_alpha, 0.0],
29
- [a * cos_half_alpha, a * sin_half_alpha, 0.0],
30
- [(a * cos_alpha) / cos_half_alpha, 0.0, z_comp],
31
- ]
32
-
33
-
34
- def _tri(p: LatticeSchema) -> Matrix3x3:
35
- """
36
- Algorithm from pymatgen (from_params).
37
- Mirrors the TRI case in primitive_cell.ts exactly.
38
- """
39
- alpha = math.radians(p.alpha)
40
- beta = math.radians(p.beta)
41
- gamma = math.radians(p.gamma)
42
-
43
- cos_alpha = math.cos(alpha)
44
- cos_beta = math.cos(beta)
45
- cos_gamma = math.cos(gamma)
46
- sin_alpha = math.sin(alpha)
47
- sin_beta = math.sin(beta)
48
-
49
- acos_arg = (cos_alpha * cos_beta - cos_gamma) / (sin_alpha * sin_beta)
50
- # Clamp to [-1, 1] to guard against floating-point drift
51
- acos_arg = max(-1.0, min(1.0, acos_arg))
52
-
53
- gamma_star = math.acos(acos_arg)
54
- cos_gamma_star = math.cos(gamma_star)
55
- sin_gamma_star = math.sin(gamma_star)
56
-
57
- a, b, c = p.a, p.b, p.c
58
- return [
59
- [a * sin_beta, 0.0, a * cos_beta],
60
- [-b * sin_alpha * cos_gamma_star, b * sin_alpha * sin_gamma_star, b * cos_alpha],
61
- [0.0, 0.0, c],
62
- ]
63
-
64
-
65
- PRIMITIVE_CELLS = {
66
- "CUB": lambda p: [
67
- [p.a, 0, 0],
68
- [0, p.a, 0],
69
- [0, 0, p.a],
70
- ],
71
- "FCC": lambda p: [
72
- [0.0, p.a / 2, p.a / 2],
73
- [p.a / 2, 0.0, p.a / 2],
74
- [p.a / 2, p.a / 2, 0.0],
75
- ],
76
- "BCC": lambda p: [
77
- [-p.a / 2, p.a / 2, p.a / 2],
78
- [p.a / 2, -p.a / 2, p.a / 2],
79
- [p.a / 2, p.a / 2, -p.a / 2],
80
- ],
81
- "TET": lambda p: [
82
- [p.a, 0, 0],
83
- [0, p.a, 0],
84
- [0, 0, p.c],
85
- ],
86
- "BCT": lambda p: [
87
- [-p.a / 2, p.a / 2, p.c / 2],
88
- [p.a / 2, -p.a / 2, p.c / 2],
89
- [p.a / 2, p.a / 2, -p.c / 2],
90
- ],
91
- "ORC": lambda p: [
92
- [p.a, 0, 0],
93
- [0, p.b, 0],
94
- [0, 0, p.c],
95
- ],
96
- "ORCF": lambda p: [
97
- [0, p.b / 2, p.c / 2],
98
- [p.a / 2, 0, p.c / 2],
99
- [p.a / 2, p.b / 2, 0],
100
- ],
101
- "ORCI": lambda p: [
102
- [-p.a / 2, p.b / 2, p.c / 2],
103
- [p.a / 2, -p.b / 2, p.c / 2],
104
- [p.a / 2, p.b / 2, -p.c / 2],
105
- ],
106
- "ORCC": lambda p: [
107
- [p.a / 2, p.b / 2, 0],
108
- [-p.a / 2, p.b / 2, 0],
109
- [0, 0, p.c],
110
- ],
111
- "HEX": lambda p: [
112
- [p.a / 2, -(p.a * math.sqrt(3)) / 2, 0],
113
- [p.a / 2, (p.a * math.sqrt(3)) / 2, 0],
114
- [0, 0, p.c],
115
- ],
116
- "RHL": _rhl,
117
- "MCL": lambda p: [
118
- [p.a, 0, 0],
119
- [0, p.b, 0],
120
- [0, p.c * math.cos(math.radians(p.alpha)), p.c * math.sin(math.radians(p.alpha))],
121
- ],
122
- "MCLC": lambda p: [
123
- [p.a / 2, p.b / 2, 0],
124
- [-p.a / 2, p.b / 2, 0],
125
- [0, p.c * math.cos(math.radians(p.alpha)), p.c * math.sin(math.radians(p.alpha))],
126
- ],
127
- "TRI": _tri,
128
- }
129
-
130
-
131
- def get_primitive_lattice_vectors_from_config(lattice_config: LatticeSchema) -> Matrix3x3:
132
- """
133
- Returns lattice vectors for a primitive cell for a given lattice config.
134
- Python equivalent of getPrimitiveLatticeVectorsFromConfig() in primitive_cell.ts.
135
-
136
- Args:
137
- lattice_config: LatticeSchema instance with fields:
138
- type, a, b, c, alpha, beta, gamma.
139
-
140
- Returns:
141
- 3x3 list of lists (rows = vectors a, b, c) in the same units as the
142
- input lattice parameters (typically Angstroms).
143
- """
144
- lattice_type = lattice_config.type.value if lattice_config.type else "TRI"
145
- generator = PRIMITIVE_CELLS.get(lattice_type)
146
- if generator is None:
147
- raise ValueError(
148
- f"Unsupported lattice type '{lattice_type}'. " f"Must be one of: {list(PRIMITIVE_CELLS.keys())}"
149
- )
150
- return generator(lattice_config)
151
-
152
-
153
- def get_primitive_cell_from_config(lattice_config: LatticeSchema) -> Cell:
154
- """Returns a full Cell object instantiated with the primitive lattice vectors."""
155
- vectors = get_primitive_lattice_vectors_from_config(lattice_config)
156
- return Cell.from_vectors_array(vectors)
@@ -1,5 +0,0 @@
1
- """Resolve the shared data/ directory at the repository root."""
2
-
3
- from pathlib import Path
4
-
5
- DATA_DIR = Path(__file__).parent / "data"
@@ -1,195 +0,0 @@
1
- import math
2
- from typing import List, Optional
3
-
4
- import numpy as np
5
- from mat3ra.code.constants import HASH_TOLERANCE
6
- from mat3ra.code.entity import InMemoryEntityPydantic
7
- from mat3ra.esse.models.properties_directory.structural.lattice import (
8
- LatticeSchema,
9
- LatticeTypeEnum,
10
- LatticeUnitsSchema,
11
- )
12
- from mat3ra.utils.mixins import RoundNumericValuesMixin
13
- from pydantic import BaseModel
14
-
15
- from .cell import Cell
16
-
17
- COORDINATE_TOLERANCE = 6
18
-
19
-
20
- class LatticeVectors(Cell):
21
- pass
22
-
23
-
24
- class LatticeSchemaVectorless(BaseModel):
25
- """LatticeSchema without the vectors field to avoid conflicts."""
26
-
27
- a: float
28
- b: float
29
- c: float
30
- alpha: float
31
- beta: float
32
- gamma: float
33
- units: LatticeUnitsSchema = LatticeSchema.model_fields["units"].default_factory()
34
- type: LatticeTypeEnum = LatticeSchema.model_fields["type"].default
35
-
36
-
37
- class Lattice(RoundNumericValuesMixin, LatticeSchemaVectorless, InMemoryEntityPydantic):
38
- __types__ = LatticeTypeEnum
39
- __type_default__ = LatticeSchema.model_fields["type"].default
40
- __units_default__ = LatticeSchema.model_fields["units"].default_factory()
41
-
42
- a: float = 1.0
43
- b: float = a
44
- c: float = a
45
- alpha: float = 90.0
46
- beta: float = alpha
47
- gamma: float = alpha
48
-
49
- @property
50
- def vectors(self) -> LatticeVectors:
51
- vectors = self.calculate_vectors()
52
- return LatticeVectors.from_vectors_array(vectors)
53
-
54
- def calculate_vectors(self):
55
- a = self.a
56
- b = self.b
57
- c = self.c
58
- # Convert degrees to radians for trigonometric functions
59
- alpha_rad = math.radians(self.alpha)
60
- beta_rad = math.radians(self.beta)
61
- gamma_rad = math.radians(self.gamma)
62
-
63
- # Calculate cosines and sines of the angles
64
- cos_alpha = math.cos(alpha_rad)
65
- cos_beta = math.cos(beta_rad)
66
- cos_gamma = math.cos(gamma_rad)
67
- sin_alpha = math.sin(alpha_rad)
68
- sin_beta = math.sin(beta_rad)
69
-
70
- # Compute gamma star (used in matrix calculation)
71
- gamma_star = math.acos((cos_alpha * cos_beta - cos_gamma) / (sin_alpha * sin_beta))
72
- cos_gamma_star = math.cos(gamma_star)
73
- sin_gamma_star = math.sin(gamma_star)
74
-
75
- # Calculate the vectors
76
- vector_a = [a * sin_beta, 0.0, a * cos_beta]
77
- vector_b = [-b * sin_alpha * cos_gamma_star, b * sin_alpha * sin_gamma_star, b * cos_alpha]
78
- vector_c = [0.0, 0.0, c]
79
-
80
- return [vector_a, vector_b, vector_c]
81
-
82
- @classmethod
83
- def from_vectors_array(
84
- cls,
85
- vectors: List[List[float]],
86
- units: Optional[LatticeUnitsSchema] = __units_default__,
87
- type: Optional[LatticeTypeEnum] = __type_default__,
88
- ) -> "Lattice":
89
- a = np.linalg.norm(vectors[0])
90
- b = np.linalg.norm(vectors[1])
91
- c = np.linalg.norm(vectors[2])
92
- bc = b * c
93
- ac = a * c
94
- ab = a * b
95
-
96
- if bc == 0 or ac == 0 or ab == 0:
97
- print("Vectors:", vectors)
98
- raise ValueError("Vectors must not be zero vectors.")
99
-
100
- alpha = np.degrees(np.arccos(np.dot(vectors[1], vectors[2]) / bc))
101
- beta = np.degrees(np.arccos(np.dot(vectors[0], vectors[2]) / ac))
102
- gamma = np.degrees(np.arccos(np.dot(vectors[0], vectors[1]) / ab))
103
-
104
- return cls(
105
- a=float(a),
106
- b=float(b),
107
- c=float(c),
108
- alpha=alpha,
109
- beta=beta,
110
- gamma=gamma,
111
- units=units,
112
- type=type,
113
- )
114
-
115
- @property
116
- def vector_arrays(self) -> List[List[float]]:
117
- return self.vectors.vector_arrays
118
-
119
- @property
120
- def vector_arrays_rounded(self) -> List[List[float]]:
121
- return self.vectors.vector_arrays_rounded
122
-
123
- @property
124
- def cell_volume(self) -> float:
125
- return self.vectors.volume
126
-
127
- @property
128
- def cell_volume_rounded(self) -> float:
129
- return self.vectors.volume_rounded
130
-
131
- @property
132
- def reciprocal_vectors(self):
133
- return np.linalg.inv(np.array(self.vector_arrays, dtype=float)).T.tolist()
134
-
135
- @property
136
- def reciprocal_vector_norms(self) -> List[float]:
137
- return [float(np.linalg.norm(vector)) for vector in self.reciprocal_vectors]
138
-
139
- @property
140
- def reciprocal_vector_ratios(self) -> List[float]:
141
- norms = self.reciprocal_vector_norms
142
- max_norm = max(norms)
143
- return [round(float(value / max_norm), 3) for value in norms]
144
-
145
- @property
146
- def type_extended(self) -> str:
147
- """Get the extended lattice type classification.
148
-
149
- For lattice types with subtypes (BCT, ORCF, RHL, MCLC, TRI),
150
- returns the specific subtype based on lattice parameters.
151
- For other types, returns the base type string.
152
- """
153
- a, b, c = self.a, self.b, self.c
154
- alpha, beta, gamma = self.alpha, self.beta, self.gamma
155
- cos_alpha = math.cos(math.radians(alpha))
156
- lattice_type = self.type.value if hasattr(self.type, "value") else str(self.type)
157
-
158
- if lattice_type == "BCT":
159
- return "BCT-1" if c < a else "BCT-2"
160
- elif lattice_type == "ORCF":
161
- if 1 / (a * a) >= 1 / (b * b) + 1 / (c * c):
162
- return "ORCF-1"
163
- return "ORCF-2"
164
- elif lattice_type == "RHL":
165
- return "RHL-1" if cos_alpha > 0 else "RHL-2"
166
- elif lattice_type == "MCLC":
167
- if gamma >= 90:
168
- return "MCLC-1"
169
- if (b / c) * cos_alpha + (b * b / (a * a)) * (1 - cos_alpha * cos_alpha) <= 1:
170
- return "MCLC-3"
171
- return "MCLC-5"
172
- elif lattice_type == "TRI":
173
- if alpha > 90 and beta > 90 and gamma >= 90:
174
- return "TRI_1a"
175
- return "TRI_1b"
176
- else:
177
- return lattice_type
178
-
179
- def get_hash_string(self, is_scaled: bool = False) -> str:
180
- """Mirrors JS Lattice.getHashString(isScaled). Rounds to HASH_TOLERANCE decimal places."""
181
- scale = self.a if is_scaled else 1
182
- values = [self.a / scale, self.b / scale, self.c / scale, self.alpha, self.beta, self.gamma]
183
- return ";".join(f"{round(v, HASH_TOLERANCE):g}" for v in values) + ";"
184
-
185
- def get_scaled_by_matrix(self, matrix: List[List[float]]):
186
- """
187
- Scale the lattice by a matrix.
188
- Args:
189
- matrix (List[List[float]]): A 3x3 matrix.
190
- """
191
- np_vectors = np.array(self.vector_arrays)
192
- np_matrix = np.array(matrix)
193
- scaled_vectors = np.dot(np_matrix, np_vectors).tolist()
194
- new_lattice = self.from_vectors_array(vectors=scaled_vectors, units=self.units, type=self.type)
195
- return new_lattice
@@ -1,135 +0,0 @@
1
- import hashlib
2
- from typing import Any, List, Optional, Union
3
-
4
- from mat3ra.code.constants import AtomicCoordinateUnits, Units
5
- from mat3ra.code.entity import HasDescriptionHasMetadataNamedDefaultableInMemoryEntityPydantic
6
- from mat3ra.esse.models.material import MaterialSchema
7
- from pydantic import ConfigDict, SkipValidation, computed_field
8
-
9
- from .basis import Basis
10
- from .lattice import Lattice
11
-
12
- defaultMaterialConfig = {
13
- "name": "Silicon FCC",
14
- "basis": {
15
- "elements": [
16
- {
17
- "id": 0,
18
- "value": "Si",
19
- },
20
- {
21
- "id": 1,
22
- "value": "Si",
23
- },
24
- ],
25
- "coordinates": [
26
- {
27
- "id": 0,
28
- "value": [0.0, 0.0, 0.0],
29
- },
30
- {
31
- "id": 1,
32
- "value": [0.25, 0.25, 0.25],
33
- },
34
- ],
35
- "units": AtomicCoordinateUnits.crystal,
36
- "labels": [],
37
- "constraints": [],
38
- },
39
- "lattice": {
40
- "a": 3.867,
41
- "b": 3.867,
42
- "c": 3.867,
43
- "alpha": 60.0,
44
- "beta": 60.0,
45
- "gamma": 60.0,
46
- "units": {
47
- "length": Units.angstrom,
48
- "angle": Units.degree,
49
- },
50
- "type": "FCC",
51
- },
52
- }
53
-
54
-
55
- # TODO: replace `-Pydantic` with actual class in the next PR
56
- class Material(MaterialSchema, HasDescriptionHasMetadataNamedDefaultableInMemoryEntityPydantic):
57
- model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
58
-
59
- __default_config__ = defaultMaterialConfig
60
- __schema__ = MaterialSchema
61
-
62
- basis: Basis
63
- lattice: Lattice
64
- # TODO: Fix discriminator in ESSE and remove this:
65
- derivedProperties: Optional[SkipValidation[object]] = None
66
-
67
- def model_post_init(self, __context: Any) -> None:
68
- if not self.name and self.formula:
69
- self.name: str = self.formula
70
- self.basis.cell = self.lattice.vectors
71
-
72
- @classmethod
73
- def create_from_config_or_class_instance(cls, config_or_instance: Union[dict, "Material"]) -> "Material":
74
- if isinstance(config_or_instance, cls):
75
- return config_or_instance
76
- return cls.create(config_or_instance)
77
-
78
- @property
79
- def coordinates_array(self) -> List[List[float]]:
80
- return self.basis.coordinates.values
81
-
82
- def to_cartesian(self) -> None:
83
- self.basis.to_cartesian()
84
-
85
- def to_crystal(self) -> None:
86
- self.basis.to_crystal()
87
-
88
- def set_coordinates(self, coordinates: List[List[float]]) -> None:
89
- self.basis.coordinates.values = coordinates
90
-
91
- def set_lattice_vectors(
92
- self, lattice_vector1: List[float], lattice_vector2: List[float], lattice_vector3: List[float]
93
- ) -> None:
94
- original_is_in_crystal_units = self.basis.is_in_crystal_units
95
- self.to_cartesian()
96
- self.lattice = Lattice.from_vectors_array([lattice_vector1, lattice_vector2, lattice_vector3])
97
- self.basis.cell = self.lattice.vectors
98
- if original_is_in_crystal_units:
99
- self.to_crystal()
100
-
101
- def set_lattice_vectors_from_array(self, lattice_vectors: List[List[float]]) -> None:
102
- if len(lattice_vectors) != 3:
103
- raise ValueError("Lattice vectors array must contain exactly three vectors.")
104
- self.set_lattice_vectors(*lattice_vectors)
105
-
106
- def set_lattice(self, lattice: Lattice) -> None:
107
- self.set_lattice_vectors(*lattice.vector_arrays)
108
-
109
- def add_atom(self, element: str, coordinate: List[float], use_cartesian_coordinates: bool = False) -> None:
110
- self.basis.add_atom(element, coordinate, use_cartesian_coordinates)
111
-
112
- def set_labels_from_list(self, labels: Optional[List[Union[int, str]]]) -> None:
113
- self.basis.set_labels_from_list(labels)
114
-
115
- def set_labels_from_value(self, value: Union[int, str]) -> None:
116
- self.basis.set_labels_from_list([value] * self.basis.number_of_atoms)
117
-
118
- def calculate_hash(self, salt: str = "", is_scaled: bool = False) -> str:
119
- """Mirrors JS materialMixin.calculateHash(). MD5 of basis + lattice hash strings."""
120
- message = f"{self.basis.hash_string}#{self.lattice.get_hash_string(is_scaled)}#{salt}"
121
- return hashlib.md5(message.encode()).hexdigest()
122
-
123
- @computed_field
124
- @property
125
- def hash(self) -> str:
126
- return self.calculate_hash()
127
-
128
- @property
129
- def scaled_hash(self) -> str:
130
- return self.calculate_hash(is_scaled=True)
131
-
132
- @computed_field
133
- @property
134
- def scaledHash(self) -> str:
135
- return self.scaled_hash
@@ -1,45 +0,0 @@
1
- import json
2
- from typing import Any
3
-
4
- from mat3ra.code.entity import InMemoryEntityPydantic
5
- from pydantic import model_validator
6
-
7
-
8
- def to_dict(obj: Any) -> dict:
9
- if isinstance(obj, dict):
10
- return obj
11
- if hasattr(obj, "to_dict") and callable(obj.to_dict):
12
- return obj.to_dict()
13
- # TODO: remove conditional checks below when all configurations moved to Pydantic
14
- if hasattr(obj, "to_json") and callable(obj.to_json):
15
- data = obj.to_json()
16
- if isinstance(data, str):
17
- return json.loads(data)
18
- return data
19
- return {}
20
-
21
-
22
- class BaseMetadata(InMemoryEntityPydantic):
23
- model_config = {"arbitrary_types_allowed": True, "extra": "allow"}
24
-
25
- @model_validator(mode="before")
26
- def convert_fields_to_dict(cls, values):
27
- for key, value in values.items():
28
- field = cls.model_fields.get(key)
29
- if field and field.annotation is dict and value is None:
30
- values[key] = {}
31
- elif field and field.annotation is dict and value is not None and not isinstance(value, dict):
32
- values[key] = to_dict(value)
33
- elif isinstance(value, InMemoryEntityPydantic):
34
- values[key] = to_dict(value)
35
- elif hasattr(value, "to_dict") and callable(value.to_dict):
36
- values[key] = to_dict(value)
37
- # TODO: remove when Pydantic configurations are fully implemented
38
- elif hasattr(value, "to_json") and callable(value.to_json):
39
- values[key] = to_dict(value)
40
- return values
41
-
42
- def update(self, **kwargs: Any):
43
- for key, value in kwargs.items():
44
- if hasattr(self, key) and isinstance(getattr(self, key), dict):
45
- getattr(self, key).update(to_dict(value))
@@ -1,5 +0,0 @@
1
- """Reciprocal lattice module with symmetry points and k-point path utilities."""
2
-
3
- from .lattice_reciprocal import ReciprocalLattice
4
- from .paths import RECIPROCAL_PATHS
5
- from .symmetry_points import get_symmetry_points
@@ -1,147 +0,0 @@
1
- """
2
- Reciprocal lattice class with k-point path and symmetry point utilities.
3
-
4
- Extends the base Lattice class with reciprocal-space functionality
5
- for Brillouin zone analysis.
6
- """
7
-
8
- from typing import List, Optional
9
-
10
- import numpy as np
11
-
12
- from ..lattice import Lattice
13
- from .paths import RECIPROCAL_PATHS
14
- from .symmetry_points import get_symmetry_points
15
-
16
-
17
- class ReciprocalLattice(Lattice):
18
- """Lattice with reciprocal-space utilities.
19
-
20
- Provides methods for working with reciprocal lattice vectors,
21
- high-symmetry points, k-point paths, and k-grid dimensions.
22
- """
23
-
24
- def cartesian_coordinates(self, point: List[float]) -> List[float]:
25
- """Convert a point in crystal (fractional) coordinates to Cartesian coordinates.
26
-
27
- The Cartesian coordinates are in units of 2π/a.
28
-
29
- Args:
30
- point: A 3D point in fractional reciprocal-space coordinates.
31
-
32
- Returns:
33
- The point in Cartesian coordinates.
34
- """
35
- return np.dot(point, self.reciprocal_vectors).tolist()
36
-
37
- @property
38
- def symmetry_points(self) -> List[dict]:
39
- """Get the list of high-symmetry points for the current lattice.
40
-
41
- Returns:
42
- List of dicts with 'point' (str) and 'coordinates' ([float, float, float]).
43
- """
44
- return get_symmetry_points(self)
45
-
46
- @property
47
- def default_kpoint_path(self) -> List[dict]:
48
- """Get the default path in reciprocal space for the current lattice.
49
-
50
- Looks up the path by extended type first (e.g., 'BCT-1'), falling back
51
- to the base type (e.g., 'BCT').
52
-
53
- Returns:
54
- List of dicts with 'point' (str) and 'steps' (int).
55
- """
56
- path = RECIPROCAL_PATHS.get(self.type_extended)
57
- if path is None:
58
- lattice_type = self.type.value if hasattr(self.type, "value") else str(self.type)
59
- path = RECIPROCAL_PATHS.get(lattice_type, [])
60
- return path
61
-
62
- def extract_kpoint_path(self, data_points: Optional[List[List[float]]] = None) -> List[dict]:
63
- """Find and label high-symmetry points in a list of raw k-point coordinates.
64
-
65
- Scans through the provided data points and identifies any that match
66
- known symmetry points (within tolerance).
67
-
68
- Args:
69
- data_points: List of 3D k-point coordinates.
70
-
71
- Returns:
72
- List of dicts with 'point' (str), 'steps' (int), and
73
- 'coordinates' ([float, float, float]) for each matched symmetry point.
74
- """
75
- if data_points is None:
76
- data_points = []
77
-
78
- kpoint_path: List[dict] = []
79
- symm_points = self.symmetry_points
80
-
81
- for index, point in enumerate(data_points):
82
- for sp in symm_points:
83
- if np.allclose(sp["coordinates"], point, atol=1e-4):
84
- kpoint_path.append(
85
- {
86
- "point": sp["point"],
87
- "steps": index,
88
- "coordinates": sp["coordinates"],
89
- }
90
- )
91
- break
92
-
93
- return kpoint_path
94
-
95
- def calculate_dimension(self, n_points: int, index: int) -> int:
96
- """Calculate k-grid dimension for one reciprocal direction.
97
-
98
- Args:
99
- n_points: Total number of k-points.
100
- index: Index of the reciprocal vector direction (0, 1, or 2).
101
-
102
- Returns:
103
- Grid dimension in the specified direction.
104
- """
105
- norms = self.reciprocal_vector_norms
106
- others = [i for i in range(3) if i != index]
107
- j, k = others[0], others[1]
108
- n = np.cbrt((n_points * norms[index] ** 2) / (norms[j] * norms[k]))
109
- return max(1, int(np.ceil(n)))
110
-
111
- def get_dimensions_from_points_count(self, n_kpoints: int) -> List[int]:
112
- """Calculate 3D grid dimensions from total number of k-points.
113
-
114
- Args:
115
- n_kpoints: Total number of k-points.
116
-
117
- Returns:
118
- List of three grid dimensions [n1, n2, n3].
119
- """
120
- return [self.calculate_dimension(n_kpoints, i) for i in range(3)]
121
-
122
- def get_dimensions_from_spacing(self, spacing: float) -> List[int]:
123
- """Calculate grid dimensions from k-point spacing.
124
-
125
- The spacing is in Cartesian (2π/a) units.
126
-
127
- Args:
128
- spacing: Maximum spacing between k-points.
129
-
130
- Returns:
131
- List of three grid dimensions [n1, n2, n3].
132
- """
133
- norms = self.reciprocal_vector_norms
134
- return [max(1, int(np.ceil(round(norm / spacing, 4)))) for norm in norms]
135
-
136
- def get_spacing_from_dimensions(self, dimensions: List[int]) -> float:
137
- """Calculate average k-point spacing from grid dimensions.
138
-
139
- Args:
140
- dimensions: List of three grid dimensions [n1, n2, n3].
141
-
142
- Returns:
143
- Average spacing in Cartesian (2π/a) units.
144
- """
145
- norms = self.reciprocal_vector_norms
146
- spacings = [norms[i] / max(1, dimensions[i]) for i in range(3)]
147
- return float(np.mean(spacings))