@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,30 +0,0 @@
1
- """
2
- Default k-point paths according to AFLOW methodology.
3
-
4
- Reference: https://arxiv.org/abs/1004.2974
5
- Paths are split in parts for clarity.
6
-
7
- Raw segment data is stored in reciprocal_paths.json (shared with JS/TS).
8
- """
9
-
10
- import json
11
- from typing import Dict, List
12
-
13
- from mat3ra.made.data_helper import DATA_DIR
14
-
15
- _JSON_FILE = DATA_DIR / "reciprocal_paths.json"
16
- with open(_JSON_FILE) as f:
17
- _POINTS: Dict[str, List[List[str]]] = json.load(f)
18
-
19
-
20
- def _build_reciprocal_paths() -> Dict[str, List[dict]]:
21
- """Flatten path segments and assign default step count to each point."""
22
- result: Dict[str, List[dict]] = {}
23
- for key, path_segments in _POINTS.items():
24
- flattened = [point for segment in path_segments for point in segment]
25
- # TODO: calculate number of steps based on distance in k-space
26
- result[key] = [{"point": point, "steps": 10} for point in flattened]
27
- return result
28
-
29
-
30
- RECIPROCAL_PATHS: Dict[str, List[dict]] = _build_reciprocal_paths()
@@ -1,385 +0,0 @@
1
- """
2
- Brillouin zone high-symmetry points by lattice type.
3
-
4
- AFLOW methodology is used for implementation.
5
- Reference: https://arxiv.org/abs/1004.2974
6
- """
7
-
8
- import math
9
- from typing import Any, Callable, Dict, List
10
-
11
-
12
- def _cub(**_: Any) -> List[dict]:
13
- return [
14
- {"point": "R", "coordinates": [0.5, 0.5, 0.5]},
15
- {"point": "X", "coordinates": [0.0, 0.5, 0.0]},
16
- {"point": "M", "coordinates": [0.5, 0.5, 0.0]},
17
- ]
18
-
19
-
20
- def _fcc(**_: Any) -> List[dict]:
21
- return [
22
- {"point": "K", "coordinates": [3 / 8, 3 / 8, 3 / 4]},
23
- {"point": "L", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
24
- {"point": "U", "coordinates": [5 / 8, 1 / 4, 5 / 8]},
25
- {"point": "W", "coordinates": [1 / 2, 1 / 4, 3 / 4]},
26
- {"point": "X", "coordinates": [1 / 2, 0.0, 1 / 2]},
27
- ]
28
-
29
-
30
- def _bcc(**_: Any) -> List[dict]:
31
- return [
32
- {"point": "H", "coordinates": [1 / 2, -1 / 2, 1 / 2]},
33
- {"point": "P", "coordinates": [1 / 4, 1 / 4, 1 / 4]},
34
- {"point": "N", "coordinates": [0.0, 0.0, 1 / 2]},
35
- ]
36
-
37
-
38
- def _tet(**_: Any) -> List[dict]:
39
- return [
40
- {"point": "A", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
41
- {"point": "M", "coordinates": [1 / 2, 1 / 2, 0.0]},
42
- {"point": "R", "coordinates": [0.0, 1 / 2, 1 / 2]},
43
- {"point": "X", "coordinates": [0.0, 1 / 2, 0.0]},
44
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
45
- ]
46
-
47
-
48
- def _bct(a: float = 1.0, c: float = 1.0, **_: Any) -> List[dict]:
49
- if c < a:
50
- # BCT-1
51
- n = (1 + (c * c) / (a * a)) / 4
52
- return [
53
- {"point": "M", "coordinates": [-1 / 2, 1 / 2, 1 / 2]},
54
- {"point": "N", "coordinates": [0.0, 1 / 2, 0.0]},
55
- {"point": "P", "coordinates": [1 / 4, 1 / 4, 1 / 4]},
56
- {"point": "X", "coordinates": [0.0, 0.0, 1 / 2]},
57
- {"point": "Z", "coordinates": [n, n, -n]},
58
- {"point": "Z1", "coordinates": [-n, 1 - n, n]},
59
- ]
60
- # BCT-2
61
- n = (1 + (a * a) / (c * c)) / 4
62
- e = (a * a) / (2 * c * c)
63
- return [
64
- {"point": "N", "coordinates": [0.0, 1 / 2, 0.0]},
65
- {"point": "P", "coordinates": [1 / 4, 1 / 4, 1 / 4]},
66
- {"point": "∑", "coordinates": [-n, n, n]},
67
- {"point": "∑1", "coordinates": [n, 1 - n, -n]},
68
- {"point": "X", "coordinates": [0, 0, 1 / 2]},
69
- {"point": "Y", "coordinates": [-e, e, 1 / 2]},
70
- {"point": "Y1", "coordinates": [1 / 2, 1 / 2, -e]},
71
- {"point": "Z", "coordinates": [1 / 2, 1 / 2, -1 / 2]},
72
- ]
73
-
74
-
75
- def _orc(**_: Any) -> List[dict]:
76
- return [
77
- {"point": "R", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
78
- {"point": "S", "coordinates": [1 / 2, 1 / 2, 0.0]},
79
- {"point": "T", "coordinates": [0.0, 1 / 2, 1 / 2]},
80
- {"point": "U", "coordinates": [1 / 2, 0.0, 1 / 2]},
81
- {"point": "X", "coordinates": [1 / 2, 0.0, 0.0]},
82
- {"point": "Y", "coordinates": [0.0, 1 / 2, 0.0]},
83
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
84
- ]
85
-
86
-
87
- def _orcf(a: float = 1.0, b: float = 1.0, c: float = 1.0, **_: Any) -> List[dict]:
88
- if 1 / (a * a) >= 1 / (b * b) + 1 / (c * c):
89
- # ORCF-1,3
90
- n = (1 + (a * a) / (b * b) + (a * a) / (c * c)) / 4
91
- e = (1 + (a * a) / (b * b) - (a * a) / (c * c)) / 4
92
- return [
93
- {"point": "A", "coordinates": [1 / 2, 1 / 2 + e, e]},
94
- {"point": "A1", "coordinates": [0.0, 1 / 2 - e, 1 - e]},
95
- {"point": "L", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
96
- {"point": "T", "coordinates": [1.0, 1 / 2, 1 / 2]},
97
- {"point": "X", "coordinates": [0.0, n, n]},
98
- {"point": "X1", "coordinates": [1.0, 1 - n, 1 - n]},
99
- {"point": "Y", "coordinates": [1 / 2, 0.0, 1 / 2]},
100
- {"point": "Z", "coordinates": [1 / 2, 1 / 2, 0.0]},
101
- ]
102
- # ORCF-2
103
- n = (1 + (a * a) / (b * b) - (a * a) / (c * c)) / 4
104
- f = (1 + (c * c) / (b * b) - (c * c) / (a * a)) / 4
105
- d = (1 + (b * b) / (a * a) - (b * b) / (c * c)) / 4
106
- return [
107
- {"point": "C", "coordinates": [1 / 2, 1 / 2 - n, 1 - n]},
108
- {"point": "C1", "coordinates": [0.0, 1 / 2 + n, n]},
109
- {"point": "D", "coordinates": [1 / 2 - d, 1 / 2, 1 - d]},
110
- {"point": "D1", "coordinates": [1 / 2 + d, 1 / 2, d]},
111
- {"point": "L", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
112
- {"point": "H", "coordinates": [1 - f, 1 / 2 - f, 1 / 2]},
113
- {"point": "H1", "coordinates": [f, 1 / 2 + f, 1 / 2]},
114
- {"point": "X", "coordinates": [0.0, 1 / 2, 1 / 2]},
115
- {"point": "Y", "coordinates": [1 / 2, 0.0, 1 / 2]},
116
- {"point": "Z", "coordinates": [1 / 2, 1 / 2, 0.0]},
117
- ]
118
-
119
-
120
- def _orci(a: float = 1.0, b: float = 1.0, c: float = 1.0, **_: Any) -> List[dict]:
121
- n = (1 + (a * a) / (c * c)) / 4
122
- e = (1 + (b * b) / (c * c)) / 4
123
- d = (b * b - a * a) / (4 * c * c)
124
- m = (b * b + a * a) / (4 * c * c)
125
- return [
126
- {"point": "L", "coordinates": [-m, m, 1 / 2 - d]},
127
- {"point": "L1", "coordinates": [m, -m, 1 / 2 + d]},
128
- {"point": "L2", "coordinates": [1 / 2 - d, 1 / 2 + d, -m]},
129
- {"point": "R", "coordinates": [0.0, 1 / 2, 0.0]},
130
- {"point": "S", "coordinates": [1 / 2, 0.0, 0.0]},
131
- {"point": "T", "coordinates": [0.0, 0.0, 1 / 2]},
132
- {"point": "W", "coordinates": [1 / 4, 1 / 4, 1 / 4]},
133
- {"point": "X", "coordinates": [-e, e, e]},
134
- {"point": "X1", "coordinates": [e, 1 - e, -e]},
135
- {"point": "Y", "coordinates": [n, -n, n]},
136
- {"point": "Y1", "coordinates": [1 - n, n, -n]},
137
- {"point": "Z", "coordinates": [1 / 2, 1 / 2, -1 / 2]},
138
- ]
139
-
140
-
141
- def _orcc(a: float = 1.0, b: float = 1.0, **_: Any) -> List[dict]:
142
- e = (1 + (a * a) / (b * b)) / 4
143
- return [
144
- {"point": "A", "coordinates": [e, e, 1 / 2]},
145
- {"point": "A1", "coordinates": [-e, 1 - e, 1 / 2]},
146
- {"point": "R", "coordinates": [0.0, 1 / 2, 1 / 2]},
147
- {"point": "S", "coordinates": [0.0, 1 / 2, 0.0]},
148
- {"point": "T", "coordinates": [-1 / 2, 1 / 2, 1 / 2]},
149
- {"point": "X", "coordinates": [e, e, 0.0]},
150
- {"point": "X1", "coordinates": [-e, 1 - e, 0.0]},
151
- {"point": "Y", "coordinates": [-1 / 2, 1 / 2, 0.0]},
152
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
153
- ]
154
-
155
-
156
- def _hex(**_: Any) -> List[dict]:
157
- return [
158
- {"point": "A", "coordinates": [0.0, 0.0, 1 / 2]},
159
- {"point": "H", "coordinates": [1 / 3, 1 / 3, 1 / 2]},
160
- {"point": "K", "coordinates": [1 / 3, 1 / 3, 0.0]},
161
- {"point": "L", "coordinates": [1 / 2, 0.0, 1 / 2]},
162
- {"point": "M", "coordinates": [1 / 2, 0.0, 0.0]},
163
- ]
164
-
165
-
166
- def _rhl(alpha: float = 90.0, **_: Any) -> List[dict]:
167
- cos_alpha = math.cos(math.radians(alpha))
168
- if cos_alpha > 0:
169
- # RHL-1
170
- n = (1 + 4 * cos_alpha) / (2 + 4 * cos_alpha)
171
- v = 3 / 4 - n / 2
172
- return [
173
- {"point": "B", "coordinates": [n, 1 / 2, 1 - n]},
174
- {"point": "B1", "coordinates": [1 / 2, 1 - n, n - 1]},
175
- {"point": "F", "coordinates": [1 / 2, 1 / 2, 0.0]},
176
- {"point": "L", "coordinates": [1 / 2, 0.0, 0.0]},
177
- {"point": "L1", "coordinates": [0.0, 0.0, -1 / 2]},
178
- {"point": "P", "coordinates": [n, v, v]},
179
- {"point": "P1", "coordinates": [1 - v, 1 - v, 1 - n]},
180
- {"point": "P2", "coordinates": [v, v, n - 1]},
181
- {"point": "Q", "coordinates": [1 - v, v, 0.0]},
182
- {"point": "X", "coordinates": [v, 0.0, -v]},
183
- {"point": "Z", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
184
- ]
185
- # RHL-2
186
- n = (1 / 2 * (1 + cos_alpha)) / (1 - cos_alpha)
187
- v = 3 / 4 - n / 2
188
- return [
189
- {"point": "F", "coordinates": [1 / 2, -1 / 2, 0.0]},
190
- {"point": "L", "coordinates": [1 / 2, 0.0, 0.0]},
191
- {"point": "P", "coordinates": [1 - v, -v, 1 - v]},
192
- {"point": "P1", "coordinates": [v, v - 1, v - 1]},
193
- {"point": "Q", "coordinates": [n, n, n]},
194
- {"point": "Q1", "coordinates": [1 - n, -n, -n]},
195
- {"point": "Z", "coordinates": [1 / 2, -1 / 2, 1 / 2]},
196
- ]
197
-
198
-
199
- def _mcl(b: float = 1.0, c: float = 1.0, alpha: float = 90.0, **_: Any) -> List[dict]:
200
- cos_alpha = math.cos(math.radians(alpha))
201
- n = (1 / 2 * (1 - (b * cos_alpha) / c)) / (1 - cos_alpha * cos_alpha)
202
- v = 1 / 2 - (n * c * cos_alpha) / b
203
- return [
204
- {"point": "A", "coordinates": [1 / 2, 1 / 2, 0.0]},
205
- {"point": "C", "coordinates": [0.0, 1 / 2, 1 / 2]},
206
- {"point": "D", "coordinates": [1 / 2, 0.0, 1 / 2]},
207
- {"point": "D1", "coordinates": [1 / 2, 0.0, -1 / 2]},
208
- {"point": "E", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
209
- {"point": "H", "coordinates": [0.0, n, 1 - v]},
210
- {"point": "H1", "coordinates": [0.0, 1 - n, v]},
211
- {"point": "H2", "coordinates": [0.0, n, -v]},
212
- {"point": "M", "coordinates": [1 / 2, n, 1 - v]},
213
- {"point": "M1", "coordinates": [1 / 2, 1 - n, v]},
214
- {"point": "M2", "coordinates": [1 / 2, n, -v]},
215
- {"point": "X", "coordinates": [0.0, 1 / 2, 0.0]},
216
- {"point": "Y", "coordinates": [0.0, 0.0, 1 / 2]},
217
- {"point": "Y1", "coordinates": [0.0, 0.0, -1 / 2]},
218
- {"point": "Z", "coordinates": [1 / 2, 0.0, 0.0]},
219
- ]
220
-
221
-
222
- def _mclc(
223
- a: float = 1.0,
224
- b: float = 1.0,
225
- c: float = 1.0,
226
- alpha: float = 90.0,
227
- gamma: float = 90.0,
228
- **_: Any,
229
- ) -> List[dict]:
230
- cos_alpha = math.cos(math.radians(alpha))
231
- if gamma >= 90:
232
- # MCLC-1,2
233
- e = (2 - (b * cos_alpha) / c) / (4 * (1 - cos_alpha * cos_alpha))
234
- n = 1 / 2 + (2 * e * c * cos_alpha) / b
235
- p = 3 / 4 - (a * a) / (4 * b * b * (1 - cos_alpha * cos_alpha))
236
- f = p + ((3 / 4 - p) * cos_alpha * b) / c
237
- return [
238
- {"point": "N", "coordinates": [1 / 2, 0.0, 0.0]},
239
- {"point": "N1", "coordinates": [0.0, -1 / 2, 0.0]},
240
- {"point": "F", "coordinates": [1 - e, 1 - e, 1 - n]},
241
- {"point": "F1", "coordinates": [e, e, n]},
242
- {"point": "F2", "coordinates": [-e, -e, 1 - n]},
243
- {"point": "F3", "coordinates": [1 - e, -e, 1 - n]},
244
- {"point": "I", "coordinates": [f, 1 - f, 1 / 2]},
245
- {"point": "I1", "coordinates": [1 - f, f - 1, 1 / 2]},
246
- {"point": "L", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
247
- {"point": "M", "coordinates": [1 / 2, 0.0, 1 / 2]},
248
- {"point": "X", "coordinates": [1 - p, p - 1, 0.0]},
249
- {"point": "X1", "coordinates": [p, 1 - p, 0.0]},
250
- {"point": "X2", "coordinates": [p - 1, -p, 0.0]},
251
- {"point": "Y", "coordinates": [1 / 2, 1 / 2, 0.0]},
252
- {"point": "Y1", "coordinates": [-1 / 2, -1 / 2, 0.0]},
253
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
254
- ]
255
- if (b / c) * cos_alpha + (b * b / (a * a)) * (1 - cos_alpha * cos_alpha) <= 1:
256
- # MCLC-3,4
257
- m = (1 + (b * b) / (a * a)) / 4
258
- d = (b * c * cos_alpha) / (2 * a * a)
259
- e = m - 1 / 4 + (1 - (b * cos_alpha) / c) / (4 * (1 - cos_alpha * cos_alpha))
260
- n = 1 / 2 + (2 * e * c * cos_alpha) / b
261
- f = 1 + e - 2 * m
262
- p = n - 2 * d
263
- return [
264
- {"point": "N", "coordinates": [1 / 2, 0.0, 0.0]},
265
- {"point": "N1", "coordinates": [0.0, -1 / 2, 0.0]},
266
- {"point": "F", "coordinates": [1 - f, 1 - f, 1 - p]},
267
- {"point": "F1", "coordinates": [f, f - 1, p]},
268
- {"point": "F2", "coordinates": [1 - f, -f, 1 - p]},
269
- {"point": "H", "coordinates": [e, e, n]},
270
- {"point": "H1", "coordinates": [1 - e, -e, 1 - n]},
271
- {"point": "H2", "coordinates": [-e, -e, 1 - n]},
272
- {"point": "I", "coordinates": [1 / 2, -1 / 2, 1 / 2]},
273
- {"point": "M", "coordinates": [1 / 2, 0.0, 1 / 2]},
274
- {"point": "X", "coordinates": [1 / 2, -1 / 2, 0.0]},
275
- {"point": "Y", "coordinates": [m, m, d]},
276
- {"point": "Y1", "coordinates": [1 - m, -m, -d]},
277
- {"point": "Y2", "coordinates": [-m, -m, -d]},
278
- {"point": "Y3", "coordinates": [m, m - 1, d]},
279
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
280
- ]
281
- # MCLC-5
282
- # Note: The JS source has a bug where n and v are used before proper assignment.
283
- # Here we use the correct order from the AFLOW paper (arXiv:1004.2974).
284
- e = (1 / 4) * ((b * b) / (a * a) + (1 - (b * cos_alpha) / c) / (1 - cos_alpha * cos_alpha))
285
- n = 1 / 2 + (2 * e * c * cos_alpha) / b
286
- m = e / 2 + (b * b) / (a * a) / 4 - (b * c * cos_alpha) / (2 * a * a)
287
- v = 1 + e - 2 * m
288
- w = ((4 * v - 1 - (b * b * (1 - cos_alpha * cos_alpha)) / (a * a)) * c) / (2 * b * cos_alpha)
289
- d = ((e * c) / b) * cos_alpha + w / 2 - 1 / 4
290
- r = 1 - (e * a * a) / (b * b)
291
- return [
292
- {"point": "N", "coordinates": [1 / 2, 0.0, 0.0]},
293
- {"point": "N1", "coordinates": [0.0, -1 / 2, 0.0]},
294
- {"point": "F", "coordinates": [v, v, w]},
295
- {"point": "F1", "coordinates": [1 - v, 1 - v, 1 - w]},
296
- {"point": "F2", "coordinates": [v, v - 1, w]},
297
- {"point": "H", "coordinates": [e, e, n]},
298
- {"point": "H1", "coordinates": [1 - e, -e, 1 - n]},
299
- {"point": "H2", "coordinates": [-e, -e, 1 - n]},
300
- {"point": "I", "coordinates": [r, 1 - r, 1 / 2]},
301
- {"point": "I1", "coordinates": [1 - r, r - 1, 1 / 2]},
302
- {"point": "L", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
303
- {"point": "M", "coordinates": [1 / 2, 0.0, 1 / 2]},
304
- {"point": "X", "coordinates": [1 / 2, -1 / 2, 0.0]},
305
- {"point": "Y", "coordinates": [m, m, d]},
306
- {"point": "Y1", "coordinates": [1 - m, -m, -d]},
307
- {"point": "Y2", "coordinates": [-m, -m, -d]},
308
- {"point": "Y3", "coordinates": [m, m - 1, d]},
309
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
310
- ]
311
-
312
-
313
- def _tri(alpha: float = 90.0, beta: float = 90.0, gamma: float = 90.0, **_: Any) -> List[dict]:
314
- if alpha > 90 and beta > 90 and gamma >= 90:
315
- # TRI-1a,2a
316
- return [
317
- {"point": "L", "coordinates": [1 / 2, 1 / 2, 0.0]},
318
- {"point": "M", "coordinates": [0.0, 1 / 2, 1 / 2]},
319
- {"point": "N", "coordinates": [1 / 2, 0.0, 1 / 2]},
320
- {"point": "R", "coordinates": [1 / 2, 1 / 2, 1 / 2]},
321
- {"point": "X", "coordinates": [1 / 2, 0.0, 0.0]},
322
- {"point": "Y", "coordinates": [0.0, 1 / 2, 0.0]},
323
- {"point": "Z", "coordinates": [0.0, 0.0, 1 / 2]},
324
- ]
325
- # TRI-1b,2b
326
- return [
327
- {"point": "L", "coordinates": [1 / 2, -1 / 2, 0.0]},
328
- {"point": "M", "coordinates": [0.0, 0.0, 1 / 2]},
329
- {"point": "N", "coordinates": [-1 / 2, -1 / 2, 1 / 2]},
330
- {"point": "R", "coordinates": [0.0, -1 / 2, 1 / 2]},
331
- {"point": "X", "coordinates": [0.0, -1 / 2, 0.0]},
332
- {"point": "Y", "coordinates": [1 / 2, 0.0, 0.0]},
333
- {"point": "Z", "coordinates": [-1 / 2, 0.0, 1 / 2]},
334
- ]
335
-
336
-
337
- POINTS: Dict[str, Callable[..., List[dict]]] = {
338
- "CUB": _cub,
339
- "FCC": _fcc,
340
- "BCC": _bcc,
341
- "TET": _tet,
342
- "BCT": _bct,
343
- "ORC": _orc,
344
- "ORCF": _orcf,
345
- "ORCI": _orci,
346
- "ORCC": _orcc,
347
- "HEX": _hex,
348
- "RHL": _rhl,
349
- "MCL": _mcl,
350
- "MCLC": _mclc,
351
- "TRI": _tri,
352
- }
353
-
354
-
355
- def get_symmetry_points(lattice: Any) -> List[dict]:
356
- """Return a list of high-symmetry points for the given lattice.
357
-
358
- The Gamma point is always included as the first entry.
359
-
360
- Args:
361
- lattice: An object with attributes a, b, c, alpha, beta, gamma, and type.
362
- The type attribute should be a string or enum with a .value attribute
363
- representing one of the 14 Bravais lattice types.
364
-
365
- Returns:
366
- List of dicts with 'point' (str) and 'coordinates' ([float, float, float]).
367
- """
368
- lattice_type = lattice.type.value if hasattr(lattice.type, "value") else str(lattice.type)
369
-
370
- gamma_point = [{"point": "Γ", "coordinates": [0.0, 0.0, 0.0]}]
371
-
372
- points_fn = POINTS.get(lattice_type)
373
- if points_fn is None:
374
- return gamma_point
375
-
376
- type_points = points_fn(
377
- a=lattice.a,
378
- b=lattice.b,
379
- c=lattice.c,
380
- alpha=lattice.alpha,
381
- beta=lattice.beta,
382
- gamma=lattice.gamma,
383
- )
384
-
385
- return gamma_point + type_points
@@ -1,173 +0,0 @@
1
- [![npm version](https://badge.fury.io/js/%40mat3ra%2Fmade.svg)](https://badge.fury.io/js/%40mat3ra%2Fmade)
2
- [![License: Apache](https://img.shields.io/badge/License-Apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
3
-
4
- # Tools
5
-
6
- Tools for creating and manipulating materials structures.
7
-
8
- ## 0. Overview
9
-
10
- Module provides classes and functions to build and manipulate materials.
11
-
12
- The following material types can be generated.
13
-
14
- ### 0.1. Single-Material Structures
15
-
16
- - 3D Structures
17
- - Slabs
18
- - 2D Structures
19
- - Monolayers (equivalent to Slabs)
20
- - Nanoribbons
21
- - (Quasi) Non-periodic Structures
22
- - Nanostructures (spherical, cylindrical, etc.)
23
-
24
- ### 0.2. Multi-Material Structures
25
-
26
- - Interfaces
27
- - with no strain matching
28
- - with strain matching (ZSL)
29
- - twisted bilayers, with commensurate lattice search
30
- - Heterostructures
31
- - with no strain matching
32
- - with strain matching (ZSL)
33
-
34
- - Stacked Nanoribbons
35
-
36
- ### 0.3. Defects
37
-
38
- - Point Defects
39
- - vacancy
40
- - substitution
41
- - interstitial
42
- - defect pair
43
- - Surface Defects
44
- - adatom
45
- - island
46
- - terrace
47
- - Planar Defects
48
- - grain boundary in a slab
49
- - grain boundary in a bulk
50
-
51
- ### 0.4. Passivation
52
-
53
- - Surface Passivation
54
- - Add passivation to slab
55
- - Edge Passivation
56
- - Add passivation to monolayer nanoribbon
57
-
58
- ### 0.5. Perturbations
59
-
60
- - Add longitudinal wave perturbation to slab
61
- - Add radial wave perturbation to slab
62
- - Add custom perturbation to slab
63
-
64
- ## 1. Ontology
65
-
66
- One can think about the process of a creation of a new materials as a workflow, where there is input material, a set of operations that are applied to it, and the output material(s) - Result(s). Following this, we identify the main concepts as:
67
-
68
- - (Input) Materials: the "holders" of the structural information (e.g. Silicon FCC crystal).
69
- - Configurations: describe the physical properties of the Result (e.g. defect, interface, etc.).
70
- - Builders: the workflows, transformations applied to Configurations to generate Result(s) .
71
- - BuilderParameters: specific parameters of the digital representation of the transformations.
72
- - (Result) Materials: the output of the Builders (e.g. point defect in Silicon, graphene nanoribbon etc.).
73
-
74
- ![Diagram](../../../../../images/made/tools/tools_diagram_general.png)
75
-
76
- for a specific case of the creation of an interface:
77
-
78
- [//]: # (a diagram that explains the relationships for an Interface)
79
- ![Made Tools](../../../../../images/made/tools/tools_diagram_interface.png)
80
-
81
-
82
- ## 2. Code Structure.
83
-
84
- ### 2.1. The Approach.
85
-
86
- The approach follows the ontology described above. The main classes/concepts are:
87
-
88
- - Builders and BuilderParameters.
89
- - Configurations.
90
- - Factories: methods that manage the creation of different types of builders.
91
-
92
-
93
- ### 2.2. Top-level Entrypoint Functions.
94
-
95
- For usability purposes, we provide top-level functions that allow for the creation of materials with a single call. These functions are:
96
-
97
- [//]: # (Explain the helper functions and their purpose `create_interface`.)
98
-
99
- The function with plural name takes in Configuration and Builder as arguments and returns the Result Materials list when multiple results are possible.
100
-
101
- - `create_interfaces`
102
- - `create_defects`
103
-
104
-
105
- The function with singular name takes in Configuration and Builder as arguments and returns single Result Material object when only one result is possible, or the first, most optimal one, from the list of results ordered by some criteria.
106
-
107
- - `create_interface`
108
- - `create_defect`
109
- - `create_slab_defect`
110
- - `create_slab`
111
- - `create_perturbation`
112
- - `create_passivation`
113
- - `create_nanoribbon`
114
- - `create_grain_boundary`
115
-
116
- Some of the top-level functions are helpers that allow to get additional properties from configuration to refine the build process, such as:
117
- - `get_terminations` for slab
118
- - `get_unique_coordination_numbers` for passivation
119
- - `get_optimal_film_displacement` for interface
120
-
121
-
122
- ## 3. Usage
123
-
124
- ### 3.1. Installation
125
-
126
- See top-level [README](../../../../../README.md) for installation instructions.
127
-
128
- ### 3.2. Usage in Python
129
-
130
- Here is an example workflow using made.tools.build:
131
-
132
- Define Configuration:
133
-
134
- ```python
135
- from mat3ra.made.tools.build.perturbation.configuration import PerturbationConfiguration
136
- from mat3ra.made.tools.build.perturbation.builders import SlabPerturbationBuilder
137
-
138
- perturbation_config = PerturbationConfiguration(
139
- material=initial_material,
140
- perturbation_function_holder=perturbation_function_holder,
141
- use_cartesian_coordinates=False
142
- )
143
- ```
144
-
145
- then, create Builder and generate Material:
146
-
147
- ```python
148
- builder = SlabPerturbationBuilder()
149
- perturbed_slab = builder.get_material(perturbation_config)
150
- ```
151
-
152
- or, alternatively, use the top-level function:
153
-
154
- ```python
155
- from mat3ra.made.tools import create_perturbation
156
-
157
- perturbed_slab = create_perturbation(perturbation_config,
158
- builder=SlabPerturbationBuilder)
159
- ```
160
-
161
- Finally, one can review the content of the material:
162
-
163
- ```python
164
- print(perturbed_slab.to_dict())
165
- ```
166
-
167
-
168
-
169
- ## Links
170
-
171
- 1. [Exabyte Source of Schemas and Examples (ESSE), Github Repository](https://arxiv.org/abs/1902.10838, "Exabyte Source of Schemas and Examples (ESSE), Github Repository")
172
- 2. [ASE](https://wiki.fysik.dtu.dk/ase/, "ASE")
173
- 3. [Pymatgen](https://pymatgen.org/, "Pymatgen")
File without changes
@@ -1,31 +0,0 @@
1
- from typing import Union
2
-
3
- import numpy as np
4
- from mat3ra.made.material import Material
5
- from pydantic import BaseModel
6
- from scipy.spatial.distance import pdist
7
-
8
- from ..build_components.metadata.material_with_build_metadata import MaterialWithBuildMetadata
9
- from .other import get_chemical_formula_empirical
10
- from .utils import decorator_perform_operation_in_cartesian_coordinates
11
-
12
-
13
- class BaseMaterialAnalyzer(BaseModel):
14
- material: Union[Material, MaterialWithBuildMetadata]
15
-
16
- @property
17
- def volume(self):
18
- return self.material.basis.cell.volume
19
-
20
- @property
21
- def atomic_density(self):
22
- return len(self.material.coordinates_array) / self.volume
23
-
24
- @property
25
- @decorator_perform_operation_in_cartesian_coordinates
26
- def pairwise_distances(self):
27
- return pdist(np.array(self.material.coordinates_array))
28
-
29
- @property
30
- def formula(self):
31
- return get_chemical_formula_empirical(self.material)
@@ -1,3 +0,0 @@
1
- from .analyzer import BasisMaterialAnalyzer
2
-
3
- __all__ = ["BasisMaterialAnalyzer"]
@@ -1,50 +0,0 @@
1
- from mat3ra.esse.models.core.reusable.axis_enum import AxisEnum
2
- from mat3ra.made.utils import AXIS_TO_INDEX_MAP
3
-
4
- from .. import BaseMaterialAnalyzer
5
- from ..fingerprint import LayeredFingerprintAlongAxis, UniqueElementStringsPerLayer
6
-
7
-
8
- class BasisMaterialAnalyzer(BaseMaterialAnalyzer):
9
- def get_layer_fingerprint(
10
- self, layer_thickness: float = 1.0, axis: AxisEnum = AxisEnum.z
11
- ) -> LayeredFingerprintAlongAxis:
12
- """
13
- Create a fingerprint of the material by analyzing layers along the specified axis.
14
-
15
- Args:
16
- layer_thickness: Thickness of each layer in Angstroms
17
- axis: Axis along which to compute the fingerprint
18
-
19
- Returns:
20
- LayeredFingerprintAlongAxis: Structured fingerprint with layer information
21
- """
22
- material_cartesian = self.material.clone()
23
- material_cartesian.to_cartesian()
24
-
25
- coordinates = material_cartesian.basis.coordinates.values
26
- elements = material_cartesian.basis.elements.values
27
-
28
- axis_index = AXIS_TO_INDEX_MAP[axis.value]
29
- axis_coords = [coord[axis_index] for coord in coordinates]
30
- min_coord, max_coord = min(axis_coords), max(axis_coords)
31
-
32
- fingerprint = LayeredFingerprintAlongAxis(axis=axis, layer_thickness=layer_thickness)
33
-
34
- current_coord = min_coord
35
- while current_coord < max_coord:
36
- layer_min = current_coord
37
- layer_max = current_coord + layer_thickness
38
-
39
- layer_elements = []
40
- for i, coord_val in enumerate(axis_coords):
41
- if layer_min <= coord_val < layer_max:
42
- layer_elements.append(elements[i])
43
-
44
- unique_elements = sorted(list(set(layer_elements))) if layer_elements else []
45
- layer = UniqueElementStringsPerLayer(min_coord=layer_min, max_coord=layer_max, elements=unique_elements)
46
- fingerprint.layers.append(layer)
47
-
48
- current_coord += layer_thickness
49
-
50
- return fingerprint