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