public.nomadmetainfo.json 218 KB
Newer Older
1 2
{
  "type": "nomad_meta_info_1_0",
Luca's avatar
Luca committed
3
  "description": "Public meta info, not specific to any code",
4 5
  "metaInfos": [
    {
6
      "description": "Information that *in theory* should not affect the results of the calculations (e.g., timing).",
7 8 9
      "kindStr": "type_abstract_document_content",
      "name": "accessory_info",
      "superNames": []
10 11
    },
    {
12 13 14 15 16
      "contains": [
        "calculation_context",
        "section_stats"
      ],
      "description": "Contains information relating to an archive.",
17
      "kindStr": "type_section",
18 19
      "name": "archive_context",
      "superNames": []
20 21
    },
    {
22 23 24 25 26 27
      "description": "unique identifier of an archive.",
      "dtypeStr": "C",
      "name": "archive_gid",
      "superNames": [
        "archive_context"
      ]
28 29
    },
    {
30 31 32 33 34 35 36 37 38
      "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"
      ]
39 40
    },
    {
41
      "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).",
42
      "dtypeStr": "f",
43
      "name": "atom_forces_free_raw",
44 45 46 47 48 49 50 51 52
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
53 54
    },
    {
55
      "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).",
56 57 58 59 60 61 62 63 64 65 66
      "dtypeStr": "f",
      "name": "atom_forces_free",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
67 68
    },
    {
69
      "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).",
70
      "dtypeStr": "f",
71
      "name": "atom_forces_raw",
72 73 74 75 76 77 78 79 80
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
81 82
    },
    {
83
      "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).",
84
      "dtypeStr": "f",
85
      "name": "atom_forces_t0_raw",
86 87 88 89 90 91 92 93 94
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
95 96
    },
    {
97
      "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).",
98
      "dtypeStr": "f",
99
      "name": "atom_forces_t0",
100 101 102 103 104 105 106 107 108
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
109 110
    },
    {
111 112 113 114 115 116
      "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).",
      "kindStr": "type_abstract_document_content",
      "name": "atom_forces_type",
      "superNames": [
        "section_single_configuration_calculation"
      ]
117 118
    },
    {
119 120 121
      "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",
122 123 124 125 126 127 128 129 130
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "atom_forces_type"
      ],
      "units": "N"
131 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
    },
    {
144 145 146 147 148 149 150 151 152 153 154
      "derived": true,
      "description": "Atom positions in the primitive cell in reduced units.",
      "dtypeStr": "f",
      "name": "atom_positions_primitive",
      "shape": [
        "number_of_atoms_primitive",
        3
      ],
      "superNames": [
        "section_primitive_system"
      ]
155 156
    },
    {
157 158 159 160 161 162 163 164 165 166 167
      "derived": true,
      "description": "Standardized atom positions in reduced units.",
      "dtypeStr": "f",
      "name": "atom_positions_std",
      "shape": [
        "number_of_atoms_std",
        3
      ],
      "superNames": [
        "section_std_system"
      ]
168 169
    },
    {
170
      "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.",
171
      "dtypeStr": "f",
Luca's avatar
Luca committed
172
      "name": "atom_positions",
173 174 175 176 177 178 179 180
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
        "configuration_core"
      ],
      "units": "m"
181 182
    },
    {
183
      "description": "Array containing the set of discrete energy values for the atom-projected density (electronic-energy) of states (DOS).",
184 185 186
      "dtypeStr": "f",
      "name": "atom_projected_dos_energies",
      "shape": [
Luca's avatar
Luca committed
187
        "number_of_atom_projected_dos_values"
188 189 190 191 192
      ],
      "superNames": [
        "section_atom_projected_dos"
      ],
      "units": "J"
193 194
    },
    {
195
      "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.",
196 197 198 199 200 201 202 203 204
      "dtypeStr": "i",
      "name": "atom_projected_dos_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
        2
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
205 206
    },
    {
207
      "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).",
208 209 210 211 212 213
      "dtypeStr": "C",
      "name": "atom_projected_dos_m_kind",
      "shape": [],
      "superNames": [
        "section_atom_projected_dos"
      ]
214 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 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.",
217 218 219 220
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_lm",
      "shape": [
        "number_of_lm_atom_projected_dos",
Luca's avatar
Luca committed
221
        "number_of_spin_channels",
222
        "number_of_atoms",
Luca's avatar
Luca committed
223
        "number_of_atom_projected_dos_values"
224 225 226 227
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
228 229
    },
    {
230
      "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.",
231 232 233
      "dtypeStr": "f",
      "name": "atom_projected_dos_values_total",
      "shape": [
Luca's avatar
Luca committed
234
        "number_of_spin_channels",
235
        "number_of_atoms",
Luca's avatar
Luca committed
236
        "number_of_atom_projected_dos_values"
237 238 239 240
      ],
      "superNames": [
        "section_atom_projected_dos"
      ]
241 242
    },
    {
Luca's avatar
Luca committed
243
      "description": "Velocities of the nuclei, defined as the change in Cartesian coordinates of the nuclei with respect to time.",
244 245 246 247 248 249 250 251
      "dtypeStr": "f",
      "name": "atom_velocities",
      "repeats": true,
      "shape": [
        "number_of_atoms",
        3
      ],
      "superNames": [
Luca's avatar
Luca committed
252
        "section_system"
253 254
      ],
      "units": "m/s"
255 256
    },
    {
257
      "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).",
258 259 260 261 262 263
      "dtypeStr": "C",
      "name": "atomic_multipole_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
264 265
    },
    {
266
      "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.",
267 268 269 270 271 272 273 274 275
      "dtypeStr": "i",
      "name": "atomic_multipole_lm",
      "shape": [
        "number_of_lm_atomic_multipoles",
        2
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
276 277
    },
    {
278
      "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).",
279 280 281 282 283 284
      "dtypeStr": "C",
      "name": "atomic_multipole_m_kind",
      "shape": [],
      "superNames": [
        "section_atomic_multipoles"
      ]
285 286
    },
    {
Luca's avatar
Luca committed
287
      "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.",
288
      "dtypeStr": "f",
Luca's avatar
Luca committed
289
      "name": "atomic_multipole_values",
290 291 292 293 294 295 296
      "shape": [
        "number_of_lm_atomic_multipoles",
        "number_of_atoms"
      ],
      "superNames": [
        "section_atomic_multipoles"
      ]
297 298
    },
    {
299 300 301 302 303 304 305 306 307 308
      "derived": true,
      "description": "Atomic numbers in the primitive cell.",
      "dtypeStr": "i",
      "name": "atomic_numbers_primitive",
      "shape": [
        "number_of_atoms_primitive"
      ],
      "superNames": [
        "section_primitive_system"
      ]
309 310
    },
    {
311 312 313 314 315 316 317 318 319 320
      "derived": true,
      "description": "Atomic numbers of the atoms in the standardized cell.",
      "dtypeStr": "i",
      "name": "atomic_numbers_std",
      "shape": [
        "number_of_atoms_std"
      ],
      "superNames": [
        "section_std_system"
      ]
321 322
    },
    {
323 324 325 326 327 328 329 330 331 332 333 334 335
      "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"
336 337
    },
    {
338
      "derived": true,
339
      "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.",
340 341 342 343 344 345 346 347 348 349 350
      "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"
351 352
    },
    {
353
      "derived": true,
354
      "description": "Fractional coordinates of the $k$ points (in the basis of the reciprocal-lattice vectors) for which the normalized electronic energies are given.",
355
      "dtypeStr": "f",
356
      "name": "band_k_points_normalized",
357
      "shape": [
358
        "number_of_normalized_k_points_per_segment",
359
        3
360 361
      ],
      "superNames": [
362
        "section_k_band_segment_normalized"
363
      ]
364 365
    },
    {
366
      "description": "Fractional coordinates of the $k$ or $q$ points (in the basis of the reciprocal-lattice vectors) for which the electronic energy are given.",
367
      "dtypeStr": "f",
368
      "name": "band_k_points",
369
      "shape": [
Luca's avatar
Luca committed
370
        "number_of_k_points_per_segment",
371
        3
372 373
      ],
      "superNames": [
374
        "section_k_band_segment"
375
      ]
376 377
    },
    {
378
      "derived": true,
379
      "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.",
380
      "dtypeStr": "f",
381
      "name": "band_occupations_normalized",
382
      "shape": [
383
        "number_of_spin_channels",
384
        "number_of_normalized_k_points_per_segment",
385
        "number_of_normalized_band_segment_eigenvalues"
386 387
      ],
      "superNames": [
388
        "section_k_band_segment_normalized"
389
      ]
390 391
    },
    {
392
      "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.",
393
      "dtypeStr": "f",
394
      "name": "band_occupations",
395
      "shape": [
396
        "number_of_spin_channels",
397
        "number_of_k_points_per_segment",
398
        "number_of_band_segment_eigenvalues"
399 400
      ],
      "superNames": [
401
        "section_k_band_segment"
402
      ]
403 404
    },
    {
405
      "derived": true,
406 407 408
      "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",
409
      "shape": [
410
        2
411 412 413
      ],
      "superNames": [
        "section_k_band_segment_normalized"
414
      ]
415 416
    },
    {
417
      "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",
418 419
      "dtypeStr": "C",
      "name": "band_segm_labels",
420
      "shape": [
421
        2
422 423
      ],
      "superNames": [
424
        "section_k_band_segment"
425
      ]
426 427
    },
    {
428
      "derived": true,
429 430
      "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",
431
      "name": "band_segm_start_end_normalized",
432
      "shape": [
433 434
        2,
        3
435 436
      ],
      "superNames": [
437
        "section_k_band_segment_normalized"
438
      ]
439 440
    },
    {
441 442
      "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",
443
      "name": "band_segm_start_end",
444 445 446 447 448
      "shape": [
        2,
        3
      ],
      "superNames": [
449
        "section_k_band_segment"
450
      ]
451 452
    },
    {
453 454 455 456 457 458 459 460
      "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"
      ]
461 462
    },
    {
Luca's avatar
Luca committed
463
      "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.",
464 465 466 467 468 469 470 471
      "dtypeStr": "i",
      "name": "basis_set_atom_centered_ls",
      "shape": [
        "number_of_kinds_in_basis_set_atom_centered"
      ],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
472 473
    },
    {
474
      "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)$.",
475 476 477 478 479 480 481 482 483 484
      "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"
      ]
485 486
    },
    {
487
      "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).",
488 489 490 491 492 493
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_short_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
494 495
    },
    {
496
      "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*).",
497 498 499 500 501 502
      "dtypeStr": "C",
      "name": "basis_set_atom_centered_unique_name",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
503 504
    },
    {
505
      "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).",
506 507 508 509 510 511
      "dtypeStr": "i",
      "name": "basis_set_atom_number",
      "shape": [],
      "superNames": [
        "section_basis_set_atom_centered"
      ]
512 513
    },
    {
514
      "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).",
515
      "dtypeStr": "C",
Luca's avatar
Luca committed
516
      "name": "basis_set_cell_dependent_kind",
517 518 519
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
520
        "section_basis_set_cell_dependent"
521
      ]
522 523
    },
    {
524
      "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).",
525
      "dtypeStr": "C",
Luca's avatar
Luca committed
526
      "name": "basis_set_cell_dependent_name",
527 528 529
      "repeat": false,
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
530
        "section_basis_set_cell_dependent"
531
      ]
532 533
    },
    {
534
      "description": "One of the parts building the basis set of the system (e.g., some atom-centered basis set, plane-waves or both).",
535 536 537 538 539
      "kindStr": "type_abstract_document_content",
      "name": "basis_set_description",
      "superNames": [
        "section_run"
      ]
540 541
    },
    {
542
      "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).",
543 544 545 546 547 548
      "dtypeStr": "C",
      "name": "basis_set_kind",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
549 550
    },
    {
551
      "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).",
552 553 554 555 556 557
      "dtypeStr": "C",
      "name": "basis_set_name",
      "shape": [],
      "superNames": [
        "section_basis_set"
      ]
558 559
    },
    {
560
      "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.",
561
      "dtypeStr": "f",
562
      "name": "basis_set_planewave_cutoff",
563 564
      "shape": [],
      "superNames": [
Luca's avatar
Luca committed
565
        "section_basis_set_cell_dependent"
566 567
      ],
      "units": "J"
568 569
    },
    {
570
      "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.",
571
      "dtypeStr": "C",
572
      "name": "basis_set",
573 574
      "shape": [],
      "superNames": [
575 576
        "settings_potential_energy_surface",
        "settings_numerical_parameter"
577
      ]
578 579
    },
    {
580 581 582 583 584 585 586 587
      "derived": true,
      "description": "Identifier for the Bravais lattice in Pearson notation. The first lowercase letter identifies the crystal family and can be one of the following: a (triclinic), b (monoclinic), o (orthorhombic), t (tetragonal), h (hexagonal) or c (cubic). The second uppercase letter identifies the centring and can be one of the following: P (primitive), S (face centred), I (body centred), R (rhombohedral centring) or F (all faces centred).",
      "dtypeStr": "C",
      "name": "bravais_lattice",
      "shape": [],
      "superNames": [
        "section_symmetry"
      ]
588 589
    },
    {
590 591 592 593 594
      "contains": [
        "section_run",
        "section_stats"
      ],
      "description": "Contains information relating to a calculation.",
595
      "kindStr": "type_section",
596 597
      "name": "calculation_context",
      "superNames": []
598 599
    },
    {
600 601 602 603 604 605 606 607
      "description": "Contains the nomad uri of a raw the data file connected to the current run. There should be an value for the main_file_uri and all ancillary files.",
      "dtypeStr": "C",
      "name": "calculation_file_uri",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_run"
      ]
608 609
    },
    {
610 611 612 613 614 615
      "description": "unique identifier of a calculation.",
      "dtypeStr": "C",
      "name": "calculation_gid",
      "superNames": [
        "calculation_context"
      ]
616 617
    },
    {
618
      "derived": true,
619
      "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.",
620 621 622 623 624 625 626
      "dtypeStr": "C",
      "name": "calculation_method_current",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
627 628
    },
    {
629
      "description": "Kind of method in calculation_method_current.\n\nAccepted values are:\n\n- absolute\n- perturbative.",
630 631 632 633 634 635 636
      "dtypeStr": "C",
      "name": "calculation_method_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_method"
      ]
637 638
    },
    {
639 640 641 642 643 644 645 646 647
      "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"
      ]
648 649
    },
    {
650 651 652 653 654 655 656 657
      "description": "The number of restricted uris in restricted_uri list.",
      "dtypeStr": "i",
      "name": "number_of_restricted_uri",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
658 659
    },
    {
660 661 662 663 664 665 666 667 668 669
      "description": "The list of nomad uri(s) identifying the restricted info/file corresponding to this calculation",
      "dtypeStr": "C",
      "name": "restricted_uri",
      "repeats": true,
      "shape": [
        "number_of_restricted_uri"
      ],
      "superNames": [
        "section_restricted_uri"
      ]
670 671
    },
    {
672 673 674 675 676 677 678 679
      "description": "The reason of restriction for the uri or file. The reason can be 'propriety license', 'open-source redistribution restricted license', 'other license', or 'author restricted'.",
      "dtypeStr": "C",
      "name": "restricted_uri_reason",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
680 681
    },
    {
682 683 684 685 686 687 688 689
      "description": "The issue authority is the restriction owner for the uri or file. This can be license owner such as 'VASP' or 'AMBER', 'NOMAD', or the author of the uri. For example the repository user name of the author.",
      "dtypeStr": "C",
      "name": "restricted_uri_issue_authority",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
690 691
    },
    {
692 693 694 695 696 697 698 699
      "description": "The deadline date of the restriction for the uri or file. The end date can be in date format string for those restrictions set by authors or NOMAD otherwise it is set to 'unlimited' for the restriction related to license.",
      "dtypeStr": "C",
      "name": "restricted_uri_end_date",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
700 701
    },
    {
702 703 704 705 706 707 708 709
      "description": "The type of restriction for the uri or file. The type can be 'any access' or 'license permitted'.",
      "dtypeStr": "C",
      "name": "restricted_uri_restriction",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
710 711
    },
    {
712 713 714 715 716 717 718 719
      "description": "The info of the license that is the reason of restriction.",
      "dtypeStr": "C",
      "name": "restricted_uri_license",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
720 721
    },
    {
722 723 724 725 726 727 728 729
      "description": "The number of restricted files in restricted_uri_files list.",
      "dtypeStr": "i",
      "name": "number_of_restricted_uri_files",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_restricted_uri"
      ]
730 731
    },
    {
732 733 734 735 736 737 738 739 740 741
      "description": "The list of files that are subject to restriction. The files are given with their relative paths to the main_file of parsing.",
      "dtypeStr": "C",
      "name": "restricted_uri_files",
      "repeats": true,
      "shape": [
        "number_of_restricted_uri_files"
      ],
      "superNames": [
        "section_restricted_uri"
      ]
742 743
    },
    {
744 745 746 747 748 749 750
      "description": "repository pid of this calculation",
      "dtypeStr": "C",
      "name": "calculation_pid",
      "shape": [],
      "superNames": [
        "section_calculation_info"
      ]
751 752
    },
    {
753
      "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.",
754 755
      "dtypeStr": "C",
      "name": "calculation_to_calculation_external_url",
756
      "repeats": true,
757 758 759 760
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
761 762
    },
    {
763
      "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.",
764 765 766 767 768 769 770
      "dtypeStr": "C",
      "name": "calculation_to_calculation_kind",
      "repeats": false,
      "shape": [],
      "superNames": [
        "section_calculation_to_calculation_refs"
      ]
771 772
    },
    {
773 774 775 776 777 778 779
      "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,
780 781
      "shape": [],
      "superNames": [
782
        "section_calculation_to_calculation_refs"
783
      ]
784 785
    },
    {
786 787 788 789 790 791
      "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": [
792
        "section_calculation_to_folder_refs"
793
      ]
794 795
    },
    {
796 797 798 799
      "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,
800 801
      "shape": [],
      "superNames": [
802
        "section_calculation_to_folder_refs"
803
      ]
804 805
    },
    {
806 807 808 809 810 811 812 813
      "description": "Upload date of the calculation, given as total number of milliseconds is the elapsed since the unix epoch (1 January 1970)",
      "dtypeStr": "i64",
      "name": "calculation_upload_date",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_calculation_info"
      ]
814 815
    },
    {
816 817 818 819 820 821 822 823
      "description": "Name of the uploader of this calculation, given as lastamen, firstname",
      "dtypeStr": "C",
      "name": "calculation_uploader_name",
      "repeats": true,
      "shape": [],
      "superNames": [
        "section_calculation_info"
      ]
824 825
    },
    {
826 827 828 829 830 831 832 833
      "derived": true,
      "description": "String that specifies the centering, origin and basis vector settings of the 3D space group that defines the symmetry group of the simulated physical system (see section_system). Values are as defined by spglib.",
      "dtypeStr": "C",
      "name": "choice",
      "shape": [],
      "superNames": [
        "section_symmetry"
      ]
834 835
    },
    {
Luca's avatar
Luca committed
836
      "description": "Properties defining the current configuration.",
837 838 839
      "kindStr": "type_abstract_document_content",
      "name": "configuration_core",
      "superNames": [
Luca's avatar
Luca committed
840
        "section_system"
841
      ]
842 843
    },
    {
844
      "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.",
845 846 847 848 849 850 851 852 853
      "dtypeStr": "b",
      "name": "configuration_periodic_dimensions",
      "repeats": true,
      "shape": [
        3
      ],
      "superNames": [
        "configuration_core"
      ]
854 855
    },
    {
856 857 858 859 860 861 862
      "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"
      ]
863 864
    },
    {
865 866 867 868 869 870 871 872
      "derived": true,
      "description": "Name of the crystal system. Can be one of the following: triclinic, monoclinic, orthorhombic, tetragonal, trigonal, hexagonal or cubic.",
      "dtypeStr": "C",
      "name": "crystal_system",
      "shape": [],
      "superNames": [
        "section_symmetry"
      ]
873 874
    },
    {
875 876
      "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.",
877
      "dtypeStr": "f",
878
      "name": "dos_energies_normalized",
879 880 881 882 883 884 885
      "shape": [
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
886 887
    },
    {
888
      "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.",
889
      "dtypeStr": "f",
890
      "name": "dos_energies",
891
      "shape": [
Luca's avatar
Luca committed
892
        "number_of_dos_values"
893 894 895 896 897
      ],
      "superNames": [
        "section_dos"
      ],
      "units": "J"
898 899
    },
    {
900
      "description": "Stores the Fermi energy of the density of states.",
901
      "dtypeStr": "f",
902
      "name": "dos_fermi_energy",
903 904 905 906
      "shape": [],
      "superNames": [
        "section_dos"
      ]
907 908
    },
    {
909
      "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",
910 911 912 913 914 915 916 917 918
      "dtypeStr": "f",
      "name": "dos_integrated_values",
      "shape": [
        "number_of_spin_channels",
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
      ]
919 920
    },
    {
921 922 923 924 925 926 927 928
      "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"
      ]
929 930
    },
    {
931
      "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.",
932 933 934 935 936 937 938 939 940
      "dtypeStr": "i",
      "name": "dos_lm",
      "shape": [
        "number_of_dos_lms",
        2
      ],
      "superNames": [
        "section_dos"
      ]
941 942
    },
    {
943
      "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).",
944 945 946 947 948 949
      "dtypeStr": "C",
      "name": "dos_m_kind",
      "shape": [],
      "superNames": [
        "section_dos"
      ]
950 951
    },
    {
952
      "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.",
953
      "dtypeStr": "f",
954
      "name": "dos_values_lm",
955
      "shape": [
956
        "number_of_dos_lms",
957
        "number_of_spin_channels",
958
        "number_of_atoms",
959 960 961 962
        "number_of_dos_values"
      ],
      "superNames": [
        "section_dos"
963 964
      ],
      "units": "J"
965 966
    },
    {
967 968 969 970 971 972 973 974 975 976
      "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"
      ]
977 978
    },
    {
979 980 981 982 983 984 985 986 987 988
      "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"
      ]
989 990
    },
    {
991
      "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.",
992
      "dtypeStr": "f",
993
      "name": "dos_values",
994
      "shape": [
Luca's avatar
Luca committed
995
        "number_of_spin_channels",
Luca's avatar
Luca committed
996
        "number_of_dos_values"
997 998 999
      ],
      "superNames": [
        "section_dos"
1000
      ]
1001 1002
    },
    {
1003
      "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).",
1004 1005 1006 1007 1008
      "dtypeStr": "C",
      "name": "eigenvalues_kind",
      "shape": [],
      "superNames": [
        "section_eigenvalues"
1009 1010 1011 1012 1013
      ],
      "values": {
        "normal": "all eigenvalues of the Kohn Sham / Fock operator",
        "partial": "partial eigenvalue spectrum, usually around the HOMO-LOMO. In this case, number_of_eigenvalues only refers to the number of stored eigenvalues, not the full spectrum."
      }
1014 1015
    },
    {