public.nomadmetainfo.json 156 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
5
  "metaInfos": [
    {
6
7
8
9
      "description": "Information that *in theory* should have no influence on the results.",
      "kindStr": "type_abstract_document_content",
      "name": "accessory_info",
      "superNames": []
10
11
12
    },
    {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total, including forces' unitary-transformation (rigid body) filtering and 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 (translations of the center of mass and, when the system is non-periodic, rigid rotations); see atom_forces_raw for the unfiltered counterpart. Furthermore, forces due to constraints such as fixed atoms, distances, angles, dihedrals, and so on, are here included (see atom_forces_raw for the unfiltered counterpart).",
13
      "dtypeStr": "f",
14
      "name": "atom_forces",
15
16
17
18
19
20
21
22
23
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
24
25
    },
    {
Luca's avatar
Luca committed
26
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_free, including forces' unitary-transformation (rigid body) filtering and 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 conserved energy quantity. In addition, these forces are obtained by filtering out the unitary transformations (translations of the center of mass and, when the system is non-periodic, rigid rotations); see atom_forces_free_raw for the unfiltered counterpart. Furthermore, forces due to constraints such as fixed atoms, distances, angles, dihedrals, and so on, are here included (see atom_forces_free_raw for the unfiltered counterpart).",
27
28
29
30
31
32
33
34
35
36
37
      "dtypeStr": "f",
      "name": "atom_forces_free",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
38
39
40
    },
    {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_free, without forces' unitary-transformation (rigid body) filtering and without constraints. 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 conserved energy quantity. These forces may contain unitary transformations (translations of the center of mass and, when the system is non-periodic, rigid rotations) that are normally filtered separately (in atom_forces_free); forces due to constraints such as fixed atoms, distances, angles, dihedrals, and so on, are also considered separately (in atom_forces_free).",
41
      "dtypeStr": "f",
42
      "name": "atom_forces_free_raw",
43
44
45
46
47
48
49
50
51
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
52
53
54
    },
    {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total, without forces' unitary-transformation (rigid body) filtering and without constraints. The derivatives with respect to displacements of the nuclei are evaluated in Cartesian coordinates. These forces may contain unitary transformations (translations of the center of mass and, when the system is non-periodic, rigid rotations) that are normally filtered separately (in atom_forces); forces due to constraints such as fixed atoms, distances, angles, dihedrals, and so on, are also considered separately (in atom_forces).",
55
      "dtypeStr": "f",
56
      "name": "atom_forces_raw",
57
58
59
60
61
62
63
64
65
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
66
67
    },
    {
Luca's avatar
Luca committed
68
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total_T0, including forces' unitary-transformation (rigid body) filtering and 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 (translations of the center of mass and, when the system is non-periodic, rigid rotations); see atom_forces_free_T0_raw for the unfiltered counterpart. Furthermore, forces due to constraints such as fixed atoms, distances, angles, dihedrals, and so on, are here included (see atom_forces_free_T0_raw for the unfiltered counterpart).",
69
70
71
72
73
74
75
76
77
78
79
      "dtypeStr": "f",
      "name": "atom_forces_T0",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
80
81
82
    },
    {
      "description": "Forces acting on the atoms, calculated as minus gradient of energy_total_T0, without forces' unitary-transformation (rigid body) filtering and without constraints. The derivatives with respect to displacements of the nuclei are evaluated in Cartesian coordinates. These forces may contain unitary transformations (translations of the center of mass and, when the system is non-periodic, rigid rotations) that are normally filtered separately (in atom_forces_T0); forces due to constraints such as fixed atoms, distances, angles, dihedrals, and so on, are also considered separately (in atom_forces_T0).",
83
      "dtypeStr": "f",
84
      "name": "atom_forces_T0_raw",
85
86
87
88
89
90
91
92
93
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
94
95
96
97
98
99
100
101
102
103
104
105
    },
    {
      "description": "Some forces on the atoms (i.e. minus derivatives of some energy with respect to the atom position).",
      "dtypeStr": "f",
      "kindStr": "type_abstract_document_content",
      "name": "atom_forces_type",
      "repeats": true,
      "superNames": [
        "section_single_configuration_calculation"
      ]
    },
    {
Luca's avatar
Luca committed
106
      "description": "Labels of the atoms. These strings identify the atom kind and conventionally start with the symbol of the atomic species, possibly followed by a number. The same atomic species can be labelled 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 pseudopotentials, 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.",
107
      "dtypeStr": "C",
Luca's avatar
Luca committed
108
      "name": "atom_labels",
109
110
111
112
113
114
      "shape": [
        "number_of_atoms"
      ],
      "superNames": [
        "configuration_core"
      ]
115
116
    },
    {
Luca's avatar
Luca committed
117
      "description": "Positions of all the atoms, in Cartesian coordinates. This metadata defines a configuration and is therefore required.",
118
      "dtypeStr": "f",
Luca's avatar
Luca committed
119
      "name": "atom_positions",
120
121
122
123
124
125
126
127
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "configuration_core"
      ],
      "units": "m"
128
129
    },
    {
Luca's avatar
Luca committed
130
      "description": "Array containing the set of discrete energy values for the atom-projected density of (electronic-energy) states (DOS).",
131
132
133
      "dtypeStr": "f",
      "name": "atom_projected_dos_energies",
      "shape": [
Luca's avatar
Luca committed
134
        "number_of_atom_projected_dos_values"
135
136
137
138
139
      ],
      "superNames": [
        "section_atom_projected_dos"
      ],
      "units": "J"
140
141
    },
    {
142
      "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 actual adopted convention is specified by atom_projected_dos_m_kind.",
143
144
145
146
147
148
149
150
151
      "dtypeStr": "i",
      "name": "atom_projected_dos_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
        2
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
152
153
    },
    {
Luca's avatar
Luca committed
154
      "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).",
155
156
157
158
159
160
      "dtypeStr": "C",
      "name": "atom_projected_dos_m_kind",
      "shape": [],
      "superNames": [
        "section_atom_projected_dos"
      ]
161
162
    },
    {
Luca's avatar
Luca committed
163
      "description": "Values (number of states for a given energy, the set of discrete energy values is given in atom_projected_dos_energies) of the atom-projected density of (electronic-energy) states, divided into contributions from each $l,m$ channel. Here, there are as many atom-projected DOS as the number_of_atoms, the list of labels of the atoms is in atom_labels, see atom_labels for what it is meant by *atom label*.",
164
165
166
167
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
Luca's avatar
Luca committed
168
        "number_of_spin_channels",
169
        "number_of_atoms",
Luca's avatar
Luca committed
170
        "number_of_atom_projected_dos_values"
171
172
173
174
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
175
176
    },
    {
Luca's avatar
Luca committed
177
      "description": "Values (number of states for a given energy, the set of discrete energy values is given in atom_projected_dos_energies) of the atom-projected density of (electronic-energy) states (DOS), summed up over all $l$ channels. Here, there are as many atom-projected DOS as the number_of_atoms, the list of labels of the atoms is in atom_labels, see atom_labels for what it is meant by *atom label*.",
178
179
180
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_total",
      "shape": [
Luca's avatar
Luca committed
181
        "number_of_spin_channels",
182
        "number_of_atoms",
Luca's avatar
Luca committed
183
        "number_of_atom_projected_dos_values"
184
185
186
187
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
188
189
    },
    {
Luca's avatar
Luca committed
190
      "description": "Velocities of the nuclei, defined as the change in Cartesian coordinates of the nuclei with respect to time.",
191
192
193
194
195
196
197
198
      "dtypeStr": "f",
      "name": "atom_velocities",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
Luca's avatar
Luca committed
199
        "section_system"
200
201
      ],
      "units": "m/s"
202
203
    },
    {
Luca's avatar
Luca committed
204
      "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).",
205
206
207
208
209
210
      "dtypeStr": "C",
      "name": "atomic_multipole_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
211
212
    },
    {
213
      "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.",
214
215
216
217
218
219
220
221
222
      "dtypeStr": "i",
      "name": "atomic_multipole_lm",
      "shape": [
        "number_of_lm_atomic_multipoles",
        2
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
223
224
    },
    {
Luca's avatar
Luca committed
225
      "description": "String describing what the integer numbers $m$ in atomic_multipole_lm mean. Allowed values are listed in the [m\\_kind wiki page](https://gitlab.rzg.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/m-kind).",
226
227
228
229
230
231
      "dtypeStr": "C",
      "name": "atomic_multipole_m_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
232
233
    },
    {
Luca's avatar
Luca committed
234
      "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.",
235
      "dtypeStr": "f",
Luca's avatar
Luca committed
236
      "name": "atomic_multipole_values",
237
238
239
240
241
242
243
      "shape": [
        "number_of_lm_atomic_multipoles",
        "number_of_atoms"
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
    },
    {
      "derived": true,
      "description": "$k$-dependent energies of the electronic band segment (electronic band structure). 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",
      "shape": [
        "number_of_spin_channels",
        "number_of_k_points_per_segment",
        "number_of_band_segment_eigenvalues"
      ],
      "superNames": [
        "section_k_band_segment"
      ],
      "units": "J"
    },
    {
261
      "derived": true,
262
263
264
      "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",
265
      "shape": [
Luca's avatar
Luca committed
266
        "number_of_spin_channels",
267
268
        "number_of_normalized_k_points_per_segment",
        "number_of_normalized_band_segment_eigenvalues"
269
270
      ],
      "superNames": [
271
        "section_k_band_segment_normalized"
272
273
      ],
      "units": "J"
274
275
276
    },
    {
      "description": "Fractional coordinates of the $k$ points (in the basis of the reciprocal-lattice vectors) for which the electronic energy are given.",
277
      "dtypeStr": "f",
278
      "name": "band_k_points",
279
      "shape": [
Luca's avatar
Luca committed
280
        "number_of_k_points_per_segment",
281
        3
282
283
      ],
      "superNames": [
284
        "section_k_band_segment"
285
286
287
      ]
    },
    {
288
289
290
291
      "derived": true,
      "description": "Fractional coordinates of the $k$ points (in the basis of the reciprocal-lattice vectors) for which the normalized electronic energies are given.",
      "dtypeStr": "f",
      "name": "band_k_points_normalized",
292
      "shape": [
293
294
        "number_of_normalized_k_points_per_segment",
        3
295
296
      ],
      "superNames": [
297
        "section_k_band_segment_normalized"
298
      ]
299
300
301
    },
    {
      "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",
302
      "dtypeStr": "f",
303
      "name": "band_occupations",
304
      "shape": [
305
        "number_of_spin_channels",
306
        "number_of_k_points_per_segment",
307
        "number_of_band_segment_eigenvalues"
308
309
      ],
      "superNames": [
310
        "section_k_band_segment"
311
      ]
312
313
    },
    {
314
      "derived": true,
315
316
317
      "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",
      "dtypeStr": "f",
      "name": "band_occupations_normalized",
318
319
320
321
322
323
324
      "shape": [
        "number_of_spin_channels",
        "number_of_normalized_k_points_per_segment",
        "number_of_normalized_band_segment_eigenvalues"
      ],
      "superNames": [
        "section_k_band_segment_normalized"
325
      ]
326
327
328
329
330
    },
    {
      "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",
      "dtypeStr": "C",
      "name": "band_segm_labels",
331
      "shape": [
332
        2
333
334
      ],
      "superNames": [
335
        "section_k_band_segment"
336
      ]
337
338
    },
    {
339
      "derived": true,
340
341
342
      "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",
343
      "shape": [
344
        2
345
346
      ],
      "superNames": [
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
347
        "section_k_band_segment_normalized"
348
      ]
349
350
351
352
353
    },
    {
      "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",
      "name": "band_segm_start_end",
354
      "shape": [
355
356
        2,
        3
357
358
      ],
      "superNames": [
359
        "section_k_band_segment"
360
      ]
361
362
    },
    {
363
      "derived": true,
364
365
366
367
368
369
370
371
372
373
      "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",
      "name": "band_segm_start_end_normalized",
      "shape": [
        2,
        3
      ],
      "superNames": [
        "section_k_band_segment_normalized"
      ]
374
375
376
377
378
379
    },
    {
      "description": "String identifying in an unique way 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.",
      "dtypeStr": "C",
      "name": "basis_set",
      "shape": [],
380
      "superNames": [
381
        "section_method"
382
      ]
383
384
    },
    {
Luca's avatar
Luca committed
385
      "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.",
386
387
388
389
390
391
392
393
      "dtypeStr": "i",
      "name": "basis_set_atom_centered_ls",
      "shape": [
        "number_of_kinds_in_basis_set_atom_centered"
      ],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
394
395
    },
    {
396
      "description": "Values of the radial function of the different basis function kinds. The values are numerically tabulated on a default 0.01-nm equispaced grid from 0 to 4 nm. The 5 tabulated values are $r$, $f(r)$, $f'(r)$, $f(r)*r$, $\\frac{d}{dr}(f(r)*r)$.",
397
398
399
400
401
402
403
404
405
406
      "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"
      ]
407
408
    },
    {
409
      "description": "Code-specific, but explicative, base name of 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).",
410
411
412
413
414
415
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_short_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
416
417
    },
    {
Luca's avatar
Luca committed
418
      "description": "Code-specific, explicative and unique name of the basis set. 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 identificative 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*).",
419
420
421
422
423
424
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_unique_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
425
426
    },
    {
Luca's avatar
Luca committed
427
      "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).",
428
429
430
431
432
433
      "dtypeStr": "i",
      "name": "basis_set_atom_number",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
434
435
    },
    {
Luca's avatar
Luca committed
436
      "description": "A string defining the type of the cell-dependent basis set (i.e., non atom centered, e.g., planewaves). 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).",
437
      "dtypeStr": "C",
Luca's avatar
Luca committed
438
      "name": "basis_set_cell_dependent_kind",
439
440
441
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
442
        "section_basis_set_cell_dependent"
443
      ]
444
445
    },
    {
Luca's avatar
Luca committed
446
      "description": "A label identifying the cell-dependent basis set (i.e., non atom centered, like planewaves). 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).",
447
      "dtypeStr": "C",
Luca's avatar
Luca committed
448
      "name": "basis_set_cell_dependent_name",
449
450
451
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
452
        "section_basis_set_cell_dependent"
453
      ]
454
455
    },
    {
Luca's avatar
Luca committed
456
      "description": "One of the parts building the basis set of the system (e.g., some atom-centered basis set and/or planewaves).",
457
458
459
460
461
      "kindStr": "type_abstract_document_content",
      "name": "basis_set_description",
      "superNames": [
        "section_run"
      ]
462
463
    },
    {
Luca's avatar
Luca committed
464
      "description": "String describing the use of the basis set, i.e, if it used for expanding a wavefunction 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).",
465
466
467
468
469
470
      "dtypeStr": "C",
      "name": "basis_set_kind",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
471
472
    },
    {
Luca's avatar
Luca committed
473
      "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).",
474
475
476
477
478
479
      "dtypeStr": "C",
      "name": "basis_set_name",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
480
481
    },
    {
Luca's avatar
Luca committed
482
      "description": "Spherical cutoff  in reciprocal space for a planewave basis set. It is the energy of the highest planewave ($\\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.",
483
      "dtypeStr": "f",
484
      "name": "basis_set_planewave_cutoff",
485
486
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
487
        "section_basis_set_cell_dependent"
488
489
      ],
      "units": "J"
490
491
492
493
    },
    {
      "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)).",
494
      "dtypeStr": "C",
495
496
      "name": "calculation_method",
      "repeats": false,
497
498
      "shape": [],
      "superNames": [
499
        "section_method"
500
      ]
501
502
    },
    {
503
      "derived": true,
Luca's avatar
Luca committed
504
      "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 calculation, 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.",
505
506
507
508
509
510
511
      "dtypeStr": "C",
      "name": "calculation_method_current",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
512
513
    },
    {
Luca's avatar
Luca committed
514
      "description": "Kind of method in calculation_method_current. Accepted values are: absolute, perturbative.",
515
516
517
518
519
520
521
      "dtypeStr": "C",
      "name": "calculation_method_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
522
523
    },
    {
524
      "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.",
525
526
527
528
529
530
531
      "dtypeStr": "C",
      "name": "calculation_to_calculation_external_url",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
532
533
    },
    {
Luca's avatar
Luca committed
534
      "description": "String defining the kind of relationship that the referenced section_single_configuration_calculation has with 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.",
535
536
537
538
539
540
541
      "dtypeStr": "C",
      "name": "calculation_to_calculation_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
542
543
    },
    {
544
      "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.",
545
546
547
548
549
550
551
552
553
554
      "dtypeStr": "r",
      "name": "calculation_to_calculation_ref",
      "referencedSections": [
        "section_single_configuration_calculation"
      ],
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
555
556
    },
    {
Luca's avatar
Luca committed
557
      "description": "Properties defining the current configuration.",
558
559
560
561
      "kindStr": "type_abstract_document_content",
      "name": "configuration_core",
      "repeats": false,
      "superNames": [
Luca's avatar
Luca committed
562
        "section_system"
563
      ]
564
565
    },
    {
Luca's avatar
Luca committed
566
      "description": "Array labelling 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.",
567
568
569
570
571
572
573
574
575
      "dtypeStr": "b",
      "name": "configuration_periodic_dimensions",
      "repeats": true,
      "shape": [
        3
      ],
      "superNames": [
        "configuration_core"
      ]
576
577
    },
    {
578
579
580
581
582
583
      "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": []
584
585
586
    },
    {
      "description": "Array containing the set of discrete energy values for the density of (electronic-energy) states (DOS). This is the total DOS, see atom_projected_dos_energies and species_projected_dos_energies for partial DOS's.",
587
      "dtypeStr": "f",
588
      "name": "dos_energies",
589
590
591
592
593
594
595
      "shape": [
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
596
597
598
599
    },
    {
      "derived": true,
      "description": "Array containing the set of discrete energy values with respect to the top of the valence band for the density of (electronic-energy) states (DOS). This is the total DOS, see atom_projected_dos_energies and species_projected_dos_energies for partial DOS's.",
600
      "dtypeStr": "f",
601
      "name": "dos_energies_normalized",
602
      "shape": [
Luca's avatar
Luca committed
603
        "number_of_dos_values"
604
605
606
607
608
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
609
610
    },
    {
611
612
      "description": "Fermi energy",
      "dtypeStr": "f",
613
      "name": "dos_fermi_energy",
614
615
616
617
      "shape": [],
      "superNames": [
        "section_dos"
      ]
618
619
    },
    {
620
621
622
623
624
625
626
627
628
629
      "description": "Integrated dos (starting at -Infinity), pseudo potential calculations should start with the number of core electrons if they cover only the active electrons",
      "dtypeStr": "f",
      "name": "dos_integrated_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ]
630
631
    },
    {
632
633
634
635
636
637
638
639
640
641
      "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.",
      "dtypeStr": "i",
      "name": "dos_lm",
      "shape": [
        "number_of_dos_lms",
        2
      ],
      "superNames": [
        "section_dos"
      ]
642
643
    },
    {
644
645
646
647
648
649
650
      "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).",
      "dtypeStr": "C",
      "name": "dos_m_kind",
      "shape": [],
      "superNames": [
        "section_dos"
      ]
651
652
653
    },
    {
      "description": "Values (number of states for a given energy, the set of discrete energy values is given in dos_energies) of Density of (electronic-energy) states (DOS).",
654
      "dtypeStr": "f",
655
      "name": "dos_values",
656
657
658
659
660
661
      "shape": [
        "number_of_spin_channels",
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
662
663
664
665
      ]
    },
    {
      "description": "Array containing the density of (electronic-energy) states (DOS) values projected on the various spherical harmonics (integrated on all atoms), see atom_projected_dos_values_lm for atom values.",
666
      "dtypeStr": "f",
667
      "name": "dos_values_lm",
668
      "shape": [
669
        "number_of_dos_lms",
Luca's avatar
Luca committed
670
        "number_of_spin_channels",
671
        "number_of_atoms",
Luca's avatar
Luca committed
672
        "number_of_dos_values"
673
674
675
      ],
      "superNames": [
        "section_dos"
676
677
678
679
      ],
      "units": "J"
    },
    {
680
681
682
683
684
685
686
      "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).",
      "dtypeStr": "C",
      "name": "eigenvalues_kind",
      "shape": [],
      "superNames": [
        "section_eigenvalues"
      ]
687
688
689
    },
    {
      "description": "Coordinates of the $k$ points (in the basis of the reciprocal lattice vectors) at which the eigenvalues tabulated in eigenvalues_values are evaluated.",
690
      "dtypeStr": "f",
691
      "name": "eigenvalues_kpoints",
692
      "shape": [
693
694
        "number_of_eigenvalues_kpoints",
        3
695
696
697
698
      ],
      "superNames": [
        "section_eigenvalues"
      ]
699
700
701
    },
    {
      "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.",
702
      "dtypeStr": "f",
703
      "name": "eigenvalues_kpoints_multiplicity",
704
705
706
707
708
709
      "shape": [
        "number_of_eigenvalues_kpoints"
      ],
      "superNames": [
        "section_eigenvalues"
      ]
710
711
712
    },
    {
      "description": "Weights of the $k$ points (in the basis of the reciprocal lattice vectors) at which the eigenvalues tabulated in eigenvalues_values are evaluated, should keep into account the symmetry too.",
713
      "dtypeStr": "f",
714
      "name": "eigenvalues_kpoints_weights",
715
      "shape": [
716
        "number_of_eigenvalues_kpoints"
717
718
719
720
      ],
      "superNames": [
        "section_eigenvalues"
      ]
721
722
    },
    {
Luca's avatar
Luca committed
723
      "description": "Occupation of the eigenstates whose coordinate in the reciprocal space are defined in eigenvalues_kpoints and whose (energy) eigenvalues are given in eigenvalues_values.",
724
725
726
      "dtypeStr": "f",
      "name": "eigenvalues_occupation",
      "shape": [
Luca's avatar
Luca committed
727
        "number_of_spin_channels",
728
729
730
731
732
733
        "number_of_eigenvalues_kpoints",
        "number_of_eigenvalues"
      ],
      "superNames": [
        "section_eigenvalues"
      ]
734
735
    },
    {
Luca's avatar
Luca committed
736
737
738
739
740
741
742
743
744
745
746
747
      "description": "Values of the (electronic-energy) eigenvalues. The coordinates of the corresponding eigenstates in the reciprocal space are defined in eigenvalues_kpoints and their occupation are given in eigenvalues_occupation.",
      "dtypeStr": "f",
      "name": "eigenvalues_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_eigenvalues_kpoints",
        "number_of_eigenvalues"
      ],
      "superNames": [
        "section_eigenvalues"
      ],
      "units": "J"
748
749
750
    },
    {
      "description": "Self-consistent electronic kinetic energy as defined in XC_method.",
751
      "dtypeStr": "f",
752
      "name": "electronic_kinetic_energy",
753
754
755
756
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
757
        "section_single_configuration_calculation"
758
759
      ],
      "units": "J"
760
761
762
    },
    {
      "description": "Electronic kinetic energy as defined in XC_method during the self-consistent field (SCF) iterations.",
763
      "dtypeStr": "f",
764
      "name": "electronic_kinetic_energy_scf_iteration",
765
766
767
768
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
769
        "section_scf_iteration"
770
771
      ],
      "units": "J"
772
773
    },
    {
774
775
776
      "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",
777
778
779
      "repeats": false,
      "shape": [],
      "superNames": [
780
781
        "settings_XC"
      ]
782
783
    },
    {
Luca's avatar
Luca committed
784
      "description": "Correlation (C) energy, using XC_functional.",
785
786
787
788
789
790
791
792
      "dtypeStr": "f",
      "name": "energy_C",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_type_C"
      ],
      "units": "J"
793
794
    },
    {
Luca's avatar
Luca committed
795
      "description": "At each self-consistent field (SCF) iteration, change of total energy with respect to the previous SCF iteration.",
796
797
798
799
800
      "dtypeStr": "f",
      "name": "energy_change_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
801
        "error_estimate_contribution",
802
803
804
805
        "section_scf_iteration",
        "energy_value"
      ],
      "units": "J"
806
807
    },
    {
Luca's avatar
Luca committed
808
      "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).",
809
      "dtypeStr": "C",
Luca's avatar
Luca committed
810
      "name": "energy_code_independent_kind",
811
812
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
813
        "section_energy_code_independent"
814
      ]
815
816
    },
    {
Luca's avatar
Luca committed
817
      "description": "Value 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).",
818
      "dtypeStr": "f",
Luca's avatar
Luca committed
819
      "name": "energy_code_independent_value",
820
821
822
      "shape": [],
      "superNames": [
        "energy_total_potential",
Luca's avatar
Luca committed
823
        "section_energy_code_independent"
824
825
      ],
      "units": "J"
826
827
828
    },
    {
      "description": "A value of an energy component, expected to be an extensive property. ",
829
      "kindStr": "type_abstract_document_content",
830
      "name": "energy_component",
831
832
833
834
      "shape": [],
      "superNames": [
        "energy_value"
      ]
835
836
837
    },
    {
      "description": "A value of an energy term per atom, concurring in defining the total energy per atom.",
838
      "kindStr": "type_abstract_document_content",
839
      "name": "energy_component_per_atom",
840
841
842
843
      "shape": [],
      "superNames": [
        "energy_value"
      ]
844
845
846
847
848
849
850
851
852
853
854
855
856
857
    },
    {
      "description": "Entropy correction, to have a potential energy that compensates the changes in occupation, so that forces at finite T do not need to keep the change of occupation in account. Defined consistently with XC_method.",
      "dtypeStr": "f",
      "name": "energy_correction_entropy",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_single_configuration_calculation"
      ],
      "units": "J"
    },
    {
Luca's avatar
Luca committed
858
      "description": "Entropy correction, to have a potential energy that compensates the changes 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.",
859
860
861
862
863
864
865
866
867
      "dtypeStr": "f",
      "name": "energy_correction_entropy_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
868
869
870
    },
    {
      "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.",
871
      "dtypeStr": "f",
872
      "name": "energy_correction_hartree",
873
874
875
876
877
878
879
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_single_configuration_calculation"
      ],
      "units": "J"
880
881
    },
    {
Luca's avatar
Luca committed
882
      "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.",
883
884
885
886
887
888
889
890
891
      "dtypeStr": "f",
      "name": "energy_correction_hartree_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
892
893
894
    },
    {
      "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).",
895
      "dtypeStr": "f",
896
      "name": "energy_current",
897
898
899
      "repeats": false,
      "shape": [],
      "superNames": [
900
        "energy_total_potential",
901
902
903
        "section_single_configuration_calculation"
      ],
      "units": "J"
904
905
906
    },
    {
      "description": "Total electrostatic energy (nuclei + electrons), defined consistently with calculation_method.",
907
      "dtypeStr": "f",
908
      "name": "energy_electrostatic",
909
910
911
      "repeats": false,
      "shape": [],
      "superNames": [
912
        "energy_component",
913
914
915
        "section_single_configuration_calculation"
      ],
      "units": "J"
916
917
    },
    {
918
      "derived": true,
Luca's avatar
Luca committed
919
      "description": "Total electrostatic energy (nuclei + electrons) during the self-consistent field (SCF) itrations.",
920
921
922
923
924
925
926
927
928
      "dtypeStr": "f",
      "name": "energy_electrostatic_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
929
930
931
    },
    {
      "description": "Free energy (nuclei + electrons) (whose minimum gives the smeared occupation density calculated with smearing_kind) calculated with the method described in XC_method.",
932
      "dtypeStr": "f",
933
      "name": "energy_free",
934
935
936
      "repeats": false,
      "shape": [],
      "superNames": [
937
        "energy_total_potential",
938
939
940
        "section_single_configuration_calculation"
      ],
      "units": "J"
941
942
943
944
    },
    {
      "derived": true,
      "description": "Free energy per atom (whose minimum gives a density with smeared occupation) calculated with XC_method.",
945
      "dtypeStr": "f",
946
      "name": "energy_free_per_atom",
947
948
949
950
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component_per_atom",
951
        "section_single_configuration_calculation"
952
953
      ],
      "units": "J"
954
955
956
    },
    {
      "description": "Free energy per atom (whose minimum gives a density with smeared occupation) calculated with XC_method during the self-consistent field (SCF) iterations.",
957
      "dtypeStr": "f",
958
      "name": "energy_free_per_atom_scf_iteration",
959
960
961
962
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component_per_atom",
963
        "section_scf_iteration"
964
965
      ],
      "units": "J"
966
967
    },
    {
Luca's avatar
Luca committed
968
      "description": "Free energy (nuclei + electrons) (whose minimum gives the smeared occupation density) calculated with the method described in XC_method during the self-consistent field (SCF) iterations.",
969
970
971
972
973
974
975
976
977
      "dtypeStr": "f",
      "name": "energy_free_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_total_potential",
        "section_scf_iteration"
      ],
      "units": "J"
978
979
980
    },
    {
      "description": "Error in the Hartree (electrostatic) potential. Defined consistently with XC_method.",
981
      "dtypeStr": "f",
982
      "name": "energy_hartree_error",
983
984
985
      "repeats": false,
      "shape": [],
      "superNames": [
986
987
988
        "error_estimate_contribution",
        "section_single_configuration_calculation",
        "energy_value"
989
990
      ],
      "units": "J"
991
992
    },
    {
Luca's avatar
Luca committed
993
      "description": "Error in the Hartree (electrostatic) potential energy during the self-consistent field (SCF) iterations. Defined consistently with XC_method.",
994
995
996
997
998
      "dtypeStr": "f",
      "name": "energy_hartree_error_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
999
        "error_estimate_contribution",
1000
        "section_scf_iteration",