public.nomadmetainfo.json 167 KB
Newer Older
1
2
{
  "type": "nomad_meta_info_1_0",
Luca's avatar
Luca committed
3
  "description": "Public meta info, not specific to any code",
4
  "metaInfos": [ {
5
      "description": "Information that *in theory* should not affect the results of the calculations (e.g., timing).",
6
7
8
      "kindStr": "type_abstract_document_content",
      "name": "accessory_info",
      "superNames": []
9
10
    }, {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_free, **without** constraints. The derivatives with respect to displacements of nuclei are evaluated in Cartesian coordinates. The (electronic) energy_free contains the change in (fractional) occupation of the electronic eigenstates, which are accounted for in the derivatives, yielding a truly energy-conserved quantity. These forces may contain unitary transformations (center-of-mass translations and rigid rotations for non-periodic systems) that are normally filtered separately (see atom_forces_free for the filtered counterpart). Forces due to constraints such as fixed atoms, distances, angles, dihedrals, etc. are also considered separately (see atom_forces_free for the filtered counterpart).",
11
      "dtypeStr": "f",
12
      "name": "atom_forces_free_raw",
13
14
15
16
17
18
19
20
21
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
22
    }, {
23
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_free, **including** constraints, if present. The derivatives with respect to displacements of the nuclei are evaluated in Cartesian coordinates. The (electronic) energy_free contains the information on the change in (fractional) occupation of the electronic eigenstates, which are accounted for in the derivatives, yielding a truly energy-conserved quantity. In addition, these forces are obtained by filtering out the unitary transformations (center-of-mass translations and rigid rotations for non-periodic systems, see atom_forces_free_raw for the unfiltered counterpart). Forces due to constraints such as fixed atoms, distances, angles, dihedrals, etc. are included (see atom_forces_free_raw for the unfiltered counterpart).",
24
25
26
27
28
29
30
31
32
33
34
      "dtypeStr": "f",
      "name": "atom_forces_free",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
35
36
    }, {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total, **without** constraints. The derivatives with respect to displacements of the nuclei are evaluated in Cartesian coordinates. These forces may contain unitary transformations (center-of-mass translations and rigid rotations for non-periodic systems) that are normally filtered separately (see atom_forces for the filtered counterpart). Forces due to constraints such as fixed atoms, distances, angles, dihedrals, etc. are also considered separately (see atom_forces for the filtered counterpart).",
37
      "dtypeStr": "f",
38
      "name": "atom_forces_raw",
39
40
41
42
43
44
45
46
47
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
48
49
    }, {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total_T0, **without** constraints. The derivatives with respect to displacements of the nuclei are evaluated in Cartesian coordinates. These forces may contain unitary transformations (center-of-mass translations and rigid rotations for non-periodic systems) that are normally filtered separately (see atom_forces_T0 for the filtered counterpart). Forces due to constraints such as fixed atoms, distances, angles, dihedrals, etc. are also considered separately (see atom_forces_T0 for the filtered counterpart).",
50
      "dtypeStr": "f",
51
      "name": "atom_forces_T0_raw",
52
53
54
55
56
57
58
59
60
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
61
    }, {
62
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total_T0, **including** constraints, if present. The derivatives with respect to displacements of the nuclei are evaluated in Cartesian coordinates. In addition, these forces are obtained by filtering out the unitary transformations (center-of-mass translations and rigid rotations for non-periodic systems, see atom_forces_free_T0_raw for the unfiltered counterpart). Forces due to constraints such as fixed atoms, distances, angles, dihedrals, etc. are also included (see atom_forces_free_T0_raw for the unfiltered counterpart).",
63
64
65
66
67
68
69
70
71
72
73
      "dtypeStr": "f",
      "name": "atom_forces_T0",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
74
75
    }, {
      "description": "The types of forces acting on the atoms (i.e., minus derivatives of the specific type of energy with respect to the atom position).",
76
      "dtypeStr": "f",
77
78
79
80
81
82
83
84
85
86
      "kindStr": "type_abstract_document_content",
      "name": "atom_forces_type",
      "repeats": true,
      "superNames": [
        "section_single_configuration_calculation"
      ]
    }, {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total, **including** constraints, if present. The derivatives with respect to displacements of nuclei are evaluated in Cartesian coordinates. In addition, these forces are obtained by filtering out the unitary transformations (center-of-mass translations and rigid rotations for non-periodic systems, see atom_forces_free_raw for the unfiltered counterpart). Forces due to constraints such as fixed atoms, distances, angles, dihedrals, etc. are included (see atom_forces_raw for the unfiltered counterpart).",
      "dtypeStr": "f",
      "name": "atom_forces",
87
88
89
90
91
92
93
94
95
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
96
    }, {
97
      "description": "Labels of the atoms. These strings identify the atom kind and conventionally start with the symbol of the atomic species, possibly followed by the atomic number. The same atomic species can be labeled with more than one atom_labels in order to distinguish, e.g., atoms of the same species assigned to different atom-centered basis sets or pseudo-potentials, or simply atoms in different locations in the structure (e.g., bulk and surface). These labels can also be used for *particles* that do not correspond to physical atoms (e.g., ghost atoms in some codes using atom-centered basis sets). This metadata defines a configuration and is therefore required.",
98
      "dtypeStr": "C",
Luca's avatar
Luca committed
99
      "name": "atom_labels",
100
101
102
103
104
105
      "shape": [
        "number_of_atoms"
      ],
      "superNames": [
        "configuration_core"
      ]
106
    }, {
Luca's avatar
Luca committed
107
      "description": "Positions of all the atoms, in Cartesian coordinates. This metadata defines a configuration and is therefore required.",
108
      "dtypeStr": "f",
Luca's avatar
Luca committed
109
      "name": "atom_positions",
110
111
112
113
114
115
116
117
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "configuration_core"
      ],
      "units": "m"
118
    }, {
119
      "description": "Array containing the set of discrete energy values for the atom-projected density (electronic-energy) of states (DOS).",
120
121
122
      "dtypeStr": "f",
      "name": "atom_projected_dos_energies",
      "shape": [
Luca's avatar
Luca committed
123
        "number_of_atom_projected_dos_values"
124
125
126
127
128
      ],
      "superNames": [
        "section_atom_projected_dos"
      ],
      "units": "J"
129
    }, {
130
      "description": "Tuples of $l$ and $m$ values for which atom_projected_dos_values_lm are given. For the quantum number $l$ the conventional meaning of azimuthal quantum number is always adopted. For the integer number $m$, besides the conventional use as magnetic quantum number ($l+1$ integer values from $-l$ to $l$), a set of different conventions is accepted (see the [m_kind wiki page](https://gitlab.rzg.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/m-kind). The adopted convention is specified by atom_projected_dos_m_kind.",
131
132
133
134
135
136
137
138
139
      "dtypeStr": "i",
      "name": "atom_projected_dos_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
        2
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
140
    }, {
141
      "description": "String describing what the integer numbers of $m$ in atom_projected_dos_lm mean. The allowed values are listed in the [m_kind wiki page](https://gitlab.rzg.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/m-kind).",
142
143
144
145
146
147
      "dtypeStr": "C",
      "name": "atom_projected_dos_m_kind",
      "shape": [],
      "superNames": [
        "section_atom_projected_dos"
      ]
148
    }, {
149
      "description": "Values correspond to the number of states for a given energy (the set of discrete energy values is given in atom_projected_dos_energies) divided into contributions from each $l,m$ channel for the atom-projected density (electronic-energy) of states. Here, there are as many atom-projected DOS as the number_of_atoms, the list of labels of the atoms and their meanings are in atom_labels.",
150
151
152
153
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
Luca's avatar
Luca committed
154
        "number_of_spin_channels",
155
        "number_of_atoms",
Luca's avatar
Luca committed
156
        "number_of_atom_projected_dos_values"
157
158
159
160
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
161
    }, {
162
      "description": "Values correspond to the number of states for a given energy (the set of discrete energy values is given in atom_projected_dos_energies) divided into contributions summed up over all $l$ channels for the atom-projected density (electronic-energy) of states (DOS). Here, there are as many atom-projected DOS as the number_of_atoms, the list of labels of the atoms and their meanings are in atom_labels.",
163
164
165
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_total",
      "shape": [
Luca's avatar
Luca committed
166
        "number_of_spin_channels",
167
        "number_of_atoms",
Luca's avatar
Luca committed
168
        "number_of_atom_projected_dos_values"
169
170
171
172
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
173
    }, {
Luca's avatar
Luca committed
174
      "description": "Velocities of the nuclei, defined as the change in Cartesian coordinates of the nuclei with respect to time.",
175
176
177
178
179
180
181
182
      "dtypeStr": "f",
      "name": "atom_velocities",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
Luca's avatar
Luca committed
183
        "section_system"
184
185
      ],
      "units": "m/s"
186
    }, {
187
      "description": "String describing the method used to obtain the electrostatic multipoles (including the electric charge, dipole, etc.) for each atom. Such multipoles require a charge-density partitioning scheme, specified by the value of this metadata. Allowed values are listed in the [atomic_multipole_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/atomic-multipole-kind).",
188
189
190
191
192
193
      "dtypeStr": "C",
      "name": "atomic_multipole_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
194
    }, {
195
      "description": "Tuples of $l$ and $m$ values for which the atomic multipoles (including the electric charge, dipole, etc.) are given. The method used to obtain the multipoles is specified by atomic_multipole_kind. The meaning of the integer number $l$ is monopole/charge for $l=0$, dipole for $l=1$, quadrupole for $l=2$, etc. The meaning of the integer numbers $m$ is specified by atomic_multipole_m_kind.",
196
197
198
199
200
201
202
203
204
      "dtypeStr": "i",
      "name": "atomic_multipole_lm",
      "shape": [
        "number_of_lm_atomic_multipoles",
        2
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
205
    }, {
206
      "description": "String describing the definition for each integer number $m$ in atomic_multipole_lm. Allowed values are listed in the [m_kind wiki page](https://gitlab.rzg.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/m-kind).",
207
208
209
210
211
212
      "dtypeStr": "C",
      "name": "atomic_multipole_m_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
213
    }, {
Luca's avatar
Luca committed
214
      "description": "Value of the multipoles (including the monopole/charge for $l$ = 0, the dipole for $l$ = 1, etc.) for each atom, calculated as described in atomic_multipole_kind.",
215
      "dtypeStr": "f",
Luca's avatar
Luca committed
216
      "name": "atomic_multipole_values",
217
218
219
220
221
222
223
      "shape": [
        "number_of_lm_atomic_multipoles",
        "number_of_atoms"
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
    }, {
      "derived": true,
      "description": "$k$-dependent energies of the electronic band segment (electronic band structure) with respect to the top of the valence band. This is a third-order tensor, with one dimension used for the spin channels, one for the $k$ points for each segment, and one for the eigenvalue sequence.",
      "dtypeStr": "f",
      "name": "band_energies_normalized",
      "shape": [
        "number_of_spin_channels",
        "number_of_normalized_k_points_per_segment",
        "number_of_normalized_band_segment_eigenvalues"
      ],
      "superNames": [
        "section_k_band_segment_normalized"
      ],
      "units": "J"
    }, {
239
      "derived": true,
240
      "description": "$k$-dependent or $q$-dependent  energies of the electronic or vibrational band segment (electronic/vibrational band structure). This is a third-order tensor, with one dimension used for the spin channels (1 in case of a vibrational band structure), one for the $k$ or $q$ points for each segment, and one for the eigenvalue sequence.",
241
242
243
244
245
246
247
248
249
250
251
      "dtypeStr": "f",
      "name": "band_energies",
      "shape": [
        "number_of_spin_channels",
        "number_of_k_points_per_segment",
        "number_of_band_segment_eigenvalues"
      ],
      "superNames": [
        "section_k_band_segment"
      ],
      "units": "J"
252
    }, {
253
      "derived": true,
254
      "description": "Fractional coordinates of the $k$ points (in the basis of the reciprocal-lattice vectors) for which the normalized electronic energies are given.",
255
      "dtypeStr": "f",
256
      "name": "band_k_points_normalized",
257
      "shape": [
258
        "number_of_normalized_k_points_per_segment",
259
        3
260
261
      ],
      "superNames": [
262
        "section_k_band_segment_normalized"
263
264
      ]
    }, {
265
      "description": "Fractional coordinates of the $k$ or $q$ points (in the basis of the reciprocal-lattice vectors) for which the electronic energy are given.",
266
      "dtypeStr": "f",
267
      "name": "band_k_points",
268
      "shape": [
Luca's avatar
Luca committed
269
        "number_of_k_points_per_segment",
270
        3
271
272
      ],
      "superNames": [
273
        "section_k_band_segment"
274
      ]
275
    }, {
276
      "derived": true,
277
      "description": "Occupation of the $k$-points along the normalized electronic band. The size of the dimensions of this third-order tensor are the same as for the tensor in band_energies.",
278
      "dtypeStr": "f",
279
      "name": "band_occupations_normalized",
280
      "shape": [
281
        "number_of_spin_channels",
282
        "number_of_normalized_k_points_per_segment",
283
        "number_of_normalized_band_segment_eigenvalues"
284
285
      ],
      "superNames": [
286
        "section_k_band_segment_normalized"
287
      ]
288
    }, {
289
      "description": "Occupation of the $k$-points along the electronic band. The size of the dimensions of this third-order tensor are the same as for the tensor in band_energies.",
290
      "dtypeStr": "f",
291
      "name": "band_occupations",
292
      "shape": [
293
        "number_of_spin_channels",
294
        "number_of_k_points_per_segment",
295
        "number_of_band_segment_eigenvalues"
296
297
      ],
      "superNames": [
298
        "section_k_band_segment"
299
      ]
300
    }, {
301
      "derived": true,
302
303
304
      "description": "Start and end labels of the points in the segment (one-dimensional pathways) sampled in the $k$-space, using the conventional symbols, e.g., Gamma, K, L. The coordinates (fractional, in the reciprocal space) of the start and end points for each segment are given in band_segm_start_end_normalized",
      "dtypeStr": "C",
      "name": "band_segm_labels_normalized",
305
      "shape": [
306
        2
307
308
309
      ],
      "superNames": [
        "section_k_band_segment_normalized"
310
      ]
311
    }, {
312
      "description": "Start and end labels of the points in the segment (one-dimensional pathways) sampled in the $k$-space or $q$-space, using the conventional symbols, e.g., Gamma, K, L. The coordinates (fractional, in the reciprocal space) of the start and end points for each segment are given in band_segm_start_end",
313
314
      "dtypeStr": "C",
      "name": "band_segm_labels",
315
      "shape": [
316
        2
317
318
      ],
      "superNames": [
319
        "section_k_band_segment"
320
      ]
321
    }, {
322
      "derived": true,
323
324
      "description": "Fractional coordinates of the start and end point (in the basis of the reciprocal lattice vectors) of the segment sampled in the $k$ space. The conventional symbols (e.g., Gamma, K, L) of the same points are given in band_segm_labels",
      "dtypeStr": "f",
325
      "name": "band_segm_start_end_normalized",
326
      "shape": [
327
328
        2,
        3
329
330
      ],
      "superNames": [
331
        "section_k_band_segment_normalized"
332
      ]
333
    }, {
334
335
      "description": "Fractional coordinates of the start and end point (in the basis of the reciprocal lattice vectors) of the segment sampled in the $k$ space. The conventional symbols (e.g., Gamma, K, L) of the same points are given in band_segm_labels",
      "dtypeStr": "f",
336
      "name": "band_segm_start_end",
337
338
339
340
341
      "shape": [
        2,
        3
      ],
      "superNames": [
342
        "section_k_band_segment"
343
      ]
344
    }, {
345
346
347
348
349
350
351
352
      "description": "String to specify the kind of band structure (either electronic or vibrational).",
      "dtypeStr": "C",
      "name": "band_structure_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_k_band"
      ]
353
    }, {
Luca's avatar
Luca committed
354
      "description": "Azimuthal quantum number ($l$) values (of the angular part given by the spherical harmonic $Y_{lm}$) of the atom-centered basis function defined in the current section_basis_set_atom_centered.",
355
356
357
358
359
360
361
362
      "dtypeStr": "i",
      "name": "basis_set_atom_centered_ls",
      "shape": [
        "number_of_kinds_in_basis_set_atom_centered"
      ],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
363
    }, {
364
      "description": "Values of the radial function of the different basis function kinds. The values are numerically tabulated on a default 0.01-nm equally spaced grid from 0 to 4 nm. The 5 tabulated values are $r$, $f(r)$, $f'(r)$, $f(r) \\cdot r$, $\\frac{d}{dr}(f(r) \\cdot r)$.",
365
366
367
368
369
370
371
372
373
374
      "dtypeStr": "f",
      "name": "basis_set_atom_centered_radial_functions",
      "shape": [
        "number_of_kinds_in_basis_set_atom_centered",
        401,
        5
      ],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
375
    }, {
376
      "description": "Code-specific, but explicative, base name for the basis set (not unique). Details are explained in the [basis_set_atom_centered_short_name wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-atom-centered-short-name), this name should not contain the *atom kind* (to simplify the use of a single name for multiple elements).",
377
378
379
380
381
382
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_short_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
383
    }, {
384
      "description": "Code-specific, but explicative, base name for the basis set (not unique). This string starts with basis_set_atom_centered_short_name. If the basis set defined in this section_basis_set_atom_centered is not identical to the default definition (stored in a database) of the basis set with the same name stored in a database, then the string is extended by 10 identifiable characters as explained in the [basis_set_atom_centered_name wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-atom-centered-unique-name). The reason for this procedure is that often atom-centered basis sets are obtained by fine tuning basis sets provided by the code developers or other sources. Each basis sets, which has normally a standard name, often reported in publications, has also several parameters that can be tuned. This metadata tries to keep track of the original basis set and its modifications. This string here defined should not contain the *atom kind* for which this basis set is intended for, in order to simplify the use of a single name for multiple *atom kinds* (see atom_labels for the actual meaning of *atom kind*).",
385
386
387
388
389
390
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_unique_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
391
    }, {
392
      "description": "Atomic number (i.e., number of protons) of the atom for which this basis set is constructed (0 means unspecified or a pseudo atom).",
393
394
395
396
397
398
      "dtypeStr": "i",
      "name": "basis_set_atom_number",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
399
    }, {
400
      "description": "A string defining the type of the cell-dependent basis set (i.e., non atom centered such as plane-waves). Allowed values are listed in the [basis_set_cell_dependent_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-cell-dependent-kind).",
401
      "dtypeStr": "C",
Luca's avatar
Luca committed
402
      "name": "basis_set_cell_dependent_kind",
403
404
405
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
406
        "section_basis_set_cell_dependent"
407
      ]
408
    }, {
409
      "description": "A label identifying the cell-dependent basis set (i.e., non atom centered such as plane-waves). Allowed values are listed in the [basis_set_cell_dependent_name wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-cell-dependent-name).",
410
      "dtypeStr": "C",
Luca's avatar
Luca committed
411
      "name": "basis_set_cell_dependent_name",
412
413
414
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
415
        "section_basis_set_cell_dependent"
416
      ]
417
    }, {
418
      "description": "One of the parts building the basis set of the system (e.g., some atom-centered basis set, plane-waves or both).",
419
420
421
422
423
      "kindStr": "type_abstract_document_content",
      "name": "basis_set_description",
      "superNames": [
        "section_run"
      ]
424
    }, {
425
      "description": "String describing the use of the basis set, i.e, if it used for expanding a wave-function or an electron density. Allowed values are listed in the [basis_set_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-kind).",
426
427
428
429
430
431
      "dtypeStr": "C",
      "name": "basis_set_kind",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
432
    }, {
433
      "description": "String identifying the basis set in an unique way. The rules for building this string are specified in the [basis_set_name wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-name).",
434
435
436
437
438
439
      "dtypeStr": "C",
      "name": "basis_set_name",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
440
    }, {
441
      "description": "Spherical cutoff  in reciprocal space for a plane-wave basis set. It is the energy of the highest plan-ewave ($\\frac{\\hbar^2|k+G|^2}{2m_e}$) included in the basis set. Note that normally this basis set is used for the wavefunctions, and the density would have 4 times the cutoff, but this actually depends on the use of the basis set by the method.",
442
      "dtypeStr": "f",
443
      "name": "basis_set_planewave_cutoff",
444
445
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
446
        "section_basis_set_cell_dependent"
447
448
      ],
      "units": "J"
449
450
    }, {
      "description": "Unique string identifying the basis set used for the final wavefunctions calculated with XC_method. It might identify a class of basis sets, often matches one of the strings given in any of basis_set_name.",
451
      "dtypeStr": "C",
452
      "name": "basis_set",
453
454
      "shape": [],
      "superNames": [
455
        "section_method"
456
      ]
457
    }, {
458
      "derived": true,
459
      "description": "String that represents the method used to calculate the energy_current. If the method is perturbative, this string does not describe the starting point method, the latter being referenced to by section_method_to_method_refs. For self-consistent field (SCF) ab initio calculations, for example, this is composed by concatenating XC_method_current and basis_set. See [calculation_method_current wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/calculation-method-current) for the details.",
460
461
462
463
464
465
466
      "dtypeStr": "C",
      "name": "calculation_method_current",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
467
    }, {
468
      "description": "Kind of method in calculation_method_current.\n\nAccepted values are:\n\n- absolute\n- perturbative.",
469
470
471
472
473
474
475
      "dtypeStr": "C",
      "name": "calculation_method_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
476
477
478
479
480
481
482
483
484
485
486
    }, {
      "derived": true,
      "description": "String that uniquely represents the method used to calculate energy_total, If the present calculation_method_current is a perturbative method Y that uses method X as starting point, this string is automatically created as X@Y, where X is taken from calculation_method_current and Y from method_to_method_ref. In order to activate this, method_to_method_kind must have the value starting_point (see the [method_to_method_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/method-to-method-kind)).",
      "dtypeStr": "C",
      "name": "calculation_method",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
    }, {
487
      "description": "URL used to reference an externally stored calculation. The kind of relationship between the present and the referenced section_single_configuration_calculation is specified by calculation_to_calculation_kind.",
488
489
      "dtypeStr": "C",
      "name": "calculation_to_calculation_external_url",
490
      "repeats": true,
491
492
493
494
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
495
    }, {
496
      "description": "String defining the relationship between the referenced section_single_configuration_calculation and the present section_single_configuration_calculation. Valid values are described in the [calculation_to_calculation_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/calculation-to-calculation-kind). Often calculations are connected, for instance, one calculation is a perturbation performed using a self-consistent field (SCF) calculation as starting point, or a simulated system is partitioned in regions with different but connected Hamiltonians (e.g., QM/MM, or a region treated via Kohn-Sham DFT embedded into a region treated via orbital-free DFT). Hence, the need of keeping track of these connected calculations. The referenced calculation is identified via calculation_to_calculation_ref (typically used for a calculation in the same section_run) or calculation_to_calculation_external_url.",
497
498
499
500
501
502
503
      "dtypeStr": "C",
      "name": "calculation_to_calculation_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
    }, {
      "description": "String defining the relationship between the referenced section_single_configuration_calculation and a folder containing calculations.",
      "dtypeStr": "C",
      "name": "calculation_to_folder_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_system_to_system_refs"
      ]
    }, {
      "description": "URL used to reference a folder containing external calculations. The kind of relationship between the present and the referenced section_single_configuration_calculation is specified by calculation_to_folder_kind.",
      "dtypeStr": "C",
      "name": "calculation_to_folder_external_url",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
522
    }, {
523
      "description": "Reference to another calculation. If both this and calculation_to_calculation_external_url are given, then calculation_to_calculation_ref is a local copy of the URL given in calculation_to_calculation_external_url. The kind of relationship between the present and the referenced section_single_configuration_calculation is specified by calculation_to_calculation_kind.",
524
525
526
527
528
      "dtypeStr": "r",
      "name": "calculation_to_calculation_ref",
      "referencedSections": [
        "section_single_configuration_calculation"
      ],
529
      "repeats": true,
530
531
532
533
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
534
    }, {
Luca's avatar
Luca committed
535
      "description": "Properties defining the current configuration.",
536
537
538
539
      "kindStr": "type_abstract_document_content",
      "name": "configuration_core",
      "repeats": false,
      "superNames": [
Luca's avatar
Luca committed
540
        "section_system"
541
      ]
542
    }, {
543
      "description": "Array labeling which of the lattice vectors use periodic boundary conditions. Note for the parser developers: This value is not expected to be given for each section_single_configuration_calculation. It is assumed to be valid from the section_single_configuration_calculation where it is defined for all subsequent section_single_configuration_calculation in section_run, until redefined.",
544
545
546
547
548
549
550
551
552
      "dtypeStr": "b",
      "name": "configuration_periodic_dimensions",
      "repeats": true,
      "shape": [
        3
      ],
      "superNames": [
        "configuration_core"
      ]
553
    }, {
554
555
556
557
558
559
      "description": "A quantity that is preserved during the time propagation (for example, kinetic+potential energy during NVE).",
      "kindStr": "type_abstract_document_content",
      "name": "conserved_quantity",
      "repeats": false,
      "shape": [],
      "superNames": []
560
561
562
    }, {
      "derived": true,
      "description": "Array containing the set of discrete energy values with respect to the top of the valence band for the density (electronic-energy) of states (DOS). This is the total DOS, see atom_projected_dos_energies and species_projected_dos_energies for partial density of states.",
563
      "dtypeStr": "f",
564
      "name": "dos_energies_normalized",
565
566
567
568
569
570
571
      "shape": [
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
572
573
    }, {
      "description": "Array containing the set of discrete energy values for the density (electronic-energy or vibrational energy) of states (DOS). This is the total DOS, see atom_projected_dos_energies and species_projected_dos_energies for partial density of states.",
574
      "dtypeStr": "f",
575
      "name": "dos_energies",
576
      "shape": [
Luca's avatar
Luca committed
577
        "number_of_dos_values"
578
579
580
581
582
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
583
    }, {
584
      "description": "Stores the Fermi energy of the density of states.",
585
      "dtypeStr": "f",
586
      "name": "dos_fermi_energy",
587
588
589
590
      "shape": [],
      "superNames": [
        "section_dos"
      ]
591
    }, {
592
      "description": "Integrated density of states (starting at $-\\infty$), pseudo potential calculations should start with the number of core electrons if they cover only the active electrons",
593
594
595
596
597
598
599
600
601
      "dtypeStr": "f",
      "name": "dos_integrated_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ]
602
    }, {
603
604
605
606
607
608
609
610
      "description": "String to specify the kind of density of states (either electronic or vibrational).",
      "dtypeStr": "C",
      "name": "dos_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_dos"
      ]
611
    }, {
612
      "description": "Tuples of $l$ and $m$ values for which dos_values_lm are given. For the quantum number $l$ the conventional meaning of azimuthal quantum number is always adopted. For the integer number $m$, besides the conventional use as magnetic quantum number ($l+1$ integer values from $-l$ to $l$), a set of different conventions is accepted (see the [m_kind wiki page](https://gitlab.rzg.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/m-kind). The actual adopted convention is specified by dos_m_kind.",
613
614
615
616
617
618
619
620
621
      "dtypeStr": "i",
      "name": "dos_lm",
      "shape": [
        "number_of_dos_lms",
        2
      ],
      "superNames": [
        "section_dos"
      ]
622
    }, {
623
      "description": "String describing what the integer numbers of $m$ in dos_lm mean. The allowed values are listed in the [m_kind wiki page](https://gitlab.rzg.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/m-kind).",
624
625
626
627
628
629
      "dtypeStr": "C",
      "name": "dos_m_kind",
      "shape": [],
      "superNames": [
        "section_dos"
      ]
630
631
    }, {
      "description": "Array containing the density (electronic-energy) of states values projected on the various spherical harmonics (integrated on all atoms), see atom_projected_dos_values_lm for atom values.",
632
      "dtypeStr": "f",
633
      "name": "dos_values_lm",
634
      "shape": [
635
        "number_of_dos_lms",
636
        "number_of_spin_channels",
637
        "number_of_atoms",
638
639
640
641
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
642
643
644
645
      ],
      "units": "J"
    }, {
      "description": "Values (number of states for a given energy, the set of discrete energy values is given in dos_energies) of density (electronic-energy or vibrational-energy) of states.",
646
      "dtypeStr": "f",
647
      "name": "dos_values",
648
      "shape": [
Luca's avatar
Luca committed
649
        "number_of_spin_channels",
Luca's avatar
Luca committed
650
        "number_of_dos_values"
651
652
653
      ],
      "superNames": [
        "section_dos"
654
655
      ]
    }, {
656
      "description": "A short string describing the kind of eigenvalues, as defined in the [eigenvalues_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/eigenvalues-kind).",
657
658
659
660
661
662
      "dtypeStr": "C",
      "name": "eigenvalues_kind",
      "shape": [],
      "superNames": [
        "section_eigenvalues"
      ]
663
664
    }, {
      "description": "Multiplicity of the $k$ point (i.e., how many distinct points per cell this expands to after applying all symmetries). This defaults to 1. If expansion is preformed then each point will have weight eigenvalues_kpoints_weights/eigenvalues_kpoints_multiplicity.",
665
      "dtypeStr": "f",
666
      "name": "eigenvalues_kpoints_multiplicity",
667
      "shape": [
668
        "number_of_eigenvalues_kpoints"
669
670
671
672
      ],
      "superNames": [
        "section_eigenvalues"
      ]
673
674
    }, {
      "description": "Weights of the $k$ points (in the basis of the reciprocal lattice vectors) used for the evaluation of the eigenvalues tabulated in eigenvalues_values, should account for symmetry too.",
675
      "dtypeStr": "f",
676
      "name": "eigenvalues_kpoints_weights",
677
678
679
680
681
682
      "shape": [
        "number_of_eigenvalues_kpoints"
      ],
      "superNames": [
        "section_eigenvalues"
      ]
683
684
    }, {
      "description": "Coordinates of the $k$ points (in the basis of the reciprocal lattice vectors) used for the evaluation of the eigenvalues tabulated in eigenvalues_values.",
685
      "dtypeStr": "f",
686
      "name": "eigenvalues_kpoints",
687
      "shape": [
688
689
        "number_of_eigenvalues_kpoints",
        3
690
691
692
693
      ],
      "superNames": [
        "section_eigenvalues"
      ]
694
    }, {
695
      "description": "Occupation of the eigenstates. The corresponding eigenvalues (energy) are given in eigenvalues_values. The coordinates in the reciprocal space are defined in eigenvalues_kpoints.",
696
697
698
      "dtypeStr": "f",
      "name": "eigenvalues_occupation",
      "shape": [
Luca's avatar
Luca committed
699
        "number_of_spin_channels",
700
701
702
703
704
705
        "number_of_eigenvalues_kpoints",
        "number_of_eigenvalues"
      ],
      "superNames": [
        "section_eigenvalues"
      ]
706
    }, {
707
      "description": "Values of the (electronic-energy) eigenvalues. The coordinates of the corresponding eigenstates in the reciprocal space are defined in eigenvalues_kpoints and their occupations are given in eigenvalues_occupation.",
Luca's avatar
Luca committed
708
709
710
711
712
713
714
715
716
717
718
      "dtypeStr": "f",
      "name": "eigenvalues_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_eigenvalues_kpoints",
        "number_of_eigenvalues"
      ],
      "superNames": [
        "section_eigenvalues"
      ],
      "units": "J"
719
720
    }, {
      "description": "Electronic kinetic energy as defined in XC_method during the self-consistent field (SCF) iterations.",
721
      "dtypeStr": "f",
722
      "name": "electronic_kinetic_energy_scf_iteration",
723
724
725
726
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
727
        "section_scf_iteration"
728
729
      ],
      "units": "J"
730
731
    }, {
      "description": "Self-consistent electronic kinetic energy as defined in XC_method.",
732
      "dtypeStr": "f",
733
      "name": "electronic_kinetic_energy",
734
735
736
737
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
738
        "section_single_configuration_calculation"
739
740
      ],
      "units": "J"
741
    }, {
742
743
744
      "description": "Non-unique string identifying the used electronic structure method. It is not unique in the sense that two calculations with the same electronic_structure_method string may have not been performed with exactly the same method. The allowed strings are given in the [electronic structure method wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/electronic-structure-method).",
      "dtypeStr": "C",
      "name": "electronic_structure_method",
745
746
747
      "repeats": false,
      "shape": [],
      "superNames": [
748
749
        "settings_XC"
      ]
750
    }, {
751
      "description": "Correlation (C) energy calculated with the method described in XC_functional.",
752
753
754
755
756
757
758
759
      "dtypeStr": "f",
      "name": "energy_C",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_type_C"
      ],
      "units": "J"
760
    }, {
761
      "description": "Stores the change of total energy with respect to the previous self-consistent field (SCF) iteration.",
762
763
764
765
766
      "dtypeStr": "f",
      "name": "energy_change_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
767
        "error_estimate_contribution",
768
769
770
771
        "section_scf_iteration",
        "energy_value"
      ],
      "units": "J"
772
    }, {
773
      "description": "Type of the code-independent total energy (obtained by subtracting a reference energy calculated with the same code), created to be comparable among different codes and numerical settings. Details can be found on the [energy_code_independent wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/energy-code-independent).",
774
      "dtypeStr": "C",
Luca's avatar
Luca committed
775
      "name": "energy_code_independent_kind",
776
777
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
778
        "section_energy_code_independent"
779
      ]
780
    }, {
781
      "description": "Value of the code-independent total energy (obtained by subtracting a reference energy calculated with the same code). This value is created to be comparable among different codes and numerical settings. Details can be found on the [energy_code_independent wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/energy-code-independent).",
782
      "dtypeStr": "f",
Luca's avatar
Luca committed
783
      "name": "energy_code_independent_value",
784
785
786
      "shape": [],
      "superNames": [
        "energy_total_potential",
Luca's avatar
Luca committed
787
        "section_energy_code_independent"
788
789
      ],
      "units": "J"
790
791
    }, {
      "description": "A value of an energy component per atom, concurring in defining the total energy per atom.",
792
      "kindStr": "type_abstract_document_content",
793
      "name": "energy_component_per_atom",
794
795
796
797
      "shape": [],
      "superNames": [
        "energy_value"
      ]
798
799
    }, {
      "description": "A value of an energy component, expected to be an extensive property.",
800
      "kindStr": "type_abstract_document_content",
801
      "name": "energy_component",
802
803
804
805
      "shape": [],
      "superNames": [
        "energy_value"
      ]
806
807
    }, {
      "description": "Entropy correction to the potential energy to compensate for the change in occupation so that forces at finite T do not need to keep the change of occupation in account. The array lists the values of the entropy correction for each self-consistent field (SCF) iteration. Defined consistently with XC_method.",
808
809
810
811
812
813
814
815
816
      "dtypeStr": "f",
      "name": "energy_correction_entropy_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
817
818
    }, {
      "description": "Entropy correction to the potential energy to compensate for the change in occupation so that forces at finite T do not need to keep the change of occupation in account. Defined consistently with XC_method.",
819
      "dtypeStr": "f",
820
      "name": "energy_correction_entropy",
821
822
823
824
825
826
827
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_single_configuration_calculation"
      ],
      "units": "J"
828
    }, {
Luca's avatar
Luca committed
829
      "description": "Correction to the density-density electrostatic energy in the sum of eigenvalues (that uses the mixed density on one side), and the fully consistent density-density electrostatic energy during the self-consistent field (SCF) iterations. Defined consistently with XC_method.",
830
831
832
833
834
835
836
837
838
      "dtypeStr": "f",
      "name": "energy_correction_hartree_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
839
840
    }, {
      "description": "Correction to the density-density electrostatic energy in the sum of eigenvalues (that uses the mixed density on one side), and the fully consistent density-density electrostatic energy. Defined consistently with XC_method.",
841
      "dtypeStr": "f",
842
      "name": "energy_correction_hartree",
843
844
845
      "repeats": false,
      "shape": [],
      "superNames": [
846
        "energy_component",
847
848
849
        "section_single_configuration_calculation"
      ],
      "units": "J"
850
851
    }, {
      "description": "Value of the energy calculated with calculation_method_current. energy_current is equal to energy_total for non-perturbative methods. For perturbative methods, energy_current is equal to the correction: energy_total minus energy_total of the calculation_to_calculation_ref with calculation_to_calculation_kind = starting_point (see the [method_to_method_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/method-to-method-kind)). See also [energy_current wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/energy-current).",
852
      "dtypeStr": "f",
853
      "name": "energy_current",
854
855
856
      "repeats": false,
      "shape": [],
      "superNames": [
857
        "energy_total_potential",
858
859
860
        "section_single_configuration_calculation"
      ],
      "units": "J"
861
    }, {
862
      "derived": true,
863
      "description": "Total electrostatic energy (nuclei + electrons) during each self-consistent field (SCF) iteration.",
864
865
866
867
868
869
870
871
872
      "dtypeStr": "f",
      "name": "energy_electrostatic_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
873
874
    }, {
      "description": "Total electrostatic energy (nuclei + electrons), defined consistently with calculation_method.",
875
      "dtypeStr": "f",
876
      "name": "energy_electrostatic",
877
878
879
      "repeats": false,
      "shape": [],
      "superNames": [
880
        "energy_component",
881
882
883
        "section_single_configuration_calculation"
      ],
      "units": "J"
884
885
    }, {
      "description": "Free energy per atom (whose minimum gives the smeared occupation density calculated with smearing_kind) calculated with XC_method during the self-consistent field (SCF) iterations.",
886
      "dtypeStr": "f",
887
      "name": "energy_free_per_atom_scf_iteration",
888
889
890
891
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component_per_atom",
892
        "section_scf_iteration"
893
894
      ],
      "units": "J"
895
896
897
    }, {
      "derived": true,
      "description": "Free energy per atom (whose minimum gives the smeared occupation density calculated with smearing_kind) calculated with XC_method.",
898
      "dtypeStr": "f",
899
      "name": "energy_free_per_atom",
900
901
902
903
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component_per_atom",
904
        "section_single_configuration_calculation"
905
906
      ],
      "units": "J"
907
    }, {
908
      "description": "Free energy (whose minimum gives the smeared occupation density calculated with smearing_kind) calculated with the method described in XC_method during the self-consistent field (SCF) iterations.",
909
910
911
912
913
914
915
916
917
      "dtypeStr": "f",
      "name": "energy_free_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_total_potential",
        "section_scf_iteration"
      ],
      "units": "J"
918
919
    }, {
      "description": "Free energy (nuclei + electrons) (whose minimum gives the smeared occupation density calculated with smearing_kind) calculated with the method described in XC_method.",
920
      "dtypeStr": "f",
921
      "name": "energy_free",
922
923
924
      "repeats": false,
      "shape": [],
      "superNames": [
925
926
        "energy_total_potential",
        "section_single_configuration_calculation"
927
928
      ],
      "units": "J"
929
    }, {
930
      "description": "Error in the Hartree (electrostatic) potential energy during each self-consistent field (SCF) iteration. Defined consistently with XC_method.",
931
932
933
934
935
      "dtypeStr": "f",
      "name": "energy_hartree_error_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
936
        "error_estimate_contribution",