nomad-parser-plugins-electronic 1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (272) hide show
  1. electronicparsers/__init__.py +1162 -0
  2. electronicparsers/abacus/__init__.py +20 -0
  3. electronicparsers/abacus/__main__.py +32 -0
  4. electronicparsers/abacus/metainfo/__init__.py +19 -0
  5. electronicparsers/abacus/metainfo/abacus.py +836 -0
  6. electronicparsers/abacus/nomad_plugin.yaml +44 -0
  7. electronicparsers/abacus/parser.py +1975 -0
  8. electronicparsers/abinit/__init__.py +19 -0
  9. electronicparsers/abinit/__main__.py +31 -0
  10. electronicparsers/abinit/metainfo/__init__.py +20 -0
  11. electronicparsers/abinit/metainfo/abinit.py +871 -0
  12. electronicparsers/abinit/metainfo/abinit_autogenerated.py +6794 -0
  13. electronicparsers/abinit/nomad_plugin.yaml +43 -0
  14. electronicparsers/abinit/parser.py +1922 -0
  15. electronicparsers/ams/__init__.py +19 -0
  16. electronicparsers/ams/__main__.py +31 -0
  17. electronicparsers/ams/metainfo/__init__.py +19 -0
  18. electronicparsers/ams/metainfo/ams.py +769 -0
  19. electronicparsers/ams/nomad_plugin.yaml +19 -0
  20. electronicparsers/ams/parser.py +1849 -0
  21. electronicparsers/ams/rkf.py +620 -0
  22. electronicparsers/atk/__init__.py +19 -0
  23. electronicparsers/atk/__main__.py +31 -0
  24. electronicparsers/atk/metainfo/__init__.py +19 -0
  25. electronicparsers/atk/metainfo/atk.py +71 -0
  26. electronicparsers/atk/nomad_plugin.yaml +34 -0
  27. electronicparsers/atk/parser.py +388 -0
  28. electronicparsers/bigdft/__init__.py +19 -0
  29. electronicparsers/bigdft/__main__.py +31 -0
  30. electronicparsers/bigdft/metainfo/__init__.py +18 -0
  31. electronicparsers/bigdft/nomad_plugin.yaml +19 -0
  32. electronicparsers/bigdft/parser.py +372 -0
  33. electronicparsers/castep/__init__.py +19 -0
  34. electronicparsers/castep/__main__.py +31 -0
  35. electronicparsers/castep/metainfo/__init__.py +19 -0
  36. electronicparsers/castep/metainfo/castep.py +2481 -0
  37. electronicparsers/castep/nomad_plugin.yaml +28 -0
  38. electronicparsers/castep/parser.py +1680 -0
  39. electronicparsers/charmm/__init__.py +19 -0
  40. electronicparsers/charmm/__main__.py +31 -0
  41. electronicparsers/charmm/metainfo/__init__.py +19 -0
  42. electronicparsers/charmm/metainfo/charmm.py +1931 -0
  43. electronicparsers/charmm/nomad_plugin.yaml +18 -0
  44. electronicparsers/charmm/parser.py +61 -0
  45. electronicparsers/cp2k/__init__.py +19 -0
  46. electronicparsers/cp2k/__main__.py +31 -0
  47. electronicparsers/cp2k/metainfo/__init__.py +19 -0
  48. electronicparsers/cp2k/metainfo/cp2k.py +59185 -0
  49. electronicparsers/cp2k/metainfo/cp2k_general.py +1014 -0
  50. electronicparsers/cp2k/nomad_plugin.yaml +49 -0
  51. electronicparsers/cp2k/parser.py +2324 -0
  52. electronicparsers/cpmd/__init__.py +19 -0
  53. electronicparsers/cpmd/__main__.py +31 -0
  54. electronicparsers/cpmd/metainfo/__init__.py +19 -0
  55. electronicparsers/cpmd/metainfo/cpmd.py +10733 -0
  56. electronicparsers/cpmd/metainfo/cpmd_general.py +988 -0
  57. electronicparsers/cpmd/nomad_plugin.yaml +19 -0
  58. electronicparsers/cpmd/parser.py +680 -0
  59. electronicparsers/crystal/__init__.py +19 -0
  60. electronicparsers/crystal/__main__.py +31 -0
  61. electronicparsers/crystal/metainfo/__init__.py +19 -0
  62. electronicparsers/crystal/metainfo/crystal.py +619 -0
  63. electronicparsers/crystal/nomad_plugin.yaml +36 -0
  64. electronicparsers/crystal/parser.py +1745 -0
  65. electronicparsers/dmol3/__init__.py +19 -0
  66. electronicparsers/dmol3/__main__.py +31 -0
  67. electronicparsers/dmol3/metainfo/__init__.py +19 -0
  68. electronicparsers/dmol3/metainfo/dmol3.py +664 -0
  69. electronicparsers/dmol3/nomad_plugin.yaml +19 -0
  70. electronicparsers/dmol3/parser.py +750 -0
  71. electronicparsers/edmft/__init__.py +19 -0
  72. electronicparsers/edmft/__main__.py +31 -0
  73. electronicparsers/edmft/metainfo/__init__.py +19 -0
  74. electronicparsers/edmft/metainfo/edmft.py +96 -0
  75. electronicparsers/edmft/nomad_plugin.yaml +53 -0
  76. electronicparsers/edmft/parser.py +912 -0
  77. electronicparsers/elk/__init__.py +19 -0
  78. electronicparsers/elk/__main__.py +31 -0
  79. electronicparsers/elk/metainfo/__init__.py +19 -0
  80. electronicparsers/elk/metainfo/elk.py +775 -0
  81. electronicparsers/elk/nomad_plugin.yaml +19 -0
  82. electronicparsers/elk/parser.py +493 -0
  83. electronicparsers/exciting/__init__.py +19 -0
  84. electronicparsers/exciting/__main__.py +31 -0
  85. electronicparsers/exciting/metainfo/__init__.py +19 -0
  86. electronicparsers/exciting/metainfo/exciting.py +2942 -0
  87. electronicparsers/exciting/nomad_plugin.yaml +83 -0
  88. electronicparsers/exciting/parser.py +3398 -0
  89. electronicparsers/fhiaims/__init__.py +19 -0
  90. electronicparsers/fhiaims/__main__.py +31 -0
  91. electronicparsers/fhiaims/metainfo/__init__.py +19 -0
  92. electronicparsers/fhiaims/metainfo/fhi_aims.py +1565 -0
  93. electronicparsers/fhiaims/nomad_plugin.yaml +52 -0
  94. electronicparsers/fhiaims/parser.py +2582 -0
  95. electronicparsers/fleur/__init__.py +19 -0
  96. electronicparsers/fleur/__main__.py +31 -0
  97. electronicparsers/fleur/metainfo/__init__.py +19 -0
  98. electronicparsers/fleur/metainfo/fleur.py +623 -0
  99. electronicparsers/fleur/nomad_plugin.yaml +19 -0
  100. electronicparsers/fleur/parser.py +952 -0
  101. electronicparsers/fplo/__init__.py +19 -0
  102. electronicparsers/fplo/__main__.py +31 -0
  103. electronicparsers/fplo/metainfo/__init__.py +19 -0
  104. electronicparsers/fplo/metainfo/fplo.py +188 -0
  105. electronicparsers/fplo/metainfo/fplo_input_autogenerated.py +2744 -0
  106. electronicparsers/fplo/metainfo/fplo_temporaries.py +319 -0
  107. electronicparsers/fplo/nomad_plugin.yaml +19 -0
  108. electronicparsers/fplo/parser.py +42 -0
  109. electronicparsers/gamess/__init__.py +19 -0
  110. electronicparsers/gamess/__main__.py +31 -0
  111. electronicparsers/gamess/metainfo/__init__.py +19 -0
  112. electronicparsers/gamess/metainfo/gamess.py +837 -0
  113. electronicparsers/gamess/nomad_plugin.yaml +19 -0
  114. electronicparsers/gamess/parser.py +941 -0
  115. electronicparsers/gaussian/__init__.py +19 -0
  116. electronicparsers/gaussian/__main__.py +31 -0
  117. electronicparsers/gaussian/metainfo/__init__.py +19 -0
  118. electronicparsers/gaussian/metainfo/gaussian.py +1707 -0
  119. electronicparsers/gaussian/nomad_plugin.yaml +18 -0
  120. electronicparsers/gaussian/parser.py +1556 -0
  121. electronicparsers/gpaw/__init__.py +19 -0
  122. electronicparsers/gpaw/__main__.py +31 -0
  123. electronicparsers/gpaw/metainfo/__init__.py +19 -0
  124. electronicparsers/gpaw/metainfo/gpaw.py +214 -0
  125. electronicparsers/gpaw/nomad_plugin.yaml +19 -0
  126. electronicparsers/gpaw/parser.py +671 -0
  127. electronicparsers/magres/__init__.py +19 -0
  128. electronicparsers/magres/__main__.py +31 -0
  129. electronicparsers/magres/metainfo/__init__.py +19 -0
  130. electronicparsers/magres/metainfo/magres.py +110 -0
  131. electronicparsers/magres/nomad_plugin.yaml +18 -0
  132. electronicparsers/magres/parser.py +505 -0
  133. electronicparsers/molcas/__init__.py +19 -0
  134. electronicparsers/molcas/__main__.py +31 -0
  135. electronicparsers/molcas/metainfo/__init__.py +19 -0
  136. electronicparsers/molcas/metainfo/molcas.py +151 -0
  137. electronicparsers/molcas/nomad_plugin.yaml +19 -0
  138. electronicparsers/molcas/parser.py +59 -0
  139. electronicparsers/mopac/__init__.py +19 -0
  140. electronicparsers/mopac/__main__.py +31 -0
  141. electronicparsers/mopac/metainfo/__init__.py +19 -0
  142. electronicparsers/mopac/metainfo/mopac.py +79 -0
  143. electronicparsers/mopac/nomad_plugin.yaml +19 -0
  144. electronicparsers/mopac/parser.py +304 -0
  145. electronicparsers/nwchem/__init__.py +19 -0
  146. electronicparsers/nwchem/__main__.py +31 -0
  147. electronicparsers/nwchem/metainfo/__init__.py +19 -0
  148. electronicparsers/nwchem/metainfo/nwchem.py +487 -0
  149. electronicparsers/nwchem/nomad_plugin.yaml +19 -0
  150. electronicparsers/nwchem/parser.py +757 -0
  151. electronicparsers/ocean/__init__.py +19 -0
  152. electronicparsers/ocean/__main__.py +31 -0
  153. electronicparsers/ocean/metainfo/__init__.py +19 -0
  154. electronicparsers/ocean/metainfo/ocean.py +410 -0
  155. electronicparsers/ocean/nomad_plugin.yaml +37 -0
  156. electronicparsers/ocean/parser.py +344 -0
  157. electronicparsers/octopus/__init__.py +19 -0
  158. electronicparsers/octopus/__main__.py +31 -0
  159. electronicparsers/octopus/metainfo/__init__.py +19 -0
  160. electronicparsers/octopus/metainfo/octopus.py +71 -0
  161. electronicparsers/octopus/metainfo/octopus_autogenerated.py +11647 -0
  162. electronicparsers/octopus/nomad_plugin.yaml +41 -0
  163. electronicparsers/octopus/parser.py +1214 -0
  164. electronicparsers/onetep/__init__.py +19 -0
  165. electronicparsers/onetep/__main__.py +31 -0
  166. electronicparsers/onetep/metainfo/__init__.py +19 -0
  167. electronicparsers/onetep/metainfo/onetep.py +3443 -0
  168. electronicparsers/onetep/nomad_plugin.yaml +19 -0
  169. electronicparsers/onetep/parser.py +577 -0
  170. electronicparsers/openmx/__init__.py +19 -0
  171. electronicparsers/openmx/__main__.py +31 -0
  172. electronicparsers/openmx/metainfo/__init__.py +19 -0
  173. electronicparsers/openmx/metainfo/openmx.py +24 -0
  174. electronicparsers/openmx/nomad_plugin.yaml +25 -0
  175. electronicparsers/openmx/parser.py +918 -0
  176. electronicparsers/orca/__init__.py +19 -0
  177. electronicparsers/orca/__main__.py +31 -0
  178. electronicparsers/orca/metainfo/__init__.py +19 -0
  179. electronicparsers/orca/metainfo/orca.py +1448 -0
  180. electronicparsers/orca/nomad_plugin.yaml +19 -0
  181. electronicparsers/orca/parser.py +1371 -0
  182. electronicparsers/psi4/__init__.py +19 -0
  183. electronicparsers/psi4/__main__.py +31 -0
  184. electronicparsers/psi4/metainfo/__init__.py +19 -0
  185. electronicparsers/psi4/metainfo/psi4.py +372 -0
  186. electronicparsers/psi4/nomad_plugin.yaml +27 -0
  187. electronicparsers/psi4/parser.py +1362 -0
  188. electronicparsers/qball/__init__.py +19 -0
  189. electronicparsers/qball/__main__.py +31 -0
  190. electronicparsers/qball/metainfo/__init__.py +19 -0
  191. electronicparsers/qball/metainfo/qball.py +27 -0
  192. electronicparsers/qball/nomad_plugin.yaml +25 -0
  193. electronicparsers/qball/parser.py +152 -0
  194. electronicparsers/qbox/__init__.py +19 -0
  195. electronicparsers/qbox/__main__.py +31 -0
  196. electronicparsers/qbox/metainfo/__init__.py +19 -0
  197. electronicparsers/qbox/metainfo/qbox.py +490 -0
  198. electronicparsers/qbox/nomad_plugin.yaml +19 -0
  199. electronicparsers/qbox/parser.py +508 -0
  200. electronicparsers/quantumespresso/__init__.py +19 -0
  201. electronicparsers/quantumespresso/__main__.py +31 -0
  202. electronicparsers/quantumespresso/metainfo/__init__.py +19 -0
  203. electronicparsers/quantumespresso/metainfo/quantum_espresso.py +3296 -0
  204. electronicparsers/quantumespresso/nomad_plugin.yaml +31 -0
  205. electronicparsers/quantumespresso/parser.py +3594 -0
  206. electronicparsers/siesta/__init__.py +19 -0
  207. electronicparsers/siesta/__main__.py +31 -0
  208. electronicparsers/siesta/metainfo/__init__.py +19 -0
  209. electronicparsers/siesta/metainfo/siesta.py +141 -0
  210. electronicparsers/siesta/metainfo/siesta_autogenerated.py +3365 -0
  211. electronicparsers/siesta/nomad_plugin.yaml +19 -0
  212. electronicparsers/siesta/parser.py +607 -0
  213. electronicparsers/soliddmft/__init__.py +19 -0
  214. electronicparsers/soliddmft/__main__.py +31 -0
  215. electronicparsers/soliddmft/metainfo/__init__.py +19 -0
  216. electronicparsers/soliddmft/metainfo/soliddmft.py +274 -0
  217. electronicparsers/soliddmft/nomad_plugin.yaml +26 -0
  218. electronicparsers/soliddmft/parser.py +727 -0
  219. electronicparsers/tbstudio/__init__.py +19 -0
  220. electronicparsers/tbstudio/__main__.py +31 -0
  221. electronicparsers/tbstudio/metainfo/__init__.py +19 -0
  222. electronicparsers/tbstudio/metainfo/tbstudio.py +34 -0
  223. electronicparsers/tbstudio/nomad_plugin.yaml +24 -0
  224. electronicparsers/tbstudio/parser.py +412 -0
  225. electronicparsers/turbomole/__init__.py +19 -0
  226. electronicparsers/turbomole/__main__.py +31 -0
  227. electronicparsers/turbomole/metainfo/__init__.py +19 -0
  228. electronicparsers/turbomole/metainfo/turbomole.py +727 -0
  229. electronicparsers/turbomole/nomad_plugin.yaml +18 -0
  230. electronicparsers/turbomole/parser.py +1585 -0
  231. electronicparsers/utils/__init__.py +20 -0
  232. electronicparsers/utils/magres_workflow.py +61 -0
  233. electronicparsers/utils/utils.py +636 -0
  234. electronicparsers/vasp/__init__.py +19 -0
  235. electronicparsers/vasp/__main__.py +31 -0
  236. electronicparsers/vasp/metainfo/__init__.py +19 -0
  237. electronicparsers/vasp/metainfo/vasp.py +169 -0
  238. electronicparsers/vasp/metainfo/vasp_incars.py +3428 -0
  239. electronicparsers/vasp/metainfo/vasp_incarsOut.py +3428 -0
  240. electronicparsers/vasp/metainfo/vasp_incarsUnknown.py +86 -0
  241. electronicparsers/vasp/nomad_plugin.yaml +28 -0
  242. electronicparsers/vasp/parser.py +2340 -0
  243. electronicparsers/w2dynamics/__init__.py +19 -0
  244. electronicparsers/w2dynamics/__main__.py +31 -0
  245. electronicparsers/w2dynamics/metainfo/__init__.py +19 -0
  246. electronicparsers/w2dynamics/metainfo/w2dynamics.py +1270 -0
  247. electronicparsers/w2dynamics/nomad_plugin.yaml +36 -0
  248. electronicparsers/w2dynamics/parser.py +674 -0
  249. electronicparsers/wannier90/__init__.py +19 -0
  250. electronicparsers/wannier90/__main__.py +31 -0
  251. electronicparsers/wannier90/metainfo/__init__.py +19 -0
  252. electronicparsers/wannier90/metainfo/wannier90.py +56 -0
  253. electronicparsers/wannier90/nomad_plugin.yaml +34 -0
  254. electronicparsers/wannier90/parser.py +671 -0
  255. electronicparsers/wien2k/__init__.py +19 -0
  256. electronicparsers/wien2k/__main__.py +31 -0
  257. electronicparsers/wien2k/metainfo/__init__.py +19 -0
  258. electronicparsers/wien2k/metainfo/wien2k.py +783 -0
  259. electronicparsers/wien2k/nomad_plugin.yaml +18 -0
  260. electronicparsers/wien2k/parser.py +1133 -0
  261. electronicparsers/yambo/__init__.py +19 -0
  262. electronicparsers/yambo/__main__.py +31 -0
  263. electronicparsers/yambo/metainfo/__init__.py +19 -0
  264. electronicparsers/yambo/metainfo/yambo.py +577 -0
  265. electronicparsers/yambo/nomad_plugin.yaml +31 -0
  266. electronicparsers/yambo/parser.py +896 -0
  267. nomad_parser_plugins_electronic-1.0.dist-info/LICENSE +202 -0
  268. nomad_parser_plugins_electronic-1.0.dist-info/METADATA +360 -0
  269. nomad_parser_plugins_electronic-1.0.dist-info/RECORD +272 -0
  270. nomad_parser_plugins_electronic-1.0.dist-info/WHEEL +5 -0
  271. nomad_parser_plugins_electronic-1.0.dist-info/entry_points.txt +43 -0
  272. nomad_parser_plugins_electronic-1.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2942 @@
1
+ #
2
+ # Copyright The NOMAD Authors.
3
+ #
4
+ # This file is part of NOMAD.
5
+ # See https://nomad-lab.eu for further info.
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ import numpy as np # pylint: disable=unused-import
20
+ import typing # pylint: disable=unused-import
21
+ from nomad.metainfo import ( # pylint: disable=unused-import
22
+ MSection,
23
+ MCategory,
24
+ Category,
25
+ Package,
26
+ Quantity,
27
+ Section,
28
+ SubSection,
29
+ SectionProxy,
30
+ Reference,
31
+ )
32
+ import runschema.run # pylint: disable=unused-import
33
+ import runschema.calculation # pylint: disable=unused-import
34
+ import runschema.method # pylint: disable=unused-import
35
+ import runschema.system # pylint: disable=unused-import
36
+
37
+
38
+ m_package = Package()
39
+
40
+
41
+ class x_exciting_section_geometry_optimization(MSection):
42
+ """
43
+ section for geometry optimization
44
+ """
45
+
46
+ m_def = Section(validate=False)
47
+
48
+
49
+ class x_exciting_section_atoms_group(MSection):
50
+ """
51
+ a group of atoms of the same type
52
+ """
53
+
54
+ m_def = Section(validate=False)
55
+
56
+ x_exciting_geometry_atom_labels = Quantity(
57
+ type=str,
58
+ shape=[],
59
+ description="""
60
+ labels of atom
61
+ """,
62
+ )
63
+
64
+ x_exciting_geometry_atom_number = Quantity(
65
+ type=str,
66
+ shape=[],
67
+ description="""
68
+ number to identify the atoms of a species
69
+ """,
70
+ )
71
+
72
+ x_exciting_atom_number = Quantity(
73
+ type=str,
74
+ shape=[],
75
+ description="""
76
+ number to identify the atoms of a species in the geometry optimization
77
+ """,
78
+ )
79
+
80
+ x_exciting_atom_label = Quantity(
81
+ type=str,
82
+ shape=[],
83
+ description="""
84
+ labels of atoms in geometry optimization
85
+ """,
86
+ )
87
+
88
+ x_exciting_MT_external_magnetic_field_atom_number = Quantity(
89
+ type=str,
90
+ shape=[],
91
+ description="""
92
+ number to identify the atoms of a species on which a magnetic field is applied
93
+ """,
94
+ )
95
+
96
+ x_exciting_geometry_atom_positions = Quantity(
97
+ type=np.float64,
98
+ shape=['*', 3],
99
+ description="""
100
+ atomic positions
101
+ """,
102
+ )
103
+
104
+ x_exciting_geometry_atom_positions_x = Quantity(
105
+ type=np.float64,
106
+ shape=[],
107
+ description="""
108
+ x component of atomic position
109
+ """,
110
+ )
111
+
112
+ x_exciting_geometry_atom_positions_y = Quantity(
113
+ type=np.float64,
114
+ shape=[],
115
+ description="""
116
+ y component of atomic position
117
+ """,
118
+ )
119
+
120
+ x_exciting_geometry_atom_positions_z = Quantity(
121
+ type=np.float64,
122
+ shape=[],
123
+ description="""
124
+ z component of atomic position
125
+ """,
126
+ )
127
+
128
+ x_exciting_MT_external_magnetic_field_x = Quantity(
129
+ type=np.float64,
130
+ shape=[],
131
+ description="""
132
+ x component of the magnetic field
133
+ """,
134
+ )
135
+
136
+ x_exciting_MT_external_magnetic_field_y = Quantity(
137
+ type=np.float64,
138
+ shape=[],
139
+ description="""
140
+ y component of the magnetic field
141
+ """,
142
+ )
143
+
144
+ x_exciting_MT_external_magnetic_field_z = Quantity(
145
+ type=np.float64,
146
+ shape=[],
147
+ description="""
148
+ z component of the magnetic field
149
+ """,
150
+ )
151
+
152
+ x_exciting_muffin_tin_points = Quantity(
153
+ type=np.int32,
154
+ shape=[],
155
+ description="""
156
+ muffin-tin points
157
+ """,
158
+ )
159
+
160
+ x_exciting_muffin_tin_radius = Quantity(
161
+ type=np.float64,
162
+ shape=[],
163
+ unit='meter',
164
+ description="""
165
+ muffin-tin radius
166
+ """,
167
+ )
168
+
169
+ x_exciting_atom_position_format = Quantity(
170
+ type=str,
171
+ shape=[],
172
+ description="""
173
+ whether the atomic positions are given in cartesian or vector coordinates
174
+ """,
175
+ )
176
+
177
+ x_exciting_magnetic_field_format = Quantity(
178
+ type=str,
179
+ shape=[],
180
+ description="""
181
+ whether the magnetic field is given in cartesian or vector coordinates
182
+ """,
183
+ )
184
+
185
+
186
+ class x_exciting_section_bandstructure(MSection):
187
+ """
188
+ bandstructure values
189
+ """
190
+
191
+ m_def = Section(validate=False)
192
+
193
+ x_exciting_band_number_of_vertices = Quantity(
194
+ type=np.int32,
195
+ shape=[],
196
+ description="""
197
+ number of vertices along the kpoint path used for the bandstructure plot
198
+ """,
199
+ )
200
+
201
+ x_exciting_band_number_of_kpoints = Quantity(
202
+ type=np.int32,
203
+ shape=[],
204
+ description="""
205
+ number of points along the kpoint path used for the bandstructure plot
206
+ """,
207
+ )
208
+
209
+ x_exciting_band_vertex_labels = Quantity(
210
+ type=str,
211
+ shape=['x_exciting_band_number_of_vertices'],
212
+ description="""
213
+ labels of the vertices along the kpoint path used for the bandstructure plot
214
+ """,
215
+ )
216
+
217
+ x_exciting_band_vertex_coordinates = Quantity(
218
+ type=np.float64,
219
+ shape=['x_exciting_band_number_of_vertices', 3],
220
+ description="""
221
+ coordinates of the vertices along the kpoint path used for the bandstructure plot
222
+ """,
223
+ )
224
+
225
+ x_exciting_band_structure_kind = Quantity(
226
+ type=str,
227
+ shape=[],
228
+ description="""
229
+ String to specify the kind of band structure (either electronic or vibrational).
230
+ """,
231
+ )
232
+
233
+ x_exciting_band_number_of_eigenvalues = Quantity(
234
+ type=np.int32,
235
+ shape=[],
236
+ description="""
237
+ number of eigenvalues per k-point
238
+ """,
239
+ )
240
+
241
+ x_exciting_band_k_points = Quantity(
242
+ type=np.float64,
243
+ shape=['x_exciting_band_number_of_kpoints'],
244
+ description="""
245
+ Fractional coordinates of the k points (in the basis of the reciprocal-lattice
246
+ vectors) for which the electronic energy are given.
247
+ """,
248
+ )
249
+
250
+ x_exciting_band_energies = Quantity(
251
+ type=np.float64,
252
+ shape=[
253
+ 'number_of_spin_channels',
254
+ 'x_exciting_band_number_of_kpoints',
255
+ 'x_exciting_band_number_of_eigenvalues',
256
+ ],
257
+ unit='joule',
258
+ description="""
259
+ $k$-dependent energies of the electronic band structure.
260
+ """,
261
+ )
262
+
263
+ x_exciting_band_value = Quantity(
264
+ type=np.float64,
265
+ shape=[],
266
+ unit='joule',
267
+ description="""
268
+ Bandstructure energy values
269
+ """,
270
+ )
271
+
272
+
273
+ class x_exciting_section_dos(MSection):
274
+ """
275
+ dos values
276
+ """
277
+
278
+ m_def = Section(validate=False)
279
+
280
+ x_exciting_dos_energy = Quantity(
281
+ type=np.float64,
282
+ shape=[],
283
+ unit='joule',
284
+ description="""
285
+ energy value for a dos point
286
+ """,
287
+ )
288
+
289
+ x_exciting_dos_value = Quantity(
290
+ type=np.float64,
291
+ shape=[],
292
+ unit='1 / joule',
293
+ description="""
294
+ Density of states values
295
+ """,
296
+ )
297
+
298
+
299
+ class x_exciting_section_fermi_surface(MSection):
300
+ """
301
+ Fermi surface values
302
+ """
303
+
304
+ m_def = Section(validate=False)
305
+
306
+ x_exciting_fermi_energy_fermi_surface = Quantity(
307
+ type=np.float64,
308
+ shape=[],
309
+ unit='joule',
310
+ description="""
311
+ Fermi energy for Fermi surface
312
+ """,
313
+ )
314
+
315
+ x_exciting_grid_fermi_surface = Quantity(
316
+ type=np.int32,
317
+ shape=[3],
318
+ description="""
319
+ number of points in the mesh to calculate the Fermi surface
320
+ """,
321
+ )
322
+
323
+ x_exciting_number_of_bands_fermi_surface = Quantity(
324
+ type=np.int32,
325
+ shape=[],
326
+ description="""
327
+ Number of bands for fermi surface
328
+ """,
329
+ )
330
+
331
+ x_exciting_number_of_mesh_points_fermi_surface = Quantity(
332
+ type=np.int32,
333
+ shape=[],
334
+ description="""
335
+ Number of mesh points for fermi surface
336
+ """,
337
+ )
338
+
339
+ x_exciting_origin_fermi_surface = Quantity(
340
+ type=np.float64,
341
+ shape=[3],
342
+ description="""
343
+ Origin (in lattice coordinate) of the region where the Fermi surface is calculated
344
+ """,
345
+ )
346
+
347
+ x_exciting_values_fermi_surface = Quantity(
348
+ type=np.float64,
349
+ shape=[
350
+ 'x_exciting_number_of_bands_fermi_surface',
351
+ 'x_exciting_number_of_mesh_points_fermi_surface',
352
+ ],
353
+ unit='joule',
354
+ description="""
355
+ Fermi surface values
356
+ """,
357
+ )
358
+
359
+ x_exciting_vectors_fermi_surface = Quantity(
360
+ type=np.float64,
361
+ shape=[3, 3],
362
+ description="""
363
+ Vectors (in lattice coordinate) defining the region where the Fermi surface is
364
+ calculated
365
+ """,
366
+ )
367
+
368
+
369
+ class x_exciting_section_lattice_vectors(MSection):
370
+ """
371
+ lattice vectors
372
+ """
373
+
374
+ m_def = Section(validate=False)
375
+
376
+ x_exciting_geometry_lattice_vector_x = Quantity(
377
+ type=np.float64,
378
+ shape=[],
379
+ unit='meter',
380
+ description="""
381
+ x component of lattice vector
382
+ """,
383
+ )
384
+
385
+ x_exciting_geometry_lattice_vector_y = Quantity(
386
+ type=np.float64,
387
+ shape=[],
388
+ unit='meter',
389
+ description="""
390
+ y component of lattice vector
391
+ """,
392
+ )
393
+
394
+ x_exciting_geometry_lattice_vector_z = Quantity(
395
+ type=np.float64,
396
+ shape=[],
397
+ unit='meter',
398
+ description="""
399
+ z component of lattice vector
400
+ """,
401
+ )
402
+
403
+
404
+ class x_exciting_section_reciprocal_lattice_vectors(MSection):
405
+ """
406
+ reciprocal lattice vectors
407
+ """
408
+
409
+ m_def = Section(validate=False)
410
+
411
+ x_exciting_geometry_reciprocal_lattice_vector_x = Quantity(
412
+ type=np.float64,
413
+ shape=[],
414
+ unit='1 / meter',
415
+ description="""
416
+ x component of reciprocal lattice vector
417
+ """,
418
+ )
419
+
420
+ x_exciting_geometry_reciprocal_lattice_vector_y = Quantity(
421
+ type=np.float64,
422
+ shape=[],
423
+ unit='1 / meter',
424
+ description="""
425
+ y component of reciprocal lattice vector
426
+ """,
427
+ )
428
+
429
+ x_exciting_geometry_reciprocal_lattice_vector_z = Quantity(
430
+ type=np.float64,
431
+ shape=[],
432
+ unit='1 / meter',
433
+ description="""
434
+ z component of reciprocal lattice vector
435
+ """,
436
+ )
437
+
438
+
439
+ class x_exciting_section_spin(MSection):
440
+ """
441
+ section for exciting spin treatment
442
+ """
443
+
444
+ m_def = Section(validate=False)
445
+
446
+ x_exciting_spin_treatment = Quantity(
447
+ type=str,
448
+ shape=[],
449
+ description="""
450
+ Spin treatment
451
+ """,
452
+ )
453
+
454
+
455
+ class x_exciting_section_xc(MSection):
456
+ """
457
+ index for exciting functional
458
+ """
459
+
460
+ m_def = Section(validate=False)
461
+
462
+ x_exciting_xc_functional = Quantity(
463
+ type=np.int32,
464
+ shape=[],
465
+ description="""
466
+ index for exciting functional
467
+ """,
468
+ )
469
+
470
+
471
+ class x_exciting_freqgrid_parameters(MSection):
472
+ """
473
+ Frequency grid setup used for computing W(q,omega) and Sigma(k,omega).
474
+ """
475
+
476
+ m_def = Section(validate=False)
477
+
478
+ x_exciting_eta = Quantity(
479
+ type=np.float64,
480
+ shape=[],
481
+ description="""
482
+ Numerical (complex) smearing parameter used for the real frequency convolution
483
+ and qdepw=sum.
484
+ """,
485
+ )
486
+
487
+ x_exciting_fconv = Quantity(
488
+ type=str,
489
+ shape=[],
490
+ description="""
491
+ Frequency convolution type:
492
+ nofreq - skip frequency dependency (testing option).
493
+ refreq - real frequency formalism (only for response functions).
494
+ imfreq - imaginary frequency formalism.
495
+ """,
496
+ )
497
+
498
+ x_exciting_fgrid = Quantity(
499
+ type=str,
500
+ shape=[],
501
+ description="""
502
+ Grid types (listed only the recommended ones, for more grids see the source
503
+ subroutine mod_frequency.f90):
504
+ eqdist - Equidistant grid from freqmin to freqmax.
505
+ gaulag - Grid for the Gauss-Laguerre quadrature rule from 0 to ∞.
506
+ gauleg - Grid for the Gauss-Lagendre quadrature rule from 0 to ∞.
507
+ gauleg2 - Grid for the double Gauss-Lagendre quadrature rule from 0 to freqmax
508
+ and freqmax to ∞.
509
+ clencurt2 - Grid for the Clenshaw-Curtis quadrature rule from 0 to ∞. freqmax
510
+ can be used to rescale the frequencies.
511
+ """,
512
+ )
513
+
514
+ x_exciting_freqmax = Quantity(
515
+ type=np.float64,
516
+ shape=[],
517
+ description="""
518
+ Upper limit for the grid interval.
519
+ """,
520
+ )
521
+
522
+ x_exciting_freqmin = Quantity(
523
+ type=np.float64,
524
+ shape=[],
525
+ description="""
526
+ Lower limit for the grid interval.
527
+ """,
528
+ )
529
+
530
+ x_exciting_nomeg = Quantity(
531
+ type=np.int32,
532
+ shape=[],
533
+ description="""
534
+ Number of grid points.
535
+ """,
536
+ )
537
+
538
+
539
+ class x_exciting_selfenergy_parameters(MSection):
540
+ """
541
+ Correlation self-energy setup.
542
+ """
543
+
544
+ m_def = Section(validate=False)
545
+
546
+ x_exciting_actype = Quantity(
547
+ type=str,
548
+ shape=[],
549
+ description="""
550
+ Analytical continuation scheme:
551
+ pade - Pade's approximant (by H. J. Vidberg and J. W. Serence, J. Low Temp.
552
+ Phys. 29, 179 (1977)).
553
+ aaa - Y. Nakatsukasa, O. Sete, L. N. Trefethen, "The AAA algorithm for rational
554
+ approximation", SIAM J. Sci. Comp. 40 (2018), A1494-A1522.
555
+ """,
556
+ )
557
+
558
+ x_exciting_eqpsolver = Quantity(
559
+ type=np.int32,
560
+ shape=[],
561
+ description="""
562
+ Schemes to solve the quasiparticle (non-linear) equation:
563
+ 0 - Perturbative solution.
564
+ 1 - Z=1 calculations.
565
+ 2 - Iterative solution.
566
+ """,
567
+ )
568
+
569
+ x_exciting_eshift = Quantity(
570
+ type=np.int32,
571
+ shape=[],
572
+ description="""
573
+ Alignment of the chemical potential:
574
+ 0 - No alignment.
575
+ 1 - Self-consistency at the Fermi level (iteratively).
576
+ 2 - Self-consistency at the Fermi level (perturbatively).
577
+ """,
578
+ )
579
+
580
+ x_exciting_method = Quantity(
581
+ type=str,
582
+ shape=[],
583
+ description="""
584
+ Technique to compute the frequency convolution integral:
585
+ ac - Analytical continuation
586
+ cd - Contour deformation
587
+ """,
588
+ )
589
+
590
+ x_exciting_nempty = Quantity(
591
+ type=np.int32,
592
+ shape=[],
593
+ description="""
594
+ Number of empty states to calculate the correlation self energy (different from default).
595
+ """,
596
+ )
597
+
598
+ x_exciting_singularity = Quantity(
599
+ type=str,
600
+ shape=[],
601
+ description="""
602
+ Treatment of the q→0 singularity:
603
+ none': No special treatment (test purpose only).
604
+ mpb': Auxiliary function method by S. Massidda, M. Posternak, and A.
605
+ Baldereschi, PRB 48, 5058 (1993)
606
+ crg': Auxiliary function method by P. Carrier, S. Rohra, and A. Goerling,
607
+ PRB 75, 205126 (2007).
608
+ """,
609
+ )
610
+
611
+ x_exciting_swidth = Quantity(
612
+ type=np.float64,
613
+ shape=[],
614
+ description="""
615
+ Smearing parameter for visualizing the spectral function.
616
+ """,
617
+ )
618
+
619
+ x_exciting_tol = Quantity(
620
+ type=np.float64,
621
+ shape=[],
622
+ description="""
623
+ Tolerance factor used for generating support points in AAA-interpolation.
624
+ """,
625
+ )
626
+
627
+
628
+ class x_exciting_wgrid_parameters(MSection):
629
+ """
630
+ The real frequency grid (output) setup for computing and visualizing the correlation
631
+ self-energy and the spectral function. For more detailed description see freqgrid.
632
+ """
633
+
634
+ m_def = Section(validate=False)
635
+
636
+ x_exciting_size = Quantity(
637
+ type=np.int32,
638
+ shape=[],
639
+ description="""
640
+ Number of grid points.
641
+ """,
642
+ )
643
+
644
+ x_exciting_type = Quantity(
645
+ type=str,
646
+ shape=[],
647
+ description="""
648
+ Grid type.
649
+ """,
650
+ )
651
+
652
+ x_exciting_wmax = Quantity(
653
+ type=np.float64,
654
+ shape=[],
655
+ description="""
656
+ Upper limit for the grid interval.
657
+ """,
658
+ )
659
+
660
+ x_exciting_wmin = Quantity(
661
+ type=np.float64,
662
+ shape=[],
663
+ description="""
664
+ Lower limit for the grid interval.
665
+ """,
666
+ )
667
+
668
+
669
+ class x_exciting_mixbasis_parameters(MSection):
670
+ """
671
+ Mixed-product basis setup.
672
+ """
673
+
674
+ m_def = Section(validate=False)
675
+
676
+ x_exciting_epsmb = Quantity(
677
+ type=np.float64,
678
+ shape=[],
679
+ description="""
680
+ Linear dependence tolerance factor: controls construction of the radial part of
681
+ the mixed-product basis.
682
+ """,
683
+ )
684
+
685
+ x_exciting_gmb = Quantity(
686
+ type=np.float64,
687
+ shape=[],
688
+ description="""
689
+ Plane-wave energy cutoff (in units of GLAPWmax): controls construction of the
690
+ plane-wave part of the mixed-product basis.
691
+ """,
692
+ )
693
+
694
+ x_exciting_lmaxmb = Quantity(
695
+ type=np.int32,
696
+ shape=[],
697
+ description="""
698
+ Maximal angular momentum: controls construction of the radial part of the
699
+ mixed-product basis.
700
+ """,
701
+ )
702
+
703
+
704
+ class x_exciting_barecoul_parameters(MSection):
705
+ """
706
+ The bare Coulomb potential setup.
707
+ """
708
+
709
+ m_def = Section(validate=False)
710
+
711
+ x_exciting_barcevtol = Quantity(
712
+ type=np.float64,
713
+ shape=[],
714
+ description="""
715
+ Matrix elements of the polarizability, the screened Coulomb potential, and the
716
+ self-energy are computed in the basis that diagonalize the bare Coulomb potential.
717
+ This tolerance factor is used to reduce the size of the Vc-diagonal product basis
718
+ when computing the screened Coulomb potential and the correlation self-energy.
719
+ """,
720
+ )
721
+
722
+ x_exciting_basis = Quantity(
723
+ type=str,
724
+ shape=[],
725
+ description="""
726
+ Two approaches to compute the bare Coulomb potential:
727
+ mb - The Coulomb potential is computed in the mixed-product basis.
728
+ pw - The Coulomb potential is computed in the plane-wave basis and then
729
+ converted into the mixed-product basis. This option is used only when
730
+ the potential truncation technique cutofftype is employed. From practical
731
+ point, usage of this approach requires to set a higher value of pwm
732
+ (typically = 4.0)
733
+ """,
734
+ )
735
+
736
+ x_exciting_cutofftype = Quantity(
737
+ type=str,
738
+ shape=[],
739
+ description="""
740
+ Trigger the usage of the Coulomb potential truncation technique (S. Ismail-Beigi,
741
+ "Truncation of Periodic Image Interactions for Confined Systems. Phys. Rev. B 73,
742
+ 233103 (2006)).
743
+ none - 3D periodic crystal.
744
+ 0d - Isolated atom or molecule.
745
+ 1d - 1D chain (periodicity along z-axis)
746
+ 2d - 2D surface (vacuum separation along z-direction)
747
+ """,
748
+ )
749
+
750
+ x_exciting_pwm = Quantity(
751
+ type=np.float64,
752
+ shape=[],
753
+ description="""
754
+ Plane-wave energy cutoff (in units of gmaxvr*gmb) for computing the plane-wave
755
+ part of the Coulomb potential.
756
+ """,
757
+ )
758
+
759
+ x_exciting_stctol = Quantity(
760
+ type=np.float64,
761
+ shape=[],
762
+ description="""
763
+ Tolerance factor for computing the structure factor in Ewald summation scheme.
764
+ """,
765
+ )
766
+
767
+
768
+ class x_exciting_scrcoul_parameters(MSection):
769
+ """
770
+ Dynamically screened Coulomb potential setup.
771
+ """
772
+
773
+ m_def = Section(validate=False)
774
+
775
+ x_exciting_omegap = Quantity(
776
+ type=np.float64,
777
+ shape=[],
778
+ description="""
779
+ Plasmon-pole frequency (fitting parameter).
780
+ """,
781
+ )
782
+
783
+ x_exciting_scrtype = Quantity(
784
+ type=str,
785
+ shape=[],
786
+ description="""
787
+ Approximation:
788
+ rpa - Full-frequency Random-Phase Approximation.
789
+ ppm - Godby-Needs plasmon-pole model.
790
+ """,
791
+ )
792
+
793
+
794
+ class GW(runschema.method.GW):
795
+ m_def = Section(validate=False, extends_base_section=True)
796
+
797
+ x_exciting_coreflag = Quantity(
798
+ type=str,
799
+ shape=[],
800
+ description="""
801
+ Option for treating core states in GW:
802
+ all - All-electron treatment.
803
+ xal - Both core and valence states are used to compute the exchange self-energy
804
+ and only valence electrons for computing the correlation self-energy.
805
+ val - Valence-electron treatment.
806
+ vab - Valence-electron treatment where core states are also excluded from the
807
+ construction of the mixed-product basis.
808
+ """,
809
+ )
810
+
811
+ x_exciting_ibgw = Quantity(
812
+ type=np.int32,
813
+ shape=[],
814
+ description="""
815
+ QP corrections are computed for states in the interval [ibgw, nbgw].
816
+ """,
817
+ )
818
+
819
+ x_exciting_nbgw = Quantity(
820
+ type=np.int32,
821
+ shape=[],
822
+ description="""
823
+ QP corrections are computed for states in the interval [ibgw, nbgw].
824
+ """,
825
+ )
826
+
827
+ x_exciting_mblksiz = Quantity(
828
+ type=np.int32,
829
+ shape=[],
830
+ description="""
831
+ To reduce the memory usage, in summations over unoccupied states, big matrices are
832
+ considered to be in a block form with a size of mblksiz.
833
+ """,
834
+ )
835
+
836
+ x_exciting_nempty = Quantity(
837
+ type=np.int32,
838
+ shape=[],
839
+ description="""
840
+ Number of empty states to compute both the screened Coulomb potential and the self-energy.
841
+ """,
842
+ )
843
+
844
+ x_exciting_ngridq = Quantity(
845
+ type=np.int32,
846
+ shape=[3],
847
+ description="""
848
+ Size of the k/q-point grids.
849
+ """,
850
+ )
851
+
852
+ x_exciting_printSelfC = Quantity(
853
+ type=bool,
854
+ shape=[],
855
+ description="""
856
+ Output the correlation self-energy.
857
+ """,
858
+ )
859
+
860
+ x_exciting_printSpectralFunction = Quantity(
861
+ type=bool,
862
+ shape=[],
863
+ description="""
864
+ Compute and output the spectral function.
865
+ """,
866
+ )
867
+
868
+ x_exciting_nempty = Quantity(
869
+ type=np.int32,
870
+ shape=[],
871
+ description="""
872
+ Method to compute k/q and frequency dependent weights in the expression for
873
+ polarizability:
874
+ tet - Using the tetrahedron method as implemented in LibBZInt library
875
+ sum - Direct summation employing a smearing parameter eta of freqgrid
876
+ """,
877
+ )
878
+
879
+ x_exciting_rpmat = Quantity(
880
+ type=bool,
881
+ shape=[],
882
+ description="""
883
+ Skip calculation of the momentum matrix elements, instead read them from files
884
+ PMATVV.OUT and PMATCV.OUT (restart option).
885
+ """,
886
+ )
887
+
888
+ x_exciting_skipgnd = Quantity(
889
+ type=bool,
890
+ shape=[],
891
+ description="""
892
+ Skip the recalculation of KS eigenvalues and eigenvectors for the specified
893
+ k/q-point grids (restart option).
894
+ """,
895
+ )
896
+
897
+ x_exciting_taskname = Quantity(
898
+ type=str,
899
+ shape=[],
900
+ description="""
901
+ Tasks launcher:
902
+ g0w0 - G0W0 calculations
903
+ g0w0-x - Exchange only G0W0 calculations
904
+ cohsex - Coulomb-hole and screened-exchange (COHSEX) approximation
905
+ band - QP banstructure as obtained by Fourier interpolation
906
+ dos - QP density of states
907
+ emac - Calculate the macroscopic dielectric function
908
+ vxc - Calculate the diagonal matrix elements of the exchange-correlation potential
909
+ pmat - Calculate matrix elements of the momentum operator
910
+ acon - Perform analytic continuation of the correlation self-energy from
911
+ imaginary to real frequency and calculate QP energies
912
+ """,
913
+ )
914
+
915
+ x_exciting_vqloff = Quantity(
916
+ type=np.float64,
917
+ shape=[3],
918
+ description="""
919
+ The k/q-point offset vector in lattice coordinates.
920
+ """,
921
+ )
922
+
923
+ x_exciting_freqgrid = SubSection(
924
+ sub_section=x_exciting_freqgrid_parameters.m_def, repeats=False
925
+ )
926
+
927
+ x_exciting_selfenergy = SubSection(
928
+ sub_section=x_exciting_selfenergy_parameters.m_def, repeats=False
929
+ )
930
+
931
+ x_exciting_wgrid = SubSection(
932
+ sub_section=x_exciting_wgrid_parameters.m_def, repeats=False
933
+ )
934
+
935
+ x_exciting_mixbasis = SubSection(
936
+ sub_section=x_exciting_mixbasis_parameters.m_def, repeats=False
937
+ )
938
+
939
+ x_exciting_barecoul = SubSection(
940
+ sub_section=x_exciting_barecoul_parameters.m_def, repeats=False
941
+ )
942
+
943
+ x_exciting_scrcoul = SubSection(
944
+ sub_section=x_exciting_scrcoul_parameters.m_def, repeats=False
945
+ )
946
+
947
+ x_exciting_bare_coulomb_gmax = Quantity(
948
+ type=np.float64,
949
+ shape=[],
950
+ unit='1 / meter',
951
+ description="""
952
+ Maximum G for the pw basis for the Coulomb potential.
953
+ """,
954
+ )
955
+
956
+ x_exciting_mixed_basis_gmax = Quantity(
957
+ type=np.float64,
958
+ shape=[],
959
+ unit='1 / meter',
960
+ description="""
961
+ Cut-off parameter for the truncation of the expansion of the plane waves in the
962
+ interstitial region.
963
+ """,
964
+ )
965
+
966
+
967
+ class x_exciting_exciton_calculation(MSection):
968
+ """
969
+ Calculation of EXCITON
970
+ """
971
+
972
+ m_def = Section(validate=False)
973
+
974
+ x_exciting_xs_bse_number_of_excitons = Quantity(
975
+ type=np.int32,
976
+ shape=[],
977
+ description="""
978
+ Total number of excitons
979
+ """,
980
+ )
981
+
982
+ x_exciting_xs_bse_exciton_amplitude_im = Quantity(
983
+ type=np.float64,
984
+ shape=[
985
+ 'x_exciting_xs_bse_number_of_components',
986
+ 'x_exciting_xs_bse_number_of_excitons',
987
+ ],
988
+ description="""
989
+ Imaginary part of the transition amplitude
990
+ """,
991
+ )
992
+
993
+ x_exciting_xs_bse_exciton_amplitude_re = Quantity(
994
+ type=np.float64,
995
+ shape=[
996
+ 'x_exciting_xs_bse_number_of_components',
997
+ 'x_exciting_xs_bse_number_of_excitons',
998
+ ],
999
+ description="""
1000
+ Real part of the transition amplitude
1001
+ """,
1002
+ )
1003
+
1004
+ x_exciting_xs_bse_exciton_binding_energies = Quantity(
1005
+ type=np.float64,
1006
+ shape=[
1007
+ 'x_exciting_xs_bse_number_of_components',
1008
+ 'x_exciting_xs_bse_number_of_excitons',
1009
+ ],
1010
+ unit='joule',
1011
+ description="""
1012
+ Exciton binding energies
1013
+ """,
1014
+ )
1015
+
1016
+ x_exciting_xs_bse_exciton_energies = Quantity(
1017
+ type=np.float64,
1018
+ shape=[
1019
+ 'x_exciting_xs_bse_number_of_components',
1020
+ 'x_exciting_xs_bse_number_of_excitons',
1021
+ ],
1022
+ unit='joule',
1023
+ description="""
1024
+ Exciton energies
1025
+ """,
1026
+ )
1027
+
1028
+ x_exciting_xs_bse_exciton_oscillator_strength = Quantity(
1029
+ type=np.float64,
1030
+ shape=[
1031
+ 'x_exciting_xs_bse_number_of_components',
1032
+ 'x_exciting_xs_bse_number_of_excitons',
1033
+ ],
1034
+ description="""
1035
+ Exciton oscillator strength
1036
+ """,
1037
+ )
1038
+
1039
+
1040
+ class x_exciting_epsilon_calculation(MSection):
1041
+ """
1042
+ Calculation of EPSILON
1043
+ """
1044
+
1045
+ m_def = Section(validate=False)
1046
+
1047
+ x_exciting_xs_bse_epsilon_energies = Quantity(
1048
+ type=np.float64,
1049
+ shape=[
1050
+ 'x_exciting_xs_bse_number_of_components',
1051
+ 'x_exciting_xs_bse_number_of_energy_points',
1052
+ ],
1053
+ unit='joule',
1054
+ description="""
1055
+ Energies of the dielectric function epsilon
1056
+ """,
1057
+ )
1058
+
1059
+ x_exciting_xs_bse_epsilon_im = Quantity(
1060
+ type=np.float64,
1061
+ shape=[
1062
+ 'x_exciting_xs_bse_number_of_components',
1063
+ 'x_exciting_xs_bse_number_of_energy_points',
1064
+ ],
1065
+ description="""
1066
+ Imaginary part of the dielectric function epsilon
1067
+ """,
1068
+ )
1069
+
1070
+ x_exciting_xs_bse_epsilon_re = Quantity(
1071
+ type=np.float64,
1072
+ shape=[
1073
+ 'x_exciting_xs_bse_number_of_components',
1074
+ 'x_exciting_xs_bse_number_of_energy_points',
1075
+ ],
1076
+ description="""
1077
+ Real part of the dielectric function epsilon
1078
+ """,
1079
+ )
1080
+
1081
+
1082
+ class x_exciting_sigma_calculation(MSection):
1083
+ """
1084
+ Calculation of SIGMA
1085
+ """
1086
+
1087
+ m_def = Section(validate=False)
1088
+
1089
+ x_exciting_xs_bse_sigma_energies = Quantity(
1090
+ type=np.float64,
1091
+ shape=[
1092
+ 'x_exciting_xs_bse_number_of_components',
1093
+ 'x_exciting_xs_bse_number_of_energy_points',
1094
+ ],
1095
+ unit='joule',
1096
+ description="""
1097
+ Energies of the conductivity function sigma
1098
+ """,
1099
+ )
1100
+
1101
+ x_exciting_xs_bse_sigma_im = Quantity(
1102
+ type=np.float64,
1103
+ shape=[
1104
+ 'x_exciting_xs_bse_number_of_components',
1105
+ 'x_exciting_xs_bse_number_of_energy_points',
1106
+ ],
1107
+ description="""
1108
+ Imaginary part of the conductivity function sigma
1109
+ """,
1110
+ )
1111
+
1112
+ x_exciting_xs_bse_sigma_re = Quantity(
1113
+ type=np.float64,
1114
+ shape=[
1115
+ 'x_exciting_xs_bse_number_of_components',
1116
+ 'x_exciting_xs_bse_number_of_energy_points',
1117
+ ],
1118
+ description="""
1119
+ Real part of the conductivity function sigma
1120
+ """,
1121
+ )
1122
+
1123
+
1124
+ class x_exciting_loss_calculation(MSection):
1125
+ """
1126
+ Calculation of LOSS
1127
+ """
1128
+
1129
+ m_def = Section(validate=False)
1130
+
1131
+ x_exciting_xs_bse_loss = Quantity(
1132
+ type=np.float64,
1133
+ shape=[
1134
+ 'x_exciting_xs_bse_number_of_components',
1135
+ 'x_exciting_xs_bse_number_of_energy_points',
1136
+ ],
1137
+ description="""
1138
+ Loss function
1139
+ """,
1140
+ )
1141
+
1142
+ x_exciting_xs_bse_loss_energies = Quantity(
1143
+ type=np.float64,
1144
+ shape=[
1145
+ 'x_exciting_xs_bse_number_of_components',
1146
+ 'x_exciting_xs_bse_number_of_energy_points',
1147
+ ],
1148
+ unit='joule',
1149
+ description="""
1150
+ Energies of the loss function
1151
+ """,
1152
+ )
1153
+
1154
+
1155
+ class Calculation(runschema.calculation.Calculation):
1156
+ m_def = Section(validate=False, extends_base_section=True)
1157
+
1158
+ x_exciting_atom_forces = Quantity(
1159
+ type=np.float64,
1160
+ shape=['x_exciting_number_of_atoms', 3],
1161
+ unit='newton',
1162
+ description="""
1163
+ Forces acting on the atoms.
1164
+ """,
1165
+ )
1166
+
1167
+ x_exciting_atom_IBS_forces = Quantity(
1168
+ type=np.float64,
1169
+ shape=['x_exciting_number_of_atoms', 3],
1170
+ unit='newton',
1171
+ description="""
1172
+ IBS correction to the Force acting on the atoms.
1173
+ """,
1174
+ )
1175
+
1176
+ x_exciting_geometry_optimization_method = Quantity(
1177
+ type=str,
1178
+ shape=[],
1179
+ description="""
1180
+ Geometry optimization method
1181
+ """,
1182
+ )
1183
+
1184
+ x_exciting_geometry_optimization_step = Quantity(
1185
+ type=np.int32,
1186
+ shape=[],
1187
+ description="""
1188
+ Geometry optimization step
1189
+ """,
1190
+ )
1191
+
1192
+ x_exciting_atom_core_forces = Quantity(
1193
+ type=np.float64,
1194
+ shape=['x_exciting_number_of_atoms', 3],
1195
+ unit='newton',
1196
+ description="""
1197
+ core correction to the Force acting on the atoms.
1198
+ """,
1199
+ )
1200
+
1201
+ x_exciting_atom_HF_forces = Quantity(
1202
+ type=np.float64,
1203
+ shape=['x_exciting_number_of_atoms', 3],
1204
+ unit='newton',
1205
+ description="""
1206
+ HF correction to the Force acting on the atoms.
1207
+ """,
1208
+ )
1209
+
1210
+ x_exciting_atom_IBS_forces_x = Quantity(
1211
+ type=np.float64,
1212
+ shape=[],
1213
+ description="""
1214
+ x-component of the IBS correction to the Force acting on the atoms.
1215
+ """,
1216
+ )
1217
+
1218
+ x_exciting_atom_IBS_forces_y = Quantity(
1219
+ type=np.float64,
1220
+ shape=[],
1221
+ description="""
1222
+ y-component of the IBS correction to the Force acting on the atoms.
1223
+ """,
1224
+ )
1225
+
1226
+ x_exciting_atom_IBS_forces_z = Quantity(
1227
+ type=np.float64,
1228
+ shape=[],
1229
+ description="""
1230
+ z-component of the IBS correction to the Force acting on the atoms.
1231
+ """,
1232
+ )
1233
+
1234
+ x_exciting_atom_core_forces_x = Quantity(
1235
+ type=np.float64,
1236
+ shape=[],
1237
+ description="""
1238
+ x-component of the core correction to the Force acting on the atoms.
1239
+ """,
1240
+ )
1241
+
1242
+ x_exciting_atom_core_forces_y = Quantity(
1243
+ type=np.float64,
1244
+ shape=[],
1245
+ description="""
1246
+ y-component of the core correction to the Force acting on the atoms.
1247
+ """,
1248
+ )
1249
+
1250
+ x_exciting_atom_core_forces_z = Quantity(
1251
+ type=np.float64,
1252
+ shape=[],
1253
+ description="""
1254
+ z-component of the core correction to the Force acting on the atoms.
1255
+ """,
1256
+ )
1257
+
1258
+ x_exciting_atom_HF_forces_x = Quantity(
1259
+ type=np.float64,
1260
+ shape=[],
1261
+ description="""
1262
+ x-component of the HF Force acting on the atoms.
1263
+ """,
1264
+ )
1265
+
1266
+ x_exciting_atom_HF_forces_y = Quantity(
1267
+ type=np.float64,
1268
+ shape=[],
1269
+ description="""
1270
+ y-component of the HF Force acting on the atoms.
1271
+ """,
1272
+ )
1273
+
1274
+ x_exciting_atom_HF_forces_z = Quantity(
1275
+ type=np.float64,
1276
+ shape=[],
1277
+ description="""
1278
+ z-component of the HF Force acting on the atoms.
1279
+ """,
1280
+ )
1281
+
1282
+ x_exciting_atom_forces_x = Quantity(
1283
+ type=np.float64,
1284
+ shape=[],
1285
+ description="""
1286
+ x-component of the Force acting on the atoms.
1287
+ """,
1288
+ )
1289
+
1290
+ x_exciting_atom_forces_y = Quantity(
1291
+ type=np.float64,
1292
+ shape=[],
1293
+ description="""
1294
+ y-component of the Force acting on the atoms.
1295
+ """,
1296
+ )
1297
+
1298
+ x_exciting_atom_forces_z = Quantity(
1299
+ type=np.float64,
1300
+ shape=[],
1301
+ description="""
1302
+ z-component of the Force acting on the atoms.
1303
+ """,
1304
+ )
1305
+
1306
+ x_exciting_core_electron_kinetic_energy = Quantity(
1307
+ type=np.float64,
1308
+ shape=[],
1309
+ unit='joule',
1310
+ description="""
1311
+ Core-electron kinetic energy final
1312
+ """,
1313
+ )
1314
+
1315
+ x_exciting_core_leakage = Quantity(
1316
+ type=np.float64,
1317
+ shape=[],
1318
+ unit='coulomb',
1319
+ description="""
1320
+ Core leakage
1321
+ """,
1322
+ )
1323
+
1324
+ x_exciting_correlation_energy = Quantity(
1325
+ type=np.float64,
1326
+ shape=[],
1327
+ unit='joule',
1328
+ description="""
1329
+ Correlation energy final
1330
+ """,
1331
+ )
1332
+
1333
+ x_exciting_coulomb_energy = Quantity(
1334
+ type=np.float64,
1335
+ shape=[],
1336
+ unit='joule',
1337
+ description="""
1338
+ Coulomb energy final
1339
+ """,
1340
+ )
1341
+
1342
+ x_exciting_coulomb_potential_energy = Quantity(
1343
+ type=np.float64,
1344
+ shape=[],
1345
+ unit='joule',
1346
+ description="""
1347
+ Coulomb potential energy final
1348
+ """,
1349
+ )
1350
+
1351
+ x_exciting_dos_fermi = Quantity(
1352
+ type=np.float64,
1353
+ shape=[],
1354
+ unit='1 / joule',
1355
+ description="""
1356
+ DOS at Fermi energy
1357
+ """,
1358
+ )
1359
+
1360
+ x_exciting_effective_potential_energy = Quantity(
1361
+ type=np.float64,
1362
+ shape=[],
1363
+ unit='joule',
1364
+ description="""
1365
+ Effective potential energy final
1366
+ """,
1367
+ )
1368
+
1369
+ x_exciting_electron_nuclear_energy = Quantity(
1370
+ type=np.float64,
1371
+ shape=[],
1372
+ unit='joule',
1373
+ description="""
1374
+ Electron-nuclear energy final
1375
+ """,
1376
+ )
1377
+
1378
+ x_exciting_exchange_energy = Quantity(
1379
+ type=np.float64,
1380
+ shape=[],
1381
+ unit='joule',
1382
+ description="""
1383
+ Exchange energy final
1384
+ """,
1385
+ )
1386
+
1387
+ x_exciting_fermi_energy = Quantity(
1388
+ type=np.float64,
1389
+ shape=[],
1390
+ unit='joule',
1391
+ description="""
1392
+ Fermi energy final
1393
+ """,
1394
+ )
1395
+
1396
+ x_exciting_gap = Quantity(
1397
+ type=np.float64,
1398
+ shape=[],
1399
+ unit='joule',
1400
+ description="""
1401
+ Estimated fundamental gap
1402
+ """,
1403
+ )
1404
+
1405
+ x_exciting_geometry_atom_forces_x = Quantity(
1406
+ type=np.float64,
1407
+ shape=[],
1408
+ unit='newton',
1409
+ description="""
1410
+ x component of the force acting on the atom
1411
+ """,
1412
+ )
1413
+
1414
+ x_exciting_geometry_atom_forces_y = Quantity(
1415
+ type=np.float64,
1416
+ shape=[],
1417
+ unit='newton',
1418
+ description="""
1419
+ y component of the force acting on the atom
1420
+ """,
1421
+ )
1422
+
1423
+ x_exciting_geometry_atom_forces_z = Quantity(
1424
+ type=np.float64,
1425
+ shape=[],
1426
+ unit='newton',
1427
+ description="""
1428
+ z component of the force acting on the atom
1429
+ """,
1430
+ )
1431
+
1432
+ x_exciting_geometry_dummy = Quantity(
1433
+ type=np.float64,
1434
+ shape=[],
1435
+ description="""
1436
+ time for scf in geometry optimization
1437
+ """,
1438
+ )
1439
+
1440
+ x_exciting_maximum_force_magnitude = Quantity(
1441
+ type=np.float64,
1442
+ shape=[],
1443
+ unit='newton',
1444
+ description="""
1445
+ Maximum force magnitude in geometry optimization
1446
+ """,
1447
+ )
1448
+
1449
+ x_exciting_geometry_optimization_threshold_force = Quantity(
1450
+ type=np.float64,
1451
+ shape=[],
1452
+ unit='newton',
1453
+ description="""
1454
+ Value of threshold for the force modulus as convergence criterion of the
1455
+ geometry_optimization_method used in exciting
1456
+ """,
1457
+ )
1458
+
1459
+ x_exciting_hartree_energy = Quantity(
1460
+ type=np.float64,
1461
+ shape=[],
1462
+ unit='joule',
1463
+ description="""
1464
+ Hartree energy final
1465
+ """,
1466
+ )
1467
+
1468
+ x_exciting_interstitial_charge = Quantity(
1469
+ type=np.float64,
1470
+ shape=[],
1471
+ unit='coulomb',
1472
+ description="""
1473
+ Interstitial charge
1474
+ """,
1475
+ )
1476
+
1477
+ x_exciting_madelung_energy = Quantity(
1478
+ type=np.float64,
1479
+ shape=[],
1480
+ unit='joule',
1481
+ description="""
1482
+ Madelung energy final
1483
+ """,
1484
+ )
1485
+
1486
+ x_exciting_nuclear_nuclear_energy = Quantity(
1487
+ type=np.float64,
1488
+ shape=[],
1489
+ unit='joule',
1490
+ description="""
1491
+ Nuclear-nuclear energy final
1492
+ """,
1493
+ )
1494
+
1495
+ x_exciting_store_total_forces = Quantity(
1496
+ type=str,
1497
+ shape=[],
1498
+ description="""
1499
+ Temporary storing converged atom forces cartesian
1500
+ """,
1501
+ )
1502
+
1503
+ x_exciting_total_MT_charge = Quantity(
1504
+ type=np.float64,
1505
+ shape=[],
1506
+ unit='coulomb',
1507
+ description="""
1508
+ Total charge in muffin-tins
1509
+ """,
1510
+ )
1511
+
1512
+ x_exciting_XC_potential = Quantity(
1513
+ type=np.float64,
1514
+ shape=[],
1515
+ unit='joule',
1516
+ description="""
1517
+ XC potential final
1518
+ """,
1519
+ )
1520
+
1521
+ x_exciting_xs_bse_number_of_components = Quantity(
1522
+ type=np.int32,
1523
+ shape=[],
1524
+ description="""
1525
+ Number of independent components in the dielectric tensor
1526
+ """,
1527
+ )
1528
+
1529
+ x_exciting_xs_bse_number_of_energy_points = Quantity(
1530
+ type=np.int32,
1531
+ shape=[],
1532
+ description="""
1533
+ Energy mesh for the dielectric function, conductivity and loss function
1534
+ """,
1535
+ )
1536
+
1537
+ x_exciting_xs_tddft_dielectric_function_local_field = Quantity(
1538
+ type=np.float64,
1539
+ shape=[
1540
+ 2,
1541
+ 'x_exciting_xs_tddft_number_of_q_points',
1542
+ 'x_exciting_xs_tddft_number_of_components',
1543
+ 'x_exciting_xs_tddft_number_of_epsilon_values',
1544
+ ],
1545
+ description="""
1546
+ Dielectric function epsilon including local-field effects
1547
+ """,
1548
+ )
1549
+
1550
+ x_exciting_xs_tddft_dielectric_function_no_local_field = Quantity(
1551
+ type=np.float64,
1552
+ shape=[
1553
+ 2,
1554
+ 'x_exciting_xs_tddft_number_of_q_points',
1555
+ 'x_exciting_xs_tddft_number_of_components',
1556
+ 'x_exciting_xs_tddft_number_of_epsilon_values',
1557
+ ],
1558
+ description="""
1559
+ Dielectric function epsilon without local-field effects
1560
+ """,
1561
+ )
1562
+
1563
+ x_exciting_xs_tddft_dielectric_tensor_no_sym = Quantity(
1564
+ type=np.float64,
1565
+ shape=['x_exciting_xs_tddft_number_of_q_points', 2, 3, 3],
1566
+ description="""
1567
+ No-symmetrized static dielectric tensor
1568
+ """,
1569
+ )
1570
+
1571
+ x_exciting_xs_tddft_dielectric_tensor_sym = Quantity(
1572
+ type=np.float64,
1573
+ shape=['x_exciting_xs_tddft_number_of_q_points', 2, 3, 3],
1574
+ description="""
1575
+ Symmetrized static dielectric tensor
1576
+ """,
1577
+ )
1578
+
1579
+ x_exciting_xs_tddft_epsilon_energies = Quantity(
1580
+ type=np.float64,
1581
+ shape=['x_exciting_xs_tddft_number_of_epsilon_values'],
1582
+ unit='joule',
1583
+ description="""
1584
+ Array containing the set of discrete energy values for the dielectric function
1585
+ epsilon.
1586
+ """,
1587
+ )
1588
+
1589
+ x_exciting_xs_tddft_loss_function_local_field = Quantity(
1590
+ type=np.float64,
1591
+ shape=[
1592
+ 'x_exciting_xs_tddft_number_of_q_points',
1593
+ 'x_exciting_xs_tddft_number_of_components',
1594
+ 'x_exciting_xs_tddft_number_of_epsilon_values',
1595
+ ],
1596
+ description="""
1597
+ Loss function including local-field effects
1598
+ """,
1599
+ )
1600
+
1601
+ x_exciting_xs_tddft_loss_function_no_local_field = Quantity(
1602
+ type=np.float64,
1603
+ shape=[
1604
+ 'x_exciting_xs_tddft_number_of_q_points',
1605
+ 'x_exciting_xs_tddft_number_of_components',
1606
+ 'x_exciting_xs_tddft_number_of_epsilon_values',
1607
+ ],
1608
+ description="""
1609
+ Loss function without local-field effects
1610
+ """,
1611
+ )
1612
+
1613
+ x_exciting_xs_tddft_number_of_epsilon_values = Quantity(
1614
+ type=int,
1615
+ shape=[],
1616
+ description="""
1617
+ Gives the number of energy values for the dielectric function epsilon.
1618
+ """,
1619
+ )
1620
+
1621
+ x_exciting_xs_tddft_number_of_optical_components = Quantity(
1622
+ type=np.int32,
1623
+ shape=[],
1624
+ description="""
1625
+ Number of independent components in the dielectric function epsilon
1626
+ """,
1627
+ )
1628
+
1629
+ x_exciting_xs_tddft_number_of_q_points = Quantity(
1630
+ type=np.int32,
1631
+ shape=[],
1632
+ description="""
1633
+ Number of Q points
1634
+ """,
1635
+ )
1636
+
1637
+ x_exciting_xs_tddft_optical_component = Quantity(
1638
+ type=str,
1639
+ shape=['x_exciting_xs_tddft_number_of_optical_components'],
1640
+ description="""
1641
+ Value of the independent optical components in the dielectric function epsilon
1642
+ """,
1643
+ )
1644
+
1645
+ x_exciting_xs_tddft_sigma_local_field = Quantity(
1646
+ type=np.float64,
1647
+ shape=[
1648
+ 2,
1649
+ 'x_exciting_xs_tddft_number_of_q_points',
1650
+ 'x_exciting_xs_tddft_number_of_components',
1651
+ 'x_exciting_xs_tddft_number_of_epsilon_values',
1652
+ ],
1653
+ description="""
1654
+ Sigma including local-field effects
1655
+ """,
1656
+ )
1657
+
1658
+ x_exciting_xs_tddft_sigma_no_local_field = Quantity(
1659
+ type=np.float64,
1660
+ shape=[
1661
+ 2,
1662
+ 'x_exciting_xs_tddft_number_of_q_points',
1663
+ 'x_exciting_xs_tddft_number_of_components',
1664
+ 'x_exciting_xs_tddft_number_of_epsilon_values',
1665
+ ],
1666
+ description="""
1667
+ Sigma without local-field effects
1668
+ """,
1669
+ )
1670
+
1671
+ x_exciting_xs_qpointset_qpoint = Quantity(
1672
+ type=np.float64,
1673
+ shape=[3],
1674
+ description="""
1675
+ A q-point is given in reciprocal space coordinates
1676
+ """,
1677
+ )
1678
+
1679
+ x_exciting_section_bandstructure = SubSection(
1680
+ sub_section=SectionProxy('x_exciting_section_bandstructure'), repeats=True
1681
+ )
1682
+
1683
+ x_exciting_section_dos = SubSection(
1684
+ sub_section=SectionProxy('x_exciting_section_dos'), repeats=True
1685
+ )
1686
+
1687
+ x_exciting_section_fermi_surface = SubSection(
1688
+ sub_section=SectionProxy('x_exciting_section_fermi_surface'), repeats=True
1689
+ )
1690
+
1691
+ x_exciting_section_MT_charge_atom = SubSection(
1692
+ sub_section=SectionProxy('x_exciting_section_MT_charge_atom'), repeats=True
1693
+ )
1694
+
1695
+ x_exciting_section_MT_moment_atom = SubSection(
1696
+ sub_section=SectionProxy('x_exciting_section_MT_moment_atom'), repeats=True
1697
+ )
1698
+
1699
+ x_exciting_exciton = SubSection(
1700
+ sub_section=x_exciting_exciton_calculation.m_def, repeats=False
1701
+ )
1702
+
1703
+ x_exciting_epsilon = SubSection(
1704
+ sub_section=x_exciting_epsilon_calculation.m_def, repeats=False
1705
+ )
1706
+
1707
+ x_exciting_sigma = SubSection(
1708
+ sub_section=x_exciting_sigma_calculation.m_def, repeats=False
1709
+ )
1710
+
1711
+ x_exciting_loss = SubSection(
1712
+ sub_section=x_exciting_loss_calculation.m_def, repeats=False
1713
+ )
1714
+
1715
+
1716
+ class System(runschema.system.System):
1717
+ m_def = Section(validate=False, extends_base_section=True)
1718
+
1719
+ x_exciting_brillouin_zone_volume = Quantity(
1720
+ type=np.float64,
1721
+ shape=[],
1722
+ unit='1 / meter ** 3',
1723
+ description="""
1724
+ Brillouin zone volume
1725
+ """,
1726
+ )
1727
+
1728
+ x_exciting_core_charge = Quantity(
1729
+ type=np.float64,
1730
+ shape=[],
1731
+ description="""
1732
+ Core charge
1733
+ """,
1734
+ )
1735
+
1736
+ x_exciting_core_charge_initial = Quantity(
1737
+ type=np.float64,
1738
+ shape=[],
1739
+ unit='coulomb',
1740
+ description="""
1741
+ Core charge
1742
+ """,
1743
+ )
1744
+
1745
+ x_exciting_electronic_charge = Quantity(
1746
+ type=np.float64,
1747
+ shape=[],
1748
+ unit='coulomb',
1749
+ description="""
1750
+ Electronic charge
1751
+ """,
1752
+ )
1753
+
1754
+ x_exciting_empty_states = Quantity(
1755
+ type=np.int32,
1756
+ shape=[],
1757
+ description="""
1758
+ Number of empty states
1759
+ """,
1760
+ )
1761
+
1762
+ x_exciting_clathrates_atom_labels = Quantity(
1763
+ type=str,
1764
+ shape=['number_of_atoms'],
1765
+ description="""
1766
+ Labels of the atoms in the clathrates.
1767
+ """,
1768
+ )
1769
+
1770
+ x_exciting_clathrates_atom_coordinates = Quantity(
1771
+ type=np.float64,
1772
+ shape=['number_of_atoms', 3],
1773
+ description="""
1774
+ Ordered list of the atoms coordinates in the clathrates.
1775
+ """,
1776
+ )
1777
+
1778
+ x_exciting_clathrates = Quantity(
1779
+ type=bool,
1780
+ shape=[],
1781
+ description="""
1782
+ It indicates whether the system is a clathrate.
1783
+ """,
1784
+ )
1785
+
1786
+ x_exciting_gkmax = Quantity(
1787
+ type=np.float64,
1788
+ shape=[],
1789
+ unit='1 / meter',
1790
+ description="""
1791
+ Maximum length of |G+k| for APW functions
1792
+ """,
1793
+ )
1794
+
1795
+ x_exciting_gmaxvr = Quantity(
1796
+ type=np.float64,
1797
+ shape=[],
1798
+ unit='1 / meter',
1799
+ description="""
1800
+ Maximum length of |G|
1801
+ """,
1802
+ )
1803
+
1804
+ x_exciting_gvector_size_x = Quantity(
1805
+ type=np.int32,
1806
+ shape=[],
1807
+ description="""
1808
+ G-vector grid size x
1809
+ """,
1810
+ )
1811
+
1812
+ x_exciting_gvector_size_y = Quantity(
1813
+ type=np.int32,
1814
+ shape=[],
1815
+ description="""
1816
+ G-vector grid size y
1817
+ """,
1818
+ )
1819
+
1820
+ x_exciting_gvector_size_z = Quantity(
1821
+ type=np.int32,
1822
+ shape=[],
1823
+ description="""
1824
+ G-vector grid size z
1825
+ """,
1826
+ )
1827
+
1828
+ x_exciting_gvector_size = Quantity(
1829
+ type=np.int32,
1830
+ shape=[3],
1831
+ description="""
1832
+ G-vector grid size
1833
+ """,
1834
+ )
1835
+
1836
+ x_exciting_gvector_total = Quantity(
1837
+ type=np.int32,
1838
+ shape=[],
1839
+ description="""
1840
+ G-vector total
1841
+ """,
1842
+ )
1843
+
1844
+ x_exciting_hamiltonian_size = Quantity(
1845
+ type=np.int32,
1846
+ shape=[],
1847
+ description="""
1848
+ Maximum Hamiltonian size
1849
+ """,
1850
+ )
1851
+
1852
+ x_exciting_kpoint_offset_y = Quantity(
1853
+ type=np.float64,
1854
+ shape=[],
1855
+ description="""
1856
+ K-points offset y component
1857
+ """,
1858
+ )
1859
+
1860
+ x_exciting_kpoint_offset_z = Quantity(
1861
+ type=np.float64,
1862
+ shape=[],
1863
+ description="""
1864
+ K-points offset z component
1865
+ """,
1866
+ )
1867
+
1868
+ x_exciting_kpoint_offset = Quantity(
1869
+ type=np.float64,
1870
+ shape=[3],
1871
+ description="""
1872
+ K-points offset
1873
+ """,
1874
+ )
1875
+
1876
+ x_exciting_lmaxapw = Quantity(
1877
+ type=np.int32,
1878
+ shape=[],
1879
+ description="""
1880
+ Angular momentum cut-off for the APW functions
1881
+ """,
1882
+ )
1883
+
1884
+ x_exciting_lo = Quantity(
1885
+ type=np.int32,
1886
+ shape=[],
1887
+ description="""
1888
+ Total number of local-orbitals
1889
+ """,
1890
+ )
1891
+
1892
+ x_exciting_nuclear_charge = Quantity(
1893
+ type=np.float64,
1894
+ shape=[],
1895
+ unit='coulomb',
1896
+ description="""
1897
+ Nuclear charge
1898
+ """,
1899
+ )
1900
+
1901
+ x_exciting_number_kpoint_x = Quantity(
1902
+ type=np.int32,
1903
+ shape=[],
1904
+ description="""
1905
+ number k-points x
1906
+ """,
1907
+ )
1908
+
1909
+ x_exciting_number_kpoint_y = Quantity(
1910
+ type=np.int32,
1911
+ shape=[],
1912
+ description="""
1913
+ number k-points y
1914
+ """,
1915
+ )
1916
+
1917
+ x_exciting_number_kpoint_z = Quantity(
1918
+ type=np.int32,
1919
+ shape=[],
1920
+ description="""
1921
+ number k-points z
1922
+ """,
1923
+ )
1924
+
1925
+ x_exciting_number_kpoints = Quantity(
1926
+ type=np.int32,
1927
+ shape=[],
1928
+ description="""
1929
+ number k-points
1930
+ """,
1931
+ )
1932
+
1933
+ x_exciting_number_of_atoms = Quantity(
1934
+ type=np.int32,
1935
+ shape=[],
1936
+ description="""
1937
+ The number of atoms in the unit cell
1938
+ """,
1939
+ )
1940
+
1941
+ x_exciting_potential_mixing = Quantity(
1942
+ type=str,
1943
+ shape=[],
1944
+ description="""
1945
+ Mixing type for potential
1946
+ """,
1947
+ )
1948
+
1949
+ x_exciting_pw = Quantity(
1950
+ type=np.int32,
1951
+ shape=[],
1952
+ description="""
1953
+ Maximum number of plane-waves
1954
+ """,
1955
+ )
1956
+
1957
+ x_exciting_rgkmax = Quantity(
1958
+ type=np.float64,
1959
+ shape=[],
1960
+ unit='meter',
1961
+ description="""
1962
+ Radius MT * Gmax
1963
+ """,
1964
+ )
1965
+
1966
+ x_exciting_species_rtmin = Quantity(
1967
+ type=str,
1968
+ shape=[],
1969
+ description="""
1970
+ Chemical species with radius RT * Gmax
1971
+ """,
1972
+ )
1973
+
1974
+ x_exciting_simulation_reciprocal_cell = Quantity(
1975
+ type=np.float64,
1976
+ shape=[3, 3],
1977
+ unit='meter',
1978
+ description="""
1979
+ Reciprocal lattice vectors (in Cartesian coordinates) of the simulation cell. The
1980
+ first index runs over the $x,y,z$ Cartesian coordinates, and the second index runs
1981
+ over the 3 lattice vectors.
1982
+ """,
1983
+ )
1984
+
1985
+ x_exciting_smearing_type = Quantity(
1986
+ type=str,
1987
+ shape=[],
1988
+ description="""
1989
+ Smearing scheme for KS occupancies
1990
+ """,
1991
+ )
1992
+
1993
+ x_exciting_smearing_width = Quantity(
1994
+ type=np.float64,
1995
+ shape=[],
1996
+ description="""
1997
+ Smearing width for KS occupancies
1998
+ """,
1999
+ )
2000
+
2001
+ x_exciting_unit_cell_volume = Quantity(
2002
+ type=np.float64,
2003
+ shape=[],
2004
+ unit='meter ** 3',
2005
+ description="""
2006
+ unit cell volume
2007
+ """,
2008
+ )
2009
+
2010
+ x_exciting_valence_charge = Quantity(
2011
+ type=np.float64,
2012
+ shape=[],
2013
+ description="""
2014
+ Valence charge
2015
+ """,
2016
+ )
2017
+
2018
+ x_exciting_valence_charge_initial = Quantity(
2019
+ type=np.float64,
2020
+ shape=[],
2021
+ unit='coulomb',
2022
+ description="""
2023
+ Valence charge
2024
+ """,
2025
+ )
2026
+
2027
+ x_exciting_valence_states = Quantity(
2028
+ type=np.int32,
2029
+ shape=[],
2030
+ description="""
2031
+ Total number of valence states
2032
+ """,
2033
+ )
2034
+
2035
+ x_exciting_wigner_radius = Quantity(
2036
+ type=np.float64,
2037
+ shape=[],
2038
+ unit='meter',
2039
+ description="""
2040
+ Effective Wigner radius
2041
+ """,
2042
+ )
2043
+
2044
+ x_exciting_number_of_bravais_lattice_symmetries = Quantity(
2045
+ type=int,
2046
+ shape=[],
2047
+ description="""
2048
+ Number of Bravais lattice symmetries
2049
+ """,
2050
+ )
2051
+
2052
+ x_exciting_number_of_crystal_symmetries = Quantity(
2053
+ type=int,
2054
+ shape=[],
2055
+ description="""
2056
+ Number of crystal symmetries
2057
+ """,
2058
+ )
2059
+
2060
+ x_exciting_section_atoms_group = SubSection(
2061
+ sub_section=SectionProxy('x_exciting_section_atoms_group'), repeats=True
2062
+ )
2063
+
2064
+ x_exciting_section_lattice_vectors = SubSection(
2065
+ sub_section=SectionProxy('x_exciting_section_lattice_vectors'), repeats=True
2066
+ )
2067
+
2068
+ x_exciting_section_reciprocal_lattice_vectors = SubSection(
2069
+ sub_section=SectionProxy('x_exciting_section_reciprocal_lattice_vectors'),
2070
+ repeats=True,
2071
+ )
2072
+
2073
+ x_exciting_section_spin = SubSection(
2074
+ sub_section=SectionProxy('x_exciting_section_spin'), repeats=True
2075
+ )
2076
+
2077
+ x_exciting_section_xc = SubSection(
2078
+ sub_section=SectionProxy('x_exciting_section_xc'), repeats=True
2079
+ )
2080
+
2081
+
2082
+ class x_exciting_section_MT_charge_atom(MSection):
2083
+ """
2084
+ atom-resolved charges in muffin tins
2085
+ """
2086
+
2087
+ m_def = Section(validate=False)
2088
+
2089
+ x_exciting_MT_charge_atom_index = Quantity(
2090
+ type=int,
2091
+ shape=[],
2092
+ description="""
2093
+ index of the atom with muffin-tin charge
2094
+ """,
2095
+ )
2096
+
2097
+ x_exciting_MT_charge_atom_symbol = Quantity(
2098
+ type=str,
2099
+ shape=[],
2100
+ description="""
2101
+ chemical symbol of the atom with muffin-tin charge
2102
+ """,
2103
+ )
2104
+
2105
+ x_exciting_MT_charge_atom_value = Quantity(
2106
+ type=np.float64,
2107
+ shape=[],
2108
+ unit='coulomb',
2109
+ description="""
2110
+ value of the muffin-tin charge on atom
2111
+ """,
2112
+ )
2113
+
2114
+
2115
+ class x_exciting_section_MT_moment_atom(MSection):
2116
+ """
2117
+ atom-resolved moments in muffin tins
2118
+ """
2119
+
2120
+ m_def = Section(validate=False)
2121
+
2122
+ x_exciting_MT_moment_atom_index = Quantity(
2123
+ type=int,
2124
+ shape=[],
2125
+ description="""
2126
+ index of the atom with muffin-tin moment
2127
+ """,
2128
+ )
2129
+
2130
+ x_exciting_MT_moment_atom_symbol = Quantity(
2131
+ type=str,
2132
+ shape=[],
2133
+ description="""
2134
+ chemical symbol of the atom with muffin-tin moment
2135
+ """,
2136
+ )
2137
+
2138
+ x_exciting_MT_moment_atom_value = Quantity(
2139
+ type=np.float64,
2140
+ shape=['*'],
2141
+ unit='coulomb * meter',
2142
+ description="""
2143
+ value of the muffin-tin moment on atom
2144
+ """,
2145
+ )
2146
+
2147
+
2148
+ class ScfIteration(runschema.calculation.ScfIteration):
2149
+ m_def = Section(validate=False, extends_base_section=True)
2150
+
2151
+ x_exciting_charge_convergence = Quantity(
2152
+ type=np.float64,
2153
+ shape=[2],
2154
+ unit='coulomb',
2155
+ description="""
2156
+ exciting charge convergence
2157
+ """,
2158
+ )
2159
+
2160
+ x_exciting_core_electron_kinetic_energy = Quantity(
2161
+ type=np.float64,
2162
+ shape=[],
2163
+ unit='joule',
2164
+ description="""
2165
+ Core-electron kinetic energy
2166
+ """,
2167
+ )
2168
+
2169
+ x_exciting_core_charge = Quantity(
2170
+ type=np.float64,
2171
+ shape=[],
2172
+ unit='coulomb',
2173
+ description="""
2174
+ Core charge
2175
+ """,
2176
+ )
2177
+
2178
+ x_exciting_valence_charge = Quantity(
2179
+ type=np.float64,
2180
+ shape=[],
2181
+ unit='coulomb',
2182
+ description="""
2183
+ Valence charge
2184
+ """,
2185
+ )
2186
+
2187
+ x_exciting_core_leakage = Quantity(
2188
+ type=np.float64,
2189
+ shape=[],
2190
+ unit='coulomb',
2191
+ description="""
2192
+ Core leakage
2193
+ """,
2194
+ )
2195
+
2196
+ x_exciting_correlation_energy = Quantity(
2197
+ type=np.float64,
2198
+ shape=[],
2199
+ unit='joule',
2200
+ description="""
2201
+ Correlation energy
2202
+ """,
2203
+ )
2204
+
2205
+ x_exciting_coulomb_energy = Quantity(
2206
+ type=np.float64,
2207
+ shape=[],
2208
+ unit='joule',
2209
+ description="""
2210
+ Coulomb energy
2211
+ """,
2212
+ )
2213
+
2214
+ x_exciting_coulomb_potential_energy = Quantity(
2215
+ type=np.float64,
2216
+ shape=[],
2217
+ unit='joule',
2218
+ description="""
2219
+ Coulomb potential energy
2220
+ """,
2221
+ )
2222
+
2223
+ x_exciting_dos_fermi = Quantity(
2224
+ type=np.float64,
2225
+ shape=[],
2226
+ unit='1 / joule',
2227
+ description="""
2228
+ DOS at Fermi energy
2229
+ """,
2230
+ )
2231
+
2232
+ x_exciting_effective_potential_convergence = Quantity(
2233
+ type=np.float64,
2234
+ shape=[2],
2235
+ unit='joule',
2236
+ description="""
2237
+ exciting effective potential convergence
2238
+ """,
2239
+ )
2240
+
2241
+ x_exciting_force_convergence = Quantity(
2242
+ type=np.float64,
2243
+ shape=[2],
2244
+ unit='newton',
2245
+ description="""
2246
+ exciting force convergence
2247
+ """,
2248
+ )
2249
+
2250
+ x_exciting_effective_potential_energy = Quantity(
2251
+ type=np.float64,
2252
+ shape=[],
2253
+ unit='joule',
2254
+ description="""
2255
+ Effective potential energy
2256
+ """,
2257
+ )
2258
+
2259
+ x_exciting_electron_nuclear_energy = Quantity(
2260
+ type=np.float64,
2261
+ shape=[],
2262
+ unit='joule',
2263
+ description="""
2264
+ Electron-nuclear energy
2265
+ """,
2266
+ )
2267
+
2268
+ x_exciting_energy_convergence = Quantity(
2269
+ type=np.float64,
2270
+ shape=[2],
2271
+ unit='joule',
2272
+ description="""
2273
+ exciting energy convergence
2274
+ """,
2275
+ )
2276
+
2277
+ x_exciting_exchange_energy = Quantity(
2278
+ type=np.float64,
2279
+ shape=[],
2280
+ unit='joule',
2281
+ description="""
2282
+ Exchange energy
2283
+ """,
2284
+ )
2285
+
2286
+ x_exciting_fermi_energy = Quantity(
2287
+ type=np.float64,
2288
+ shape=[],
2289
+ unit='joule',
2290
+ description="""
2291
+ Fermi energy
2292
+ """,
2293
+ )
2294
+
2295
+ x_exciting_gap = Quantity(
2296
+ type=np.float64,
2297
+ shape=[],
2298
+ unit='joule',
2299
+ description="""
2300
+ Estimated fundamental gap
2301
+ """,
2302
+ )
2303
+
2304
+ x_exciting_hartree_energy = Quantity(
2305
+ type=np.float64,
2306
+ shape=[],
2307
+ unit='joule',
2308
+ description="""
2309
+ Hartree energy
2310
+ """,
2311
+ )
2312
+
2313
+ x_exciting_IBS_force_convergence = Quantity(
2314
+ type=np.float64,
2315
+ shape=[2],
2316
+ unit='newton',
2317
+ description="""
2318
+ exciting IBS force convergence
2319
+ """,
2320
+ )
2321
+
2322
+ x_exciting_interstitial_charge = Quantity(
2323
+ type=np.float64,
2324
+ shape=[],
2325
+ unit='coulomb',
2326
+ description="""
2327
+ Interstitial charge
2328
+ """,
2329
+ )
2330
+
2331
+ x_exciting_madelung_energy = Quantity(
2332
+ type=np.float64,
2333
+ shape=[],
2334
+ unit='joule',
2335
+ description="""
2336
+ Madelung energy
2337
+ """,
2338
+ )
2339
+
2340
+ x_exciting_nuclear_nuclear_energy = Quantity(
2341
+ type=np.float64,
2342
+ shape=[],
2343
+ unit='joule',
2344
+ description="""
2345
+ Nuclear-nuclear energy
2346
+ """,
2347
+ )
2348
+
2349
+ x_exciting_time = Quantity(
2350
+ type=np.float64,
2351
+ shape=[],
2352
+ unit='s',
2353
+ description="""
2354
+ scf iteration time
2355
+ """,
2356
+ )
2357
+
2358
+ x_exciting_total_MT_charge = Quantity(
2359
+ type=np.float64,
2360
+ shape=[],
2361
+ unit='coulomb',
2362
+ description="""
2363
+ Total charge in muffin-tins
2364
+ """,
2365
+ )
2366
+
2367
+ x_exciting_total_charge = Quantity(
2368
+ type=np.float64,
2369
+ shape=[],
2370
+ unit='coulomb',
2371
+ description="""
2372
+ Total charge
2373
+ """,
2374
+ )
2375
+
2376
+ x_exciting_XC_potential = Quantity(
2377
+ type=np.float64,
2378
+ shape=[],
2379
+ unit='joule',
2380
+ description="""
2381
+ XC potential
2382
+ """,
2383
+ )
2384
+
2385
+ x_exciting_interstitial_moment = Quantity(
2386
+ type=np.float64,
2387
+ shape=['*'],
2388
+ unit='coulomb * meter',
2389
+ description="""
2390
+ Interstitial moment
2391
+ """,
2392
+ )
2393
+
2394
+ x_exciting_total_MT_moment = Quantity(
2395
+ type=np.float64,
2396
+ shape=['*'],
2397
+ unit='coulomb * meter',
2398
+ description="""
2399
+ Total moment in muffin-tins
2400
+ """,
2401
+ )
2402
+
2403
+ x_exciting_total_moment = Quantity(
2404
+ type=np.float64,
2405
+ shape=['*'],
2406
+ unit='coulomb * meter',
2407
+ description="""
2408
+ Total moment
2409
+ """,
2410
+ )
2411
+
2412
+ x_exciting_section_MT_charge_atom_scf_iteration = SubSection(
2413
+ sub_section=SectionProxy('x_exciting_section_MT_charge_atom'), repeats=True
2414
+ )
2415
+
2416
+ x_exciting_section_MT_moment_atom_scf_iteration = SubSection(
2417
+ sub_section=SectionProxy('x_exciting_section_MT_moment_atom'), repeats=True
2418
+ )
2419
+
2420
+
2421
+ class Method(runschema.method.Method):
2422
+ m_def = Section(validate=False, extends_base_section=True)
2423
+
2424
+ x_exciting_dummy = Quantity(
2425
+ type=np.int32,
2426
+ shape=[],
2427
+ description="""
2428
+ dummy metadata for debuging purposes
2429
+ """,
2430
+ )
2431
+
2432
+ x_exciting_volume_optimization = Quantity(
2433
+ type=bool,
2434
+ shape=[],
2435
+ description="""
2436
+ If the volume optimization is performed.
2437
+ """,
2438
+ )
2439
+
2440
+ x_exciting_scf_threshold_energy_change = Quantity(
2441
+ type=np.float64,
2442
+ shape=[],
2443
+ unit='joule',
2444
+ description="""
2445
+ Specifies the threshold for the x_exciting_energy_total_scf_iteration change
2446
+ between two subsequent self-consistent field (SCF) iterations.
2447
+ """,
2448
+ )
2449
+
2450
+ x_exciting_scf_threshold_potential_change_list = Quantity(
2451
+ type=np.float64,
2452
+ shape=[],
2453
+ unit='joule',
2454
+ description="""
2455
+ Specifies the threshold for the x_exciting_effective_potential_convergence between
2456
+ two subsequent self-consistent field (SCF) iterations.
2457
+ """,
2458
+ )
2459
+
2460
+ x_exciting_scf_threshold_potential_change = Quantity(
2461
+ type=np.float64,
2462
+ shape=[],
2463
+ unit='joule',
2464
+ description="""
2465
+ Specifies the threshold for the x_exciting_effective_potential_convergence between
2466
+ two subsequent self-consistent field (SCF) iterations.
2467
+ """,
2468
+ )
2469
+
2470
+ x_exciting_scf_threshold_charge_change_list = Quantity(
2471
+ type=np.float64,
2472
+ shape=[],
2473
+ description="""
2474
+ Specifies the threshold for the x_exciting_effective_potential_convergence between
2475
+ two subsequent self-consistent field (SCF) iterations.
2476
+ """,
2477
+ )
2478
+
2479
+ x_exciting_scf_threshold_charge_change = Quantity(
2480
+ type=np.float64,
2481
+ shape=[],
2482
+ unit='coulomb',
2483
+ description="""
2484
+ Specifies the threshold for the x_exciting_effective_potential_convergence between
2485
+ two subsequent self-consistent field (SCF) iterations.
2486
+ """,
2487
+ )
2488
+
2489
+ x_exciting_scf_threshold_force_change_list = Quantity(
2490
+ type=np.float64,
2491
+ shape=[],
2492
+ description="""
2493
+ Convergence tolerance for forces (not including IBS contribution) during the SCF
2494
+ run.
2495
+ """,
2496
+ )
2497
+
2498
+ x_exciting_scf_threshold_force_change = Quantity(
2499
+ type=np.float64,
2500
+ shape=[],
2501
+ unit='newton',
2502
+ description="""
2503
+ Convergence tolerance for forces (not including IBS contribution) during the SCF
2504
+ run
2505
+ """,
2506
+ )
2507
+
2508
+ x_exciting_electronic_structure_method = Quantity(
2509
+ type=str,
2510
+ shape=[],
2511
+ description="""
2512
+ String identifying the used electronic structure method. Allowed values are BSE
2513
+ and TDDFT. Temporary metadata to be canceled when BSE and TDDFT will be added to
2514
+ public metadata electronic_structure_method
2515
+ """,
2516
+ )
2517
+
2518
+ x_exciting_xs_broadening = Quantity(
2519
+ type=np.float64,
2520
+ shape=[],
2521
+ unit='joule',
2522
+ description="""
2523
+ Lorentzian broadening applied to the spectra.
2524
+ """,
2525
+ )
2526
+
2527
+ x_exciting_xs_bse_angular_momentum_cutoff = Quantity(
2528
+ type=np.int32,
2529
+ shape=[],
2530
+ description="""
2531
+ Angular momentum cutoff of the spherical harmonics expansion of the dielectric
2532
+ matrix.
2533
+ """,
2534
+ )
2535
+
2536
+ x_exciting_xs_bse_antiresonant = Quantity(
2537
+ type=bool,
2538
+ shape=[],
2539
+ description="""
2540
+ If the anti-resonant part of the Hamiltonian is used for the BSE spectrum
2541
+ """,
2542
+ )
2543
+
2544
+ x_exciting_xs_bse_number_of_bands = Quantity(
2545
+ type=np.int32,
2546
+ shape=[4],
2547
+ description="""
2548
+ Range of bands included for the BSE calculation. The first pair of numbers
2549
+ corresponds to the band index for local orbitals and valence states (counted from
2550
+ the lowest eigenenergy), the second pair corresponds to the band index of the
2551
+ conduction states (counted from the Fermi level).
2552
+ """,
2553
+ )
2554
+
2555
+ x_exciting_xs_bse_rgkmax = Quantity(
2556
+ type=np.float64,
2557
+ shape=[],
2558
+ description="""
2559
+ Smallest muffin-tin radius times gkmax.
2560
+ """,
2561
+ )
2562
+
2563
+ x_exciting_xs_bse_sciavbd = Quantity(
2564
+ type=bool,
2565
+ shape=[],
2566
+ description="""
2567
+ if the body of the screened Coulomb interaction is averaged (q=0).
2568
+ """,
2569
+ )
2570
+
2571
+ x_exciting_xs_bse_sciavqbd = Quantity(
2572
+ type=bool,
2573
+ shape=[],
2574
+ description="""
2575
+ if the body of the screened Coulomb interaction is averaged (q!=0).
2576
+ """,
2577
+ )
2578
+
2579
+ x_exciting_xs_bse_sciavqhd = Quantity(
2580
+ type=bool,
2581
+ shape=[],
2582
+ description="""
2583
+ if the head of the screened Coulomb interaction is averaged (q=0).
2584
+ """,
2585
+ )
2586
+
2587
+ x_exciting_xs_bse_sciavqwg = Quantity(
2588
+ type=bool,
2589
+ shape=[],
2590
+ description="""
2591
+ if the wings of the screened Coulomb interaction is averaged (q=0).
2592
+ """,
2593
+ )
2594
+
2595
+ x_exciting_xs_bse_sciavtype = Quantity(
2596
+ type=str,
2597
+ shape=[],
2598
+ description="""
2599
+ how the screened Coulomb interaction matrix is averaged
2600
+ """,
2601
+ )
2602
+
2603
+ x_exciting_xs_bse_type = Quantity(
2604
+ type=str,
2605
+ shape=[],
2606
+ description="""
2607
+ which parts of the BSE Hamiltonian is considered. Possible values are IP, RPA,
2608
+ singlet, triplet.
2609
+ """,
2610
+ )
2611
+
2612
+ x_exciting_xs_bse_xas = Quantity(
2613
+ type=bool,
2614
+ shape=[],
2615
+ description="""
2616
+ X-ray absorption spectrum
2617
+ """,
2618
+ )
2619
+
2620
+ x_exciting_xs_bse_xas_number_of_bands = Quantity(
2621
+ type=np.int32,
2622
+ shape=[2],
2623
+ description="""
2624
+ Range of bands included for the BSE calculation. The pair corresponds to the band
2625
+ index of the conduction states (counted from the Fermi level).
2626
+ """,
2627
+ )
2628
+
2629
+ x_exciting_xs_bse_xasatom = Quantity(
2630
+ type=np.int32,
2631
+ shape=[],
2632
+ description="""
2633
+ Atom number for which the XAS is calculated.
2634
+ """,
2635
+ )
2636
+
2637
+ x_exciting_xs_bse_xasedge = Quantity(
2638
+ type=str,
2639
+ shape=[],
2640
+ description="""
2641
+ Defines the initial states of the XAS calculation.
2642
+ """,
2643
+ )
2644
+
2645
+ x_exciting_xs_bse_xasspecies = Quantity(
2646
+ type=np.int32,
2647
+ shape=[],
2648
+ description="""
2649
+ Species number for which the XAS is calculated..
2650
+ """,
2651
+ )
2652
+
2653
+ x_exciting_xs_gqmax = Quantity(
2654
+ type=np.float64,
2655
+ shape=[],
2656
+ unit='1 / meter',
2657
+ description="""
2658
+ G vector cutoff for the plane-waves matrix elements.
2659
+ """,
2660
+ )
2661
+
2662
+ x_exciting_xs_lmaxapw = Quantity(
2663
+ type=np.int32,
2664
+ shape=[],
2665
+ description="""
2666
+ Angular momentum cut-off for the APW functions.
2667
+ """,
2668
+ )
2669
+
2670
+ x_exciting_xs_ngridk = Quantity(
2671
+ type=np.int32,
2672
+ shape=[3],
2673
+ description="""
2674
+ k-point mesh for the excited states calculation.
2675
+ """,
2676
+ )
2677
+
2678
+ x_exciting_xs_ngridq = Quantity(
2679
+ type=np.int32,
2680
+ shape=[3],
2681
+ description="""
2682
+ q-point mesh for the excited states calculation.
2683
+ """,
2684
+ )
2685
+
2686
+ x_exciting_xs_number_of_empty_states = Quantity(
2687
+ type=np.int32,
2688
+ shape=[],
2689
+ description="""
2690
+ Number of empty states used in the calculation of the response function.
2691
+ """,
2692
+ )
2693
+
2694
+ x_exciting_xs_rgkmax = Quantity(
2695
+ type=np.float64,
2696
+ shape=[],
2697
+ description="""
2698
+ Smallest muffin-tin radius times gkmax.
2699
+ """,
2700
+ )
2701
+
2702
+ x_exciting_xs_scissor = Quantity(
2703
+ type=np.float64,
2704
+ shape=[],
2705
+ unit='joule',
2706
+ description="""
2707
+ Scissor operator
2708
+ """,
2709
+ )
2710
+
2711
+ x_exciting_xs_screening_ngridk = Quantity(
2712
+ type=np.int32,
2713
+ shape=[3],
2714
+ description="""
2715
+ k-point mesh for the calculation of the screening.
2716
+ """,
2717
+ )
2718
+
2719
+ x_exciting_xs_screening_number_of_empty_states = Quantity(
2720
+ type=np.int32,
2721
+ shape=[],
2722
+ description="""
2723
+ Number of empty states used in the calculation of the screening.
2724
+ """,
2725
+ )
2726
+
2727
+ x_exciting_xs_screening_rgkmax = Quantity(
2728
+ type=np.float64,
2729
+ shape=[],
2730
+ description="""
2731
+ Smallest muffin-tin radius times gkmax.
2732
+ """,
2733
+ )
2734
+
2735
+ x_exciting_xs_screening_type = Quantity(
2736
+ type=str,
2737
+ shape=[],
2738
+ description="""
2739
+ Type of screening used in the calculations. POssible values are full, diag,
2740
+ noinvdiag, longrange.
2741
+ """,
2742
+ )
2743
+
2744
+ x_exciting_xs_screening_vkloff = Quantity(
2745
+ type=np.float64,
2746
+ shape=[3],
2747
+ description="""
2748
+ k-point set offset for the screening
2749
+ """,
2750
+ )
2751
+
2752
+ x_exciting_xs_starting_point = Quantity(
2753
+ type=str,
2754
+ shape=[],
2755
+ description="""
2756
+ Exchange-correlation functional of the ground-state calculation. See xc_functional
2757
+ list at https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/XC-
2758
+ functional
2759
+ """,
2760
+ )
2761
+
2762
+ x_exciting_xs_tddft_analytic_continuation = Quantity(
2763
+ type=bool,
2764
+ shape=[],
2765
+ description="""
2766
+ Analytic continuation for the calculation of the Kohn-Sham response function
2767
+ """,
2768
+ )
2769
+
2770
+ x_exciting_xs_tddft_analytic_continuation_number_of_intervals = Quantity(
2771
+ type=np.int32,
2772
+ shape=[],
2773
+ description="""
2774
+ Number of energy intervals (on imaginary axis) for analytic continuation.
2775
+ """,
2776
+ )
2777
+
2778
+ x_exciting_xs_tddft_anomalous_hall_conductivity = Quantity(
2779
+ type=bool,
2780
+ shape=[],
2781
+ description="""
2782
+ If the anomalous Hall conductivity term is included in the calculation of the
2783
+ dielectric tensor [see PRB 86, 125139 (2012)].
2784
+ """,
2785
+ )
2786
+
2787
+ x_exciting_xs_tddft_anti_resonant_dielectric = Quantity(
2788
+ type=bool,
2789
+ shape=[],
2790
+ description="""
2791
+ If the anti-resonant part is considered for the calculation of the dielectric
2792
+ function
2793
+ """,
2794
+ )
2795
+
2796
+ x_exciting_xs_tddft_anti_resonant_xc_kernel = Quantity(
2797
+ type=bool,
2798
+ shape=[],
2799
+ description="""
2800
+ If the anti-resonant part is considered for the calculation of the MBPT-derived
2801
+ xc-kernel
2802
+ """,
2803
+ )
2804
+
2805
+ x_exciting_xs_tddft_diagonal_xc_kernel = Quantity(
2806
+ type=bool,
2807
+ shape=[],
2808
+ description="""
2809
+ If true, only the diagonal part of xc-kernel is used.
2810
+ """,
2811
+ )
2812
+
2813
+ x_exciting_xs_tddft_drude = Quantity(
2814
+ type=np.float64,
2815
+ shape=[2],
2816
+ unit='1 / second',
2817
+ description="""
2818
+ Parameters defining the semiclassical Drude approximation to intraband term. The
2819
+ first value determines the plasma frequency ωp and the second the inverse
2820
+ relaxation time ωτ: χD0=1/ω ωp^2/(ω+iωτ)
2821
+ """,
2822
+ )
2823
+
2824
+ x_exciting_xs_tddft_finite_q_intraband_contribution = Quantity(
2825
+ type=bool,
2826
+ shape=[],
2827
+ description="""
2828
+ Parameter determining whether the the intraband contribution is included in the
2829
+ calculation for the finite q.
2830
+ """,
2831
+ )
2832
+
2833
+ x_exciting_xs_tddft_lmax_alda = Quantity(
2834
+ type=np.int32,
2835
+ shape=[],
2836
+ description="""
2837
+ Angular momentum cutoff for the Rayleigh expansion of the exponential factor for
2838
+ ALDA-kernel
2839
+ """,
2840
+ )
2841
+
2842
+ x_exciting_xs_tddft_macroscopic_dielectric_function_q_treatment = Quantity(
2843
+ type=np.int32,
2844
+ shape=[],
2845
+ description="""
2846
+ Treatment of macroscopic dielectric function for the Q-point outside the Brillouin
2847
+ zone. A value of 0 uses the full Q and the (0,0) component of the microscopic
2848
+ dielectric matrix is used. A value of 1 means a decomposition Q=q+Gq and the
2849
+ (Qq,Qq) component of the microscopic dielectric matrix is used.
2850
+ """,
2851
+ )
2852
+
2853
+ x_exciting_xs_tddft_split_parameter = Quantity(
2854
+ type=np.float64,
2855
+ shape=[],
2856
+ unit='joule',
2857
+ description="""
2858
+ Split parameter for degeneracy in energy differences of MBPT derived xc kernels.
2859
+ See A. Marini, Phys. Rev. Lett., 91, (2003) 256402.
2860
+ """,
2861
+ )
2862
+
2863
+ x_exciting_xs_tddft_xc_kernel = Quantity(
2864
+ type=str,
2865
+ shape=[],
2866
+ description="""
2867
+ Defines which xc kernel is to be used. Possible choices are: RPA - Random-phase
2868
+ approximation kernel (fxc=0); LRCstatic - Long-range correction kernel (fxc =
2869
+ -alpha/q^2) with alpha given by alphalrcdyn see S. Botti et al., Phys. Rev. B 69,
2870
+ 155112 (2004); LRCdyn - Dynamical long-range correction kernel, with alpha anf
2871
+ beta give by alphalrcdyn and betalrcdyn, respectively, see S. Botti et al., Phys.
2872
+ Rev. B 72, 125203 (2005); ALDA - Adiabatic LDA kernel, with Vxc given by the spin-
2873
+ unpolarised exchange-correlation potential corresponding to the Perdew-Wang
2874
+ parameterisation of Ceperley-Alder's Monte-Carlo data, see Phys. Rev. B 45, 13244
2875
+ (1992) and Phys. Rev. Lett. 45, 566 (1980); MB1 - BSE derived xc kernel. See L.
2876
+ Reining et al., Phys. Rev. Lett. 88, 066404 (2002) and A. Marini et al., Phys.
2877
+ Rev. Lett. 91, 256402 (2003); BO - Bootstrap kernel, see S. Sharma et al., Phys.
2878
+ Rev. Lett. 107, 186401 (2011); BO_SCALAR - Scalar version of the bootstrap kernel;
2879
+ see S. Sharma et al., Phys. Rev. Lett. 107, 186401 (2011); RBO - RPA bootstrap
2880
+ kernel; see S. Rigamonti et al., Phys. Rev. Lett. 114, 146402 (2015).
2881
+ """,
2882
+ )
2883
+
2884
+ x_exciting_xs_tetra = Quantity(
2885
+ type=bool,
2886
+ shape=[],
2887
+ description="""
2888
+ Integration method (tetrahedron) used for the k-space integration in the Kohn-Sham
2889
+ response function.
2890
+ """,
2891
+ )
2892
+
2893
+ x_exciting_xs_vkloff = Quantity(
2894
+ type=np.float64,
2895
+ shape=[3],
2896
+ description="""
2897
+ k-point set offset
2898
+ """,
2899
+ )
2900
+
2901
+ x_exciting_xs_xstype = Quantity(
2902
+ type=str,
2903
+ shape=[],
2904
+ description="""
2905
+ Type of excited states calculation, BSE or TDDFT
2906
+ """,
2907
+ )
2908
+
2909
+ x_exciting_xs_energywindow_values = Quantity(
2910
+ type=np.float64,
2911
+ shape=[2],
2912
+ unit='joule',
2913
+ description="""
2914
+ Energy interval lower and upper limits. Default is [-0.5d0, 0.5d0] in Hartree.
2915
+ """,
2916
+ )
2917
+
2918
+ x_exciting_xs_energywindow_points = Quantity(
2919
+ type=np.int32,
2920
+ shape=[],
2921
+ description="""
2922
+ Number of points to be sampled linearly inside the energy interval including the
2923
+ lower limit. Default is 500.
2924
+ """,
2925
+ )
2926
+
2927
+
2928
+ class Run(runschema.run.Run):
2929
+ m_def = Section(validate=False, extends_base_section=True)
2930
+
2931
+ x_exciting_dummy2 = Quantity(
2932
+ type=str,
2933
+ shape=[],
2934
+ description="""
2935
+ dummy metadata for debuging purposes
2936
+ """,
2937
+ )
2938
+
2939
+ x_exciting_section_geometry_optimization = SubSection(
2940
+ sub_section=SectionProxy('x_exciting_section_geometry_optimization'),
2941
+ repeats=True,
2942
+ )