public.nomadmetainfo.json 187 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
11
12
13
14
    }, {
      "contains": [
        "calculation_context",
        "section_stats"
      ],
      "description": "Contains information relating to an archive.",
15
      "kindStr": "type_section",
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
      "name": "archive_context",
      "superNames": []
    }, {
      "description": "unique identifier of an archive.",
      "dtypeStr": "C",
      "name": "archive_gid",
      "superNames": [
        "archive_context"
      ]
    }, {
      "description": "Atomic number Z of the a.",
      "dtypeStr": "i",
      "name": "atom_atom_number",
      "shape": [
        "number_of_sites"
      ],
      "superNames": [
        "section_system"
      ]
    }, {
      "description": "concentration of the atom species in a variable composition, by default it should be considered an array of ones. Summing these should give the number_of_sites",
      "dtypeStr": "f",
      "name": "atom_concentrations",
      "shape": [
        "number_of_atoms"
      ],
      "superNames": [
        "section_system"
      ]
45
46
    }, {
      "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).",
47
      "dtypeStr": "f",
48
      "name": "atom_forces_free_raw",
49
50
51
52
53
54
55
56
57
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
58
    }, {
59
      "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).",
60
61
62
63
64
65
66
67
68
69
70
      "dtypeStr": "f",
      "name": "atom_forces_free",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
71
72
    }, {
      "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).",
73
      "dtypeStr": "f",
74
      "name": "atom_forces_raw",
75
76
77
78
79
80
81
82
83
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
84
85
    }, {
      "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).",
86
      "dtypeStr": "f",
87
      "name": "atom_forces_T0_raw",
88
89
90
91
92
93
94
95
96
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
97
    }, {
98
      "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).",
99
100
101
102
103
104
105
106
107
108
109
      "dtypeStr": "f",
      "name": "atom_forces_T0",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
110
111
    }, {
      "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).",
112
      "dtypeStr": "f",
113
114
115
116
117
118
119
120
121
122
      "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",
123
124
125
126
127
128
129
130
131
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
132
    }, {
133
      "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.",
134
      "dtypeStr": "C",
Luca's avatar
Luca committed
135
      "name": "atom_labels",
136
137
138
139
140
141
      "shape": [
        "number_of_atoms"
      ],
      "superNames": [
        "configuration_core"
      ]
142
    }, {
143
      "description": "Positions of all the atoms, in Cartesian coordinates. This metadata defines a configuration and is therefore required. For alloys where concentrations of species are given for each site in the unit cell, it stores the position of the sites.",
144
      "dtypeStr": "f",
Luca's avatar
Luca committed
145
      "name": "atom_positions",
146
147
148
149
150
151
152
153
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "configuration_core"
      ],
      "units": "m"
154
    }, {
155
      "description": "Array containing the set of discrete energy values for the atom-projected density (electronic-energy) of states (DOS).",
156
157
158
      "dtypeStr": "f",
      "name": "atom_projected_dos_energies",
      "shape": [
Luca's avatar
Luca committed
159
        "number_of_atom_projected_dos_values"
160
161
162
163
164
      ],
      "superNames": [
        "section_atom_projected_dos"
      ],
      "units": "J"
165
    }, {
166
      "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.",
167
168
169
170
171
172
173
174
175
      "dtypeStr": "i",
      "name": "atom_projected_dos_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
        2
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
176
    }, {
177
      "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).",
178
179
180
181
182
183
      "dtypeStr": "C",
      "name": "atom_projected_dos_m_kind",
      "shape": [],
      "superNames": [
        "section_atom_projected_dos"
      ]
184
    }, {
185
      "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.",
186
187
188
189
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
Luca's avatar
Luca committed
190
        "number_of_spin_channels",
191
        "number_of_atoms",
Luca's avatar
Luca committed
192
        "number_of_atom_projected_dos_values"
193
194
195
196
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
197
    }, {
198
      "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.",
199
200
201
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_total",
      "shape": [
Luca's avatar
Luca committed
202
        "number_of_spin_channels",
203
        "number_of_atoms",
Luca's avatar
Luca committed
204
        "number_of_atom_projected_dos_values"
205
206
207
208
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
209
    }, {
Luca's avatar
Luca committed
210
      "description": "Velocities of the nuclei, defined as the change in Cartesian coordinates of the nuclei with respect to time.",
211
212
213
214
215
216
217
218
      "dtypeStr": "f",
      "name": "atom_velocities",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
Luca's avatar
Luca committed
219
        "section_system"
220
221
      ],
      "units": "m/s"
222
    }, {
223
      "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).",
224
225
226
227
228
229
      "dtypeStr": "C",
      "name": "atomic_multipole_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
230
    }, {
231
      "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.",
232
233
234
235
236
237
238
239
240
      "dtypeStr": "i",
      "name": "atomic_multipole_lm",
      "shape": [
        "number_of_lm_atomic_multipoles",
        2
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
241
    }, {
242
      "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).",
243
244
245
246
247
248
      "dtypeStr": "C",
      "name": "atomic_multipole_m_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
249
    }, {
Luca's avatar
Luca committed
250
      "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.",
251
      "dtypeStr": "f",
Luca's avatar
Luca committed
252
      "name": "atomic_multipole_values",
253
254
255
256
257
258
259
      "shape": [
        "number_of_lm_atomic_multipoles",
        "number_of_atoms"
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
    }, {
      "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"
    }, {
275
      "derived": true,
276
      "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.",
277
278
279
280
281
282
283
284
285
286
287
      "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"
288
    }, {
289
      "derived": true,
290
      "description": "Fractional coordinates of the $k$ points (in the basis of the reciprocal-lattice vectors) for which the normalized electronic energies are given.",
291
      "dtypeStr": "f",
292
      "name": "band_k_points_normalized",
293
      "shape": [
294
        "number_of_normalized_k_points_per_segment",
295
        3
296
297
      ],
      "superNames": [
298
        "section_k_band_segment_normalized"
299
300
      ]
    }, {
301
      "description": "Fractional coordinates of the $k$ or $q$ points (in the basis of the reciprocal-lattice vectors) for which the electronic energy are given.",
302
      "dtypeStr": "f",
303
      "name": "band_k_points",
304
      "shape": [
Luca's avatar
Luca committed
305
        "number_of_k_points_per_segment",
306
        3
307
308
      ],
      "superNames": [
309
        "section_k_band_segment"
310
      ]
311
    }, {
312
      "derived": true,
313
      "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.",
314
      "dtypeStr": "f",
315
      "name": "band_occupations_normalized",
316
      "shape": [
317
        "number_of_spin_channels",
318
        "number_of_normalized_k_points_per_segment",
319
        "number_of_normalized_band_segment_eigenvalues"
320
321
      ],
      "superNames": [
322
        "section_k_band_segment_normalized"
323
      ]
324
    }, {
325
      "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.",
326
      "dtypeStr": "f",
327
      "name": "band_occupations",
328
      "shape": [
329
        "number_of_spin_channels",
330
        "number_of_k_points_per_segment",
331
        "number_of_band_segment_eigenvalues"
332
333
      ],
      "superNames": [
334
        "section_k_band_segment"
335
      ]
336
    }, {
337
      "derived": true,
338
339
340
      "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",
341
      "shape": [
342
        2
343
344
345
      ],
      "superNames": [
        "section_k_band_segment_normalized"
346
      ]
347
    }, {
348
      "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",
349
350
      "dtypeStr": "C",
      "name": "band_segm_labels",
351
      "shape": [
352
        2
353
354
      ],
      "superNames": [
355
        "section_k_band_segment"
356
      ]
357
    }, {
358
      "derived": true,
359
360
      "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",
361
      "name": "band_segm_start_end_normalized",
362
      "shape": [
363
364
        2,
        3
365
366
      ],
      "superNames": [
367
        "section_k_band_segment_normalized"
368
      ]
369
    }, {
370
371
      "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",
372
      "name": "band_segm_start_end",
373
374
375
376
377
      "shape": [
        2,
        3
      ],
      "superNames": [
378
        "section_k_band_segment"
379
      ]
380
    }, {
381
382
383
384
385
386
387
388
      "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"
      ]
389
    }, {
Luca's avatar
Luca committed
390
      "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.",
391
392
393
394
395
396
397
398
      "dtypeStr": "i",
      "name": "basis_set_atom_centered_ls",
      "shape": [
        "number_of_kinds_in_basis_set_atom_centered"
      ],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
399
    }, {
400
      "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)$.",
401
402
403
404
405
406
407
408
409
410
      "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"
      ]
411
    }, {
412
      "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).",
413
414
415
416
417
418
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_short_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
419
    }, {
420
      "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*).",
421
422
423
424
425
426
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_unique_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
427
    }, {
428
      "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).",
429
430
431
432
433
434
      "dtypeStr": "i",
      "name": "basis_set_atom_number",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
435
    }, {
436
      "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).",
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
      "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).",
446
      "dtypeStr": "C",
Luca's avatar
Luca committed
447
      "name": "basis_set_cell_dependent_name",
448
449
450
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
451
        "section_basis_set_cell_dependent"
452
      ]
453
    }, {
454
      "description": "One of the parts building the basis set of the system (e.g., some atom-centered basis set, plane-waves or both).",
455
456
457
458
459
      "kindStr": "type_abstract_document_content",
      "name": "basis_set_description",
      "superNames": [
        "section_run"
      ]
460
    }, {
461
      "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).",
462
463
464
465
466
467
      "dtypeStr": "C",
      "name": "basis_set_kind",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
468
    }, {
469
      "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).",
470
471
472
473
474
475
      "dtypeStr": "C",
      "name": "basis_set_name",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
476
    }, {
477
      "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.",
478
      "dtypeStr": "f",
479
      "name": "basis_set_planewave_cutoff",
480
481
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
482
        "section_basis_set_cell_dependent"
483
484
      ],
      "units": "J"
485
486
    }, {
      "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.",
487
      "dtypeStr": "C",
488
      "name": "basis_set",
489
490
      "shape": [],
      "superNames": [
491
        "section_method"
492
      ]
493
494
495
496
497
498
    }, {
      "contains": [
        "section_run",
        "section_stats"
      ],
      "description": "Contains information relating to a calculation.",
499
      "kindStr": "type_section",
500
501
502
503
504
505
506
507
508
      "name": "calculation_context",
      "superNames": []
    }, {
      "description": "unique identifier of a calculation.",
      "dtypeStr": "C",
      "name": "calculation_gid",
      "superNames": [
        "calculation_context"
      ]
509
    }, {
510
      "derived": true,
511
      "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.",
512
513
514
515
516
517
518
      "dtypeStr": "C",
      "name": "calculation_method_current",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
519
    }, {
520
      "description": "Kind of method in calculation_method_current.\n\nAccepted values are:\n\n- absolute\n- perturbative.",
521
522
523
524
525
526
527
      "dtypeStr": "C",
      "name": "calculation_method_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
528
529
530
531
532
533
534
535
536
537
538
    }, {
      "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"
      ]
    }, {
539
      "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.",
540
541
      "dtypeStr": "C",
      "name": "calculation_to_calculation_external_url",
542
      "repeats": true,
543
544
545
546
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
547
    }, {
548
      "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.",
549
550
551
552
553
554
555
      "dtypeStr": "C",
      "name": "calculation_to_calculation_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
556
    }, {
557
558
559
560
561
562
563
      "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.",
      "dtypeStr": "r",
      "name": "calculation_to_calculation_ref",
      "referencedSections": [
        "section_single_configuration_calculation"
      ],
      "repeats": true,
564
565
      "shape": [],
      "superNames": [
566
        "section_calculation_to_calculation_refs"
567
568
569
570
571
572
573
574
      ]
    }, {
      "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": [
575
        "section_calculation_to_folder_refs"
576
      ]
577
    }, {
578
579
580
581
      "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,
582
583
      "shape": [],
      "superNames": [
584
        "section_calculation_to_folder_refs"
585
      ]
586
    }, {
Luca's avatar
Luca committed
587
      "description": "Properties defining the current configuration.",
588
589
590
591
      "kindStr": "type_abstract_document_content",
      "name": "configuration_core",
      "repeats": false,
      "superNames": [
Luca's avatar
Luca committed
592
        "section_system"
593
      ]
594
    }, {
595
      "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.",
596
597
598
599
600
601
602
603
604
      "dtypeStr": "b",
      "name": "configuration_periodic_dimensions",
      "repeats": true,
      "shape": [
        3
      ],
      "superNames": [
        "configuration_core"
      ]
605
606
607
608
609
610
611
612
    }, {
      "description": "checksum of the configuration_core, i.e. the geometry of the system. The values are not normalized in any way so equivalent configurations might have different values",
      "dtypeStr": "C",
      "name": "configuration_raw_gid",
      "shape": [],
      "superNames": [
        "section_system"
      ]
613
    }, {
614
615
616
617
618
619
      "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": []
620
621
622
    }, {
      "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.",
623
      "dtypeStr": "f",
624
      "name": "dos_energies_normalized",
625
626
627
628
629
630
631
      "shape": [
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
632
633
    }, {
      "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.",
634
      "dtypeStr": "f",
635
      "name": "dos_energies",
636
      "shape": [
Luca's avatar
Luca committed
637
        "number_of_dos_values"
638
639
640
641
642
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
643
    }, {
644
      "description": "Stores the Fermi energy of the density of states.",
645
      "dtypeStr": "f",
646
      "name": "dos_fermi_energy",
647
648
649
650
      "shape": [],
      "superNames": [
        "section_dos"
      ]
651
    }, {
652
      "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",
653
654
655
656
657
658
659
660
661
      "dtypeStr": "f",
      "name": "dos_integrated_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ]
662
    }, {
663
664
665
666
667
668
669
670
      "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"
      ]
671
    }, {
672
      "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.",
673
674
675
676
677
678
679
680
681
      "dtypeStr": "i",
      "name": "dos_lm",
      "shape": [
        "number_of_dos_lms",
        2
      ],
      "superNames": [
        "section_dos"
      ]
682
    }, {
683
      "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).",
684
685
686
687
688
689
      "dtypeStr": "C",
      "name": "dos_m_kind",
      "shape": [],
      "superNames": [
        "section_dos"
      ]
690
691
    }, {
      "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.",
692
      "dtypeStr": "f",
693
      "name": "dos_values_lm",
694
      "shape": [
695
        "number_of_dos_lms",
696
        "number_of_spin_channels",
697
        "number_of_atoms",
698
699
700
701
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
702
703
704
705
      ],
      "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.",
706
      "dtypeStr": "f",
707
      "name": "dos_values",
708
      "shape": [
Luca's avatar
Luca committed
709
        "number_of_spin_channels",
Luca's avatar
Luca committed
710
        "number_of_dos_values"
711
712
713
      ],
      "superNames": [
        "section_dos"
714
715
      ]
    }, {
716
      "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).",
717
718
719
720
721
722
      "dtypeStr": "C",
      "name": "eigenvalues_kind",
      "shape": [],
      "superNames": [
        "section_eigenvalues"
      ]
723
724
    }, {
      "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.",
725
      "dtypeStr": "f",
726
      "name": "eigenvalues_kpoints_multiplicity",
727
      "shape": [
728
        "number_of_eigenvalues_kpoints"
729
730
731
732
      ],
      "superNames": [
        "section_eigenvalues"
      ]
733
734
    }, {
      "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.",
735
      "dtypeStr": "f",
736
      "name": "eigenvalues_kpoints_weights",
737
738
739
740
741
742
      "shape": [
        "number_of_eigenvalues_kpoints"
      ],
      "superNames": [
        "section_eigenvalues"
      ]
743
744
    }, {
      "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.",
745
      "dtypeStr": "f",
746
      "name": "eigenvalues_kpoints",
747
      "shape": [
748
749
        "number_of_eigenvalues_kpoints",
        3
750
751
752
753
      ],
      "superNames": [
        "section_eigenvalues"
      ]
754
    }, {
755
      "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.",
756
757
758
      "dtypeStr": "f",
      "name": "eigenvalues_occupation",
      "shape": [
Luca's avatar
Luca committed
759
        "number_of_spin_channels",
760
761
762
763
764
765
        "number_of_eigenvalues_kpoints",
        "number_of_eigenvalues"
      ],
      "superNames": [
        "section_eigenvalues"
      ]
766
    }, {
767
      "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
768
769
770
771
772
773
774
775
776
777
778
      "dtypeStr": "f",
      "name": "eigenvalues_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_eigenvalues_kpoints",
        "number_of_eigenvalues"
      ],
      "superNames": [
        "section_eigenvalues"
      ],
      "units": "J"
779
780
    }, {
      "description": "Electronic kinetic energy as defined in XC_method during the self-consistent field (SCF) iterations.",
781
      "dtypeStr": "f",
782
      "name": "electronic_kinetic_energy_scf_iteration",
783
784
785
786
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
787
        "section_scf_iteration"
788
789
      ],
      "units": "J"
790
791
    }, {
      "description": "Self-consistent electronic kinetic energy as defined in XC_method.",
792
      "dtypeStr": "f",
793
      "name": "electronic_kinetic_energy",
794
795
796
797
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
798
        "section_single_configuration_calculation"
799
800
      ],
      "units": "J"
801
    }, {
802
803
804
      "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",
805
806
807
      "repeats": false,
      "shape": [],
      "superNames": [
808
809
        "settings_XC"
      ]
Micael Oliveira's avatar
Micael Oliveira committed
810
811
812
813
814
815
816
    }, {
      "description": "Is the system embedded into a host geometry?.",
      "dtypeStr": "b",
      "name": "embedded_system",
      "repeats": false,
      "shape": [],
      "superNames": [
817
        "configuration_core"
Micael Oliveira's avatar
Micael Oliveira committed
818
      ]
819
    }, {
820
      "description": "Correlation (C) energy calculated with the method described in XC_functional.",
821
822
823
824
825
826
827
828
      "dtypeStr": "f",
      "name": "energy_C",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_type_C"
      ],
      "units": "J"
829
    }, {
830
      "description": "Stores the change of total energy with respect to the previous self-consistent field (SCF) iteration.",
831
832
833
834
835
      "dtypeStr": "f",
      "name": "energy_change_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
836
        "error_estimate_contribution",
837
838
839
840
        "section_scf_iteration",
        "energy_value"
      ],
      "units": "J"
841
    }, {
842
      "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).",
843
      "dtypeStr": "C",
Luca's avatar
Luca committed
844
      "name": "energy_code_independent_kind",
845
846
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
847
        "section_energy_code_independent"
848
      ]
849
    }, {
850
      "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).",
851
      "dtypeStr": "f",
Luca's avatar
Luca committed
852
      "name": "energy_code_independent_value",
853
854
855
      "shape": [],
      "superNames": [
        "energy_total_potential",
Luca's avatar
Luca committed
856
        "section_energy_code_independent"
857
858
      ],
      "units": "J"
859
860
    }, {
      "description": "A value of an energy component per atom, concurring in defining the total energy per atom.",
861
      "kindStr": "type_abstract_document_content",
862
      "name": "energy_component_per_atom",
863
864
865
866
      "shape": [],
      "superNames": [
        "energy_value"
      ]
867
868
    }, {
      "description": "A value of an energy component, expected to be an extensive property.",
869
      "kindStr": "type_abstract_document_content",
870
      "name": "energy_component",
871
872
873
874
      "shape": [],
      "superNames": [
        "energy_value"
      ]
875
876
    }, {
      "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.",
877
878
879
880
881
882
883
884
885
      "dtypeStr": "f",
      "name": "energy_correction_entropy_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
886
887
    }, {
      "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.",
888
      "dtypeStr": "f",
889
      "name": "energy_correction_entropy",
890
891
892
893
894
895
896
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_single_configuration_calculation"
      ],
      "units": "J"
897
    }, {
Luca's avatar
Luca committed
898
      "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.",
899
900
901
902
903
904
905
906
907
      "dtypeStr": "f",
      "name": "energy_correction_hartree_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
908
909
    }, {
      "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.",
910
      "dtypeStr": "f",
911
      "name": "energy_correction_hartree",
912
913
914
      "repeats": false,
      "shape": [],
      "superNames": [
915
        "energy_component",
916
917
918
        "section_single_configuration_calculation"
      ],
      "units": "J"
919
920
    }, {
      "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).",
921
      "dtypeStr": "f",
922
      "name": "energy_current",
923
924
925
      "repeats": false,
      "shape": [],
      "superNames": [
926
        "energy_total_potential",
927
928
929
        "section_single_configuration_calculation"
      ],
      "units": "J"
930
    }, {
931
      "derived": true,
932
      "description": "Total electrostatic energy (nuclei + electrons) during each self-consistent field (SCF) iteration.",
933
934
935
936
937
938
939
940
941
      "dtypeStr": "f",
      "name": "energy_electrostatic_scf_iteration",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_scf_iteration"
      ],
      "units": "J"
942
943
    }, {
      "description": "Total electrostatic energy (nuclei + electrons), defined consistently with calculation_method.",
944
      "dtypeStr": "f",
945
      "name": "energy_electrostatic",
946
947
948
      "repeats": false,
      "shape": [],
      "superNames": [
949
        "energy_component",
950
951
952
        "section_single_configuration_calculation"
      ],
      "units": "J"
953
954
    }, {
      "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.",
955
      "dtypeStr": "f",
956
      "name": "energy_free_per_atom_scf_iteration",
957
958
959
960
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_c