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