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,671 @@
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
20
+ import logging
21
+ import ase
22
+ from ase.io.ulm import Reader
23
+
24
+ from nomad.units import ureg
25
+ from nomad.parsing.file_parser import FileParser, TarParser, XMLParser, DataTextParser
26
+ from runschema.run import Run, Program
27
+ from runschema.method import (
28
+ Electronic,
29
+ Method,
30
+ DFT,
31
+ Smearing,
32
+ XCFunctional,
33
+ Functional,
34
+ BasisSet,
35
+ BasisSetContainer,
36
+ Electronic,
37
+ Scf,
38
+ )
39
+ from runschema.system import System, Atoms
40
+ from runschema.calculation import (
41
+ Calculation,
42
+ Energy,
43
+ EnergyEntry,
44
+ Forces,
45
+ ForcesEntry,
46
+ BandEnergies,
47
+ BandStructure,
48
+ Density,
49
+ Potential,
50
+ PotentialValue,
51
+ )
52
+ from .metainfo import gpaw # pylint: disable=unused-import
53
+
54
+
55
+ class GPWParser(TarParser):
56
+ def __init__(self):
57
+ super().__init__()
58
+ self._version_map = {6: '1.1.0', 5: '0.11.0', 3: '0.10.0'}
59
+ self._info_map = {
60
+ 'energy_total': 'Epot',
61
+ 'energy_XC': 'Exc',
62
+ 'electronic_kinetic_energy': 'Ekin',
63
+ 'energy_correction_entropy': 'S',
64
+ 'atom_forces_free': 'CartesianForce',
65
+ 'atom_positions': 'CartesianPositions',
66
+ 'occupation': 'OccupationNumbers',
67
+ 'kpoints': 'IBZKPoints',
68
+ }
69
+
70
+ def reset(self):
71
+ super().reset()
72
+ self._info = None
73
+
74
+ @property
75
+ def info(self):
76
+ if self._info is None:
77
+ self._info = dict()
78
+ xml_file = self.get('info.xml', None)
79
+ if xml_file is None:
80
+ return
81
+ self.xml_file = xml_file
82
+ xml_parser = XMLParser(xml_file, logger=self.logger)
83
+
84
+ def convert(val):
85
+ if isinstance(val, list):
86
+ return [convert(v) for v in val]
87
+ try:
88
+ if val in ['True', 'False']:
89
+ return val == 'True'
90
+ else:
91
+ val = float(val)
92
+ if val % 1.0 == 0.0:
93
+ val = int(val)
94
+ return val
95
+ except Exception:
96
+ return val
97
+
98
+ # parameters
99
+ self._info['parameter'] = {
100
+ 'lengthunit': 'angstrom',
101
+ 'energyunit': 'eV',
102
+ 'timeunit': 'femtosecond',
103
+ }
104
+ self._info['parameter'].update(
105
+ {
106
+ p['name'].lower(): convert(p['value'])
107
+ for p in xml_parser.get('parameter/', [])
108
+ }
109
+ )
110
+
111
+ # array shapes, types, dimensions
112
+ self._info['array'] = dict()
113
+ dimension = dict()
114
+ for arr in xml_parser.root.findall('./array'):
115
+ name = arr.attrib.get('name', None)
116
+ dtype = arr.attrib.get('type', None)
117
+ if name is None or dtype is None:
118
+ continue
119
+ shape = []
120
+ for dim in arr.findall('./dimension'):
121
+ length = int(dim.attrib.get('length', 0))
122
+ shape.append(length)
123
+ dimension[dim.attrib.get('name')] = length
124
+ self._info['array'][name.lower()] = dict(dtype=dtype, shape=shape)
125
+ self._info['array_dimension'] = dimension
126
+
127
+ self._info['bytesswap'] = (
128
+ xml_parser.root.attrib['endianness'] == 'little'
129
+ ) != np.little_endian
130
+
131
+ xml_parser.close()
132
+
133
+ return self._info
134
+
135
+ def get_parameter(self, key, unit=None):
136
+ key = self._info_map.get(key, key)
137
+ return self.info['parameter'].get(key.lower(), None)
138
+
139
+ def get_array(self, key, unit=None):
140
+ key = self._info_map.get(key, key)
141
+ file_object = self.get(key)
142
+ if file_object is None:
143
+ return
144
+
145
+ key = key.lower()
146
+ shape = self.info['array'].get(key, {}).get('shape', None)
147
+ dtype = self.info['array'].get(key, {}).get('dtype', None)
148
+ dtype = np.dtype({'int': 'int32'}.get(dtype, dtype))
149
+ size = np.prod(shape) * dtype.itemsize
150
+
151
+ file_object.seek(0)
152
+ parser = DataTextParser(
153
+ mainfile_contents=file_object.read(size), logger=self.logger, dtype=dtype
154
+ )
155
+ if parser.data is None:
156
+ return
157
+
158
+ array = parser.data
159
+ if self._info['bytesswap']:
160
+ array = array.byteswap()
161
+ if dtype == np.int32:
162
+ array = np.asarray(array, int)
163
+ array.shape = shape
164
+ return array
165
+
166
+ def get_array_dimension(self, key):
167
+ if key == 'ngpts':
168
+ val = [self.get_array_dimension('ngpts%s' % n) for n in ['x', 'y', 'z']]
169
+ else:
170
+ val = self.info['array_dimension'].get(key)
171
+ return val
172
+
173
+ def get_program_version(self):
174
+ return self._version_map.get(self.get_parameter('version'), '0.9.0')
175
+
176
+ def get_smearing_width(self):
177
+ return self.get_parameter('fermiwidth')
178
+
179
+
180
+ class GPW2Parser(FileParser):
181
+ def __init__(self):
182
+ super().__init__(None)
183
+
184
+ def reset(self):
185
+ super().reset()
186
+ self._info = None
187
+
188
+ @property
189
+ def ulm(self):
190
+ if self._file_handler is None:
191
+ try:
192
+ self._file_handler = Reader(self.mainfile)
193
+ except Exception:
194
+ pass
195
+ return self._file_handler
196
+
197
+ @property
198
+ def info(self):
199
+ if self._info is None:
200
+ self._info = dict()
201
+ self._info['parameter'] = {
202
+ 'mode': 'fd',
203
+ 'xc': 'LDA',
204
+ 'occupations': None,
205
+ 'poissonsolver': None,
206
+ 'h': None,
207
+ 'gpts': None,
208
+ 'kpts': [(0.0, 0.0, 0.0)],
209
+ 'nbands': None,
210
+ 'charge': 0,
211
+ 'setups': {},
212
+ 'basis': {},
213
+ 'spinpol': None,
214
+ 'fixdensity': False,
215
+ 'filter': None,
216
+ 'mixer': None,
217
+ 'eigensolver': None,
218
+ 'background_charge': None,
219
+ 'external': None,
220
+ 'random': False,
221
+ 'hund': False,
222
+ 'maxiter': 333,
223
+ 'idiotproof': True,
224
+ 'symmetry': {
225
+ 'point_group': True,
226
+ 'time_reversal': True,
227
+ 'symmorphic': True,
228
+ 'tolerance': 1e-7,
229
+ },
230
+ 'convergence': {
231
+ 'energy': 0.0005,
232
+ 'density': 1.0e-4,
233
+ 'eigenstates': 4.0e-8,
234
+ 'bands': 'occupied',
235
+ 'forces': np.inf,
236
+ },
237
+ 'dtype': None,
238
+ 'width': None,
239
+ 'verbose': 0,
240
+ 'lengthunit': 'angstrom',
241
+ 'energyunit': 'eV',
242
+ 'timeunit': 'femtosecond',
243
+ }
244
+ if self.ulm is not None:
245
+ self._info['parameter'].update(self.ulm.parameters.asdict())
246
+ return self._info
247
+
248
+ def get_parameter(self, key):
249
+ try:
250
+ if key == 'planewavecutoff':
251
+ val = self.get_parameter('mode').get('ecut', None)
252
+ elif key == 'basisset':
253
+ val = self.get_parameter('basis')
254
+ elif key == 'energyerror':
255
+ val = self.get_parameter('convergence').get('energy', None)
256
+ elif key == 'xcfunctional':
257
+ val = self.get_parameter('xc')
258
+ # in gpw format, energies are parameters
259
+ elif key == 'energy_total':
260
+ val = self.ulm.hamiltonian.e_total_extrapolated
261
+ elif key == 'energy_free':
262
+ val = self.ulm.hamiltonian.e_total_free
263
+ elif key == 'energy_XC':
264
+ val = self.ulm.hamiltonian.e_xc
265
+ elif key == 'electronic_kinetic_energy':
266
+ val = self.ulm.hamiltonian.e_kinetic
267
+ elif key == 'energy_correction_entropy':
268
+ val = self.ulm.hamiltonian.e_entropy
269
+ elif key == 'fermilevel':
270
+ val = self.ulm.occupations.fermilevel
271
+ elif key == 'split':
272
+ val = self.ulm.occupations.split
273
+ elif key == 'converged':
274
+ val = self.ulm.scf.converged
275
+ else:
276
+ val = self.info['parameter'].get(key.lower(), None)
277
+ except Exception:
278
+ val = None
279
+ return val
280
+
281
+ def get_array(self, key):
282
+ if self.ulm is None:
283
+ return
284
+ try:
285
+ if key == 'unitcell':
286
+ val = self.ulm.atoms.cell
287
+ elif key == 'atomicnumbers':
288
+ val = self.ulm.atoms.numbers
289
+ elif key == 'atom_positions':
290
+ val = self.ulm.atoms.positions
291
+ elif key == 'boundaryconditions':
292
+ val = self.ulm.atoms.pbc
293
+ elif key == 'momenta':
294
+ val = self.ulm.atoms.momenta
295
+ elif key == 'atom_forces_free_raw':
296
+ val = self.ulm.results.forces
297
+ elif key == 'magneticmoments':
298
+ val = self.ulm.results.magmoms
299
+ elif key == 'eigenvalues':
300
+ val = self.ulm.wave_functions.eigenvalues
301
+ elif key == 'occupation':
302
+ val = self.ulm.wave_functions.occupations
303
+ # TODO no koints data in ulm?
304
+ elif key == 'kpoints':
305
+ val = self.ulm.IBZKPoints
306
+ elif key == 'density':
307
+ val = self.ulm.density.density
308
+ elif key == 'potential_effective':
309
+ val = self.ulm.hamiltonian.potential
310
+ elif key == 'band_paths':
311
+ val = self.ulm.wave_functions.band_paths.asdict()
312
+ else:
313
+ val = self.ulm.asdict().get(key, None)
314
+ except Exception:
315
+ val = None
316
+ return val
317
+
318
+ def get_array_dimension(self, key):
319
+ if key == 'ngpts':
320
+ val = self.ulm.density.density.shape
321
+ else:
322
+ val = self.ulm.asdict().get(key, None)
323
+ return val
324
+
325
+ def get_program_version(self):
326
+ return self.ulm.gpaw_version
327
+
328
+ def get_smearing_width(self):
329
+ if self.get_parameter('occupations') is None:
330
+ return 0.0 if tuple(self.get_parameter('kpts')) == (1, 1, 1) else 0.1
331
+ else:
332
+ return self.get_parameter('occupations').get('width')
333
+
334
+ def parse(self, key=None):
335
+ pass
336
+
337
+
338
+ class GPAWParser:
339
+ def __init__(self):
340
+ self.gpw_parser = GPWParser()
341
+ self.gpw2_parser = GPW2Parser()
342
+ self._xc_map = {
343
+ 'LDA': ['LDA_X', 'LDA_C_PW'],
344
+ 'PW91': ['GGA_X_PW91', 'GGA_C_PW91'],
345
+ 'PBE': ['GGA_X_PBE', 'GGA_C_PBE'],
346
+ 'PBEsol': ['GGA_X_PBE_SOL', 'GGA_C_PBE_SOL'],
347
+ 'revPBE': ['GGA_X_PBE_R', 'GGA_C_PBE'],
348
+ 'RPBE': ['GGA_X_RPBE', 'GGA_C_PBE'],
349
+ 'BLYP': ['GGA_X_B88', 'GGA_C_LYP'],
350
+ 'HCTH407': ['GGA_XC_HCTH_407'],
351
+ 'WC': ['GGA_X_WC', 'GGA_C_PBE'],
352
+ 'AM05': ['GGA_X_AM05', 'GGA_C_AM05'],
353
+ 'M06-L': ['MGGA_X_M06_L', 'MGGA_C_M06_L'],
354
+ 'TPSS': ['MGGA_X_TPSS', 'MGGA_C_TPSS'],
355
+ 'revTPSS': ['MGGA_X_REVTPSS', 'MGGA_C_REVTPSS'],
356
+ 'mBEEF': ['MGGA_X_MBEEF', 'GGA_C_PBE_SOL'],
357
+ }
358
+
359
+ def init_parser(self, filepath, logger):
360
+ self.parser = self.gpw_parser
361
+ self.parser.mainfile = filepath
362
+ if self.parser.mainfile_obj is None:
363
+ self.parser = self.gpw2_parser
364
+ self.parser.mainfile = filepath
365
+ self.parser.logger = logger
366
+
367
+ def apply_unit(self, val, unit):
368
+ units_map = {
369
+ 'ev': ureg.eV,
370
+ 'hartree': ureg.hartree,
371
+ 'angstrom': ureg.angstrom,
372
+ 'bohr': ureg.bohr,
373
+ 'femtosecond': ureg.fs,
374
+ }
375
+ p_unit = self.parser.info['parameter'].get(unit, '').lower()
376
+ unit = units_map.get(p_unit, p_unit) if p_unit else unit
377
+ return val * unit
378
+
379
+ def get_mode(self):
380
+ mode = self.parser.get_parameter('mode')
381
+ if isinstance(mode, dict):
382
+ mode = mode.get('name', None)
383
+ return mode
384
+
385
+ def get_nspin(self):
386
+ # TODO another way determine spin?
387
+ magnetic_moments = self.parser.get_array('magneticmoments')
388
+ return 1 if magnetic_moments is None else 2
389
+
390
+ def get_fermi_level(self):
391
+ fermi_level = [self.parser.get_parameter('fermilevel')] * self.get_nspin()
392
+ if None in fermi_level:
393
+ return
394
+ split = self.parser.get_parameter('split')
395
+ if split is not None:
396
+ fermi_level = [v + (-i + 0.5) * split for i, v in enumerate(fermi_level)]
397
+ return self.apply_unit(fermi_level, 'energyunit')
398
+
399
+ def parse_method(self):
400
+ sec_method = Method()
401
+ self.archive.run[-1].method.append(sec_method)
402
+
403
+ # Basis Set
404
+ def _basisset_type_to_container(basisset_type: str) -> str:
405
+ for option in ('real-space grid', 'plane waves'):
406
+ if basisset_type == option:
407
+ return basisset_type
408
+ if basisset_type == 'numeric AOs':
409
+ return 'atom-centered orbitals'
410
+ return ''
411
+
412
+ mode = self.get_mode()
413
+ bs = None
414
+ if mode == 'pw':
415
+ pw_cutoff = self.parser.get_parameter('planewavecutoff')
416
+ pw_cutoff = self.apply_unit(pw_cutoff, 'energyunit')
417
+ bs = BasisSet(
418
+ scope=['valence'],
419
+ type='plane waves',
420
+ cutoff=pw_cutoff,
421
+ )
422
+ elif mode == 'fd':
423
+ bs = BasisSet(
424
+ scope=['full-electron'], # TODO check
425
+ type='real-space grid',
426
+ )
427
+ cell = self.parser.get_array('unitcell')
428
+ ngpts = self.apply_unit(
429
+ self.parser.get_array_dimension('ngpts'), 'lengthunit'
430
+ )
431
+ if cell.any() and ngpts.all():
432
+ h_grid = np.linalg.norm(cell, axis=1) / np.array(ngpts[:3])
433
+ bs.grid_spacing = self.apply_unit(h_grid, 'lengthunit')
434
+ elif mode == 'lcao':
435
+ bs = BasisSet(
436
+ scope=['full-electron'], # TODO check
437
+ type='numeric AOs',
438
+ )
439
+ if bs:
440
+ sec_method.electrons_representation.append(
441
+ BasisSetContainer(
442
+ type=_basisset_type_to_container(bs.type),
443
+ scope=['wavefunction'],
444
+ basis_set=[bs],
445
+ )
446
+ )
447
+
448
+ sec_electronic = Electronic()
449
+ sec_method.electronic = sec_electronic
450
+ sec_electronic.relativity_method = 'pseudo_scalar_relativistic'
451
+ sec_electronic.method = 'DFT'
452
+ charge = self.parser.get_parameter('charge')
453
+ if charge is not None:
454
+ sec_electronic.charge = int(charge)
455
+
456
+ threshold_energy = self.parser.get_parameter('energyerror')
457
+ sec_scf = Scf()
458
+ sec_method.scf = sec_scf
459
+ sec_scf.threshold_energy_change = self.apply_unit(
460
+ threshold_energy, 'energyunit'
461
+ )
462
+
463
+ smearing_width = self.parser.get_smearing_width()
464
+ if smearing_width is not None:
465
+ sec_electronic.smearing = Smearing(
466
+ kind='fermi',
467
+ width=self.apply_unit(smearing_width, 'energyunit')
468
+ .to('joule')
469
+ .magnitude,
470
+ )
471
+
472
+ sec_dft = DFT()
473
+ sec_method.dft = sec_dft
474
+ sec_xc_functional = XCFunctional()
475
+ sec_dft.xc_functional = sec_xc_functional
476
+ xc_functional = self.parser.get_parameter('xcfunctional')
477
+ for xc in self._xc_map.get(xc_functional, [xc_functional]):
478
+ if '_X_' in xc or xc.endswith('_X'):
479
+ sec_xc_functional.exchange.append(Functional(name=xc))
480
+ elif '_C_' in xc or xc.endswith('_C'):
481
+ sec_xc_functional.correlation.append(Functional(name=xc))
482
+ elif 'HYB' in xc:
483
+ sec_xc_functional.hybrid.append(Functional(name=xc))
484
+ else:
485
+ sec_xc_functional.contributions.append(Functional(name=xc))
486
+
487
+ method_keys = [
488
+ 'fix_magnetic_moment',
489
+ 'fix_density',
490
+ 'density_convergence_criterion',
491
+ 'mix_class',
492
+ 'mix_beta',
493
+ 'mix_weight',
494
+ 'mix_old',
495
+ 'maximum_angular_momentum',
496
+ 'symmetry_time_reversal_switch',
497
+ ]
498
+ for key in method_keys:
499
+ val = self.parser.get_parameter(key.replace('_', ''))
500
+ if val is None:
501
+ continue
502
+ setattr(sec_method, 'x_gpaw_%s' % key, val)
503
+
504
+ def parse_scc(self):
505
+ sec_run = self.archive.run[-1]
506
+ sec_scc = Calculation()
507
+ sec_run.calculation.append(sec_scc)
508
+
509
+ # energies (in gpw, energies are part of parameters)
510
+ energy_keys = [
511
+ 'energy_total',
512
+ 'energy_free',
513
+ 'energy_XC',
514
+ 'energy_kinetic_electronic',
515
+ 'energy_correction_entropy',
516
+ ]
517
+ sec_energy = Energy()
518
+ sec_scc.energy = sec_energy
519
+ for key in energy_keys:
520
+ val = self.parser.get_parameter(key)
521
+ if val is not None:
522
+ sec_energy.m_add_sub_section(
523
+ getattr(Energy, key.replace('energy_', '').lower()),
524
+ EnergyEntry(value=self.apply_unit(val, 'energyunit')),
525
+ )
526
+
527
+ # forces
528
+ if self.parser.get_array('atom_forces_free') is not None:
529
+ energyunit = self.apply_unit(1, 'energyunit').units
530
+ lengthunit = self.apply_unit(1, 'lengthunit').units
531
+ value = self.parser.get_array('atom_forces_free') * energyunit / lengthunit
532
+ raw = (
533
+ self.parser.get_array('atom_forces_free_raw') * energyunit / lengthunit
534
+ )
535
+ sec_scc.forces = Forces(free=ForcesEntry(value=value, value_raw=raw))
536
+
537
+ # magnetic moments
538
+ magnetic_moments = self.parser.get_array('magneticmoments')
539
+ if magnetic_moments is not None:
540
+ sec_scc.x_gpaw_magnetic_moments = magnetic_moments
541
+ sec_scc.x_gpaw_fixed_spin_Sz = magnetic_moments.sum() / 2.0
542
+
543
+ # fermi level
544
+ fermi_level = self.get_fermi_level()
545
+ if fermi_level is not None:
546
+ sec_scc.energy.fermi = fermi_level[0]
547
+
548
+ # eigenvalues
549
+ eigenvalues = self.parser.get_array('eigenvalues')
550
+ if eigenvalues is not None:
551
+ sec_eigenvalues = BandEnergies()
552
+ sec_scc.eigenvalues.append(sec_eigenvalues)
553
+ sec_eigenvalues.kpoints = self.parser.get_array('kpoints')
554
+ values = self.apply_unit(eigenvalues, 'energyunit')
555
+ occupations = self.parser.get_array('occupation')
556
+ sec_eigenvalues.energies = values
557
+ if occupations is not None:
558
+ sec_eigenvalues.occupations = occupations
559
+
560
+ # band path (TODO only in ulm?)
561
+ band_paths = self.parser.get_array('band_paths')
562
+ if band_paths is not None:
563
+ sec_k_band = BandStructure()
564
+ sec_scc.band_structure_electronic.append(sec_k_band)
565
+ for band_path in band_paths:
566
+ sec_band_seg = BandEnergies()
567
+ sec_k_band.segment.append(sec_band_seg)
568
+ if band_path.get('eigenvalues', None) is not None:
569
+ energies = self.apply_unit(
570
+ band_path.get('eigenvalues'), 'energyunit'
571
+ )
572
+ sec_band_seg.energies = energies
573
+ kpoints = band_path.get('kpoints', None)
574
+ if kpoints is not None:
575
+ sec_band_seg.kpoints = kpoints
576
+ if band_path.get('labels', None) is not None:
577
+ sec_band_seg.endpoints_labels = band_path.get('labels')
578
+
579
+ # volumetric data
580
+ density = self.parser.get_array('density')
581
+ if density is not None:
582
+ cell = self.parser.get_array('unitcell')
583
+ origin = -0.5 * np.array(cell).sum(axis=0)
584
+ pbc = self.parser.get_array('boundaryconditions')
585
+ npoints = np.array(density.shape[1:])
586
+ npoints = [
587
+ (npt + 1) if not pbc[i] else npt for i, npt in enumerate(npoints)
588
+ ]
589
+ displacements = cell / np.array(npoints)
590
+ lengthunit = self.apply_unit(1, 'lengthunit').units
591
+ energyunit = self.apply_unit(1, 'energyunit').units
592
+ density = self.parser.get_array('density')
593
+ if density is not None:
594
+ sec_density = Density()
595
+ sec_scc.density_charge.append(sec_density)
596
+ sec_density.origin = origin * lengthunit
597
+ sec_density.displacements = displacements * lengthunit
598
+ sec_density.value = density / lengthunit**3
599
+
600
+ potential = self.parser.get_array('potential_effective')
601
+ if potential is not None:
602
+ sec_scc.potential.append(Potential(effective=[PotentialValue()]))
603
+ sec_scc.potential[0].effective[0].origin = origin * lengthunit
604
+ sec_scc.potential[0].effective[0].displacements = (
605
+ displacements * lengthunit
606
+ )
607
+ sec_scc.potential[0].effective[0].value = (
608
+ potential * energyunit / lengthunit**3
609
+ )
610
+
611
+ converged = self.parser.get_parameter('converged')
612
+ if converged is not None:
613
+ sec_scc.calculation_converged = converged
614
+
615
+ sec_scc.system_ref = sec_run.system[-1]
616
+ sec_scc.method_ref = sec_run.method[-1]
617
+
618
+ def parse_system(self):
619
+ sec_system = System()
620
+ self.archive.run[-1].system.append(sec_system)
621
+ sec_atoms = Atoms()
622
+ sec_system.atoms = sec_atoms
623
+
624
+ cell = self.parser.get_array('unitcell')
625
+ if cell is not None:
626
+ cell = self.apply_unit(cell, 'lengthunit')
627
+ sec_atoms.lattice_vectors = cell
628
+
629
+ sec_system.atoms.labels = [
630
+ ase.data.chemical_symbols[z] for z in self.parser.get_array('atomicnumbers')
631
+ ]
632
+
633
+ positions = self.parser.get_array('atom_positions')
634
+ sec_atoms.positions = self.apply_unit(positions, 'lengthunit')
635
+
636
+ pbc = (
637
+ [True, True, True]
638
+ if self.get_mode() == 'pw'
639
+ else np.array(self.parser.get_array('boundaryconditions'), bool)
640
+ )
641
+ sec_atoms.periodic = pbc
642
+
643
+ momenta = self.parser.get_array('momenta')
644
+ if momenta is not None:
645
+ masses = np.array(
646
+ [ase.data.atomic_masses[self.parser.get_array('atomicnumbers')]]
647
+ )
648
+ velocities = momenta / masses.reshape(-1, 1)
649
+ sec_atoms.velocities = (
650
+ velocities * ase.units.fs / ase.units.Angstrom * ureg.angstrom / ureg.fs
651
+ )
652
+
653
+ def parse(self, filepath, archive, logger):
654
+ self.filepath = filepath
655
+ self.archive = archive
656
+ self.logger = logging.getLogger(__name__) if logger is None else logger
657
+ self.init_parser(filepath, logger)
658
+
659
+ sec_run = Run()
660
+ self.archive.run.append(sec_run)
661
+ sec_run.program = Program(
662
+ name='GPAW', version=self.parser.get_program_version()
663
+ )
664
+
665
+ self.parse_method()
666
+
667
+ self.parse_system()
668
+
669
+ self.parse_scc()
670
+
671
+ self.parser.close()
@@ -0,0 +1,19 @@
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
+ from .parser import MagresParser