common.nomadmetainfo.json 17.7 KB
Newer Older
1 2
{
  "type": "nomad_meta_info_1_0",
3
  "description": "Common meta info, not specific to any code",
4 5 6
  "dependencies": [ {
      "relativePath": "public.nomadmetainfo.json"
    }],
7
  "metaInfos": [ {
Luca's avatar
Luca committed
8
      "description": "Charge of each atom in the molecule.",
9 10
      "dtypeStr": "f",
      "name": "atom_in_molecule_charge",
11 12 13 14 15
      "shape": [
        "number_of_atoms_in_molecule"
      ],
      "superNames": [
        "settings_atom_in_molecule"
Luca's avatar
Luca committed
16 17
      ],
      "units": "C"
18 19
    }, {
      "description": "Name (label) of each atom in the molecule.",
20 21
      "dtypeStr": "C",
      "name": "atom_in_molecule_name",
22 23 24 25 26 27 28
      "shape": [
        "number_of_atoms_in_molecule"
      ],
      "superNames": [
        "settings_atom_in_molecule"
      ]
    }, {
29 30 31 32 33 34
      "description": "Reference to the atom type of each atom in the molecule.",
      "dtypeStr": "r",
      "name": "atom_in_molecule_to_atom_type_ref",
      "referencedSections": [
        "section_atom_type"
      ],
35 36 37 38 39 40 41
      "shape": [
        "number_of_atoms_in_molecule"
      ],
      "superNames": [
        "settings_atom_in_molecule"
      ]
    }, {
42
      "description": "Table mapping atom to molecules: the first column is the index of the molecule and the second column the index of the atom, signifying that the atom in the second column belongs to the molecule in the first column in the same row.",
43 44 45 46 47 48 49
      "dtypeStr": "i",
      "name": "atom_to_molecule",
      "shape": [
        "number_of_topology_atoms",
        2
      ],
      "superNames": [
50
        "section_topology"
51 52
      ]
    }, {
53
      "description": "Charge of the atom type.",
Chibani, Wael (wlc)'s avatar
Chibani, Wael (wlc) committed
54
      "dtypeStr": "f",
55
      "name": "atom_type_charge",
56 57 58
      "shape": [],
      "superNames": [
        "section_atom_type"
59 60
      ],
      "units": "C"
61
    }, {
62
      "description": "Mass of the atom type.",
Chibani, Wael (wlc)'s avatar
Chibani, Wael (wlc) committed
63
      "dtypeStr": "f",
64 65 66 67
      "name": "atom_type_mass",
      "shape": [],
      "superNames": [
        "section_atom_type"
Chibani, Wael (wlc)'s avatar
Chibani, Wael (wlc) committed
68 69
      ],
      "units": "kg"
70
    }, {
71
      "description": "Name (label) of the atom type.",
72
      "dtypeStr": "C",
73
      "name": "atom_type_name",
74 75 76 77
      "shape": [],
      "superNames": [
        "section_atom_type"
      ]
78
    }, {
79 80 81
      "description": "List of the indexes involved in this constraint. The fist atom has index 1, the last number_of_topology_atoms.",
      "dtypeStr": "i",
      "name": "constraint_atoms",
82
      "shape": [
83 84
        "number_of_constraints",
        "number_of_atoms_per_constraint"
85 86
      ],
      "superNames": [
87 88
        "section_constraint"
      ]
89
    }, {
90
      "description": "Short and unique name for this constraint type. Valid names are described in the [constraint\\_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/constraint-kind).",
91
      "dtypeStr": "C",
92
      "name": "constraint_kind",
93 94
      "shape": [],
      "superNames": [
95 96 97 98 99 100 101 102 103
        "section_constraint"
      ]
    }, {
      "description": "Explicit constraint parameters for this kind of constraint (depending on the constraint type, some might be given implicitly through other means).",
      "dtypeStr": "D",
      "name": "constraint_parameters",
      "shape": [],
      "superNames": [
        "section_constraint"
104
      ]
Luca's avatar
Luca committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    }, {
      "description": "Component of the correlation (C) energy at the GGA (or MetaGGA) level using the self-consistent density of the target XC functional (full unscaled value, i.e., not scaled due to exact-exchange mixing).",
      "dtypeStr": "f",
      "name": "energy_C_mGGA",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_type_C"
      ],
      "units": "J"
    }, {
      "description": "Component of the exchange (X) energy at the GGA (or MetaGGA) level, using the self consistent density of the target functional, scaled accordingly to the mixing parameter.",
      "dtypeStr": "f",
      "name": "energy_X_mGGA_scaled",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_component",
        "section_single_configuration_calculation"
      ],
      "units": "J"
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
    }, {
      "description": "Fermi energy (separates occupied from unoccupied single-particle states in metals)",
      "dtypeStr": "f",
      "name": "energy_reference_fermi",
      "repeats": false,
      "shape": ["number_of_spin_channels"],
      "superNames": [
        "energy_type_reference",
        "section_single_configuration_calculation"
      ],
      "units": "J"
    }, {
      "description": "Highest occupied single-particle state energy (in insulators or HOMO energy in finite systems)",
      "dtypeStr": "f",
      "name": "energy_reference_highest_occupied",
      "repeats": false,
      "shape": ["number_of_spin_channels"],
      "superNames": [
        "energy_type_reference",
        "section_single_configuration_calculation"
      ],
      "units": "J"
    }, {
      "description": "Lowest unoccupied single-particle state energy (in insulators or LUMO energy in finite systems)",
      "dtypeStr": "f",
      "name": "energy_reference_lowest_unoccupied",
      "repeats": false,
      "shape": ["number_of_spin_channels"],
      "superNames": [
        "energy_type_reference",
        "section_single_configuration_calculation"
      ],
      "units": "J"
Luca's avatar
Luca committed
159 160 161 162 163 164 165 166 167 168
    }, {
      "description": "Component of the exchange (X) energy at the GGA (or MetaGGA) level using the self consistent density of the target functional (full unscaled value, i.e., not scaled due to exact-exchange mixing).",
      "dtypeStr": "f",
      "name": "energy_X_mGGA",
      "repeats": false,
      "shape": [],
      "superNames": [
        "energy_type_X"
      ],
      "units": "J"
169
    }, {
170
      "description": "List of the indexes involved in this interaction. The fist atom has index 1, the last atom index number_of_topology_atoms.",
171
      "dtypeStr": "i",
172
      "name": "interaction_atoms",
173
      "shape": [
174 175
        "number_of_interactions",
        "number_of_atoms_per_interaction"
176 177
      ],
      "superNames": [
178
        "section_interaction"
179
      ]
180
    }, {
181
      "description": "Short and unique name for this interaction type. Valid names are described in the [interaction\\_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/interaction-kind).",
182
      "dtypeStr": "C",
183
      "name": "interaction_kind",
184 185
      "shape": [],
      "superNames": [
186
        "section_interaction"
187
      ]
188
    }, {
189 190 191 192
      "description": "Explicit interaction parameters for this kind of interaction (depending on the interaction_kind some might be given implicitly through other means).",
      "dtypeStr": "D",
      "name": "interaction_parameters",
      "shape": [],
193
      "superNames": [
194
        "section_interaction"
195
      ]
Luca's avatar
Luca committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    }, {
      "description": "Reference to an atom-centered basis set defined in section_basis_set_atom_centered and to the atom kind as defined in section_method_atom_kind.",
      "dtypeStr": "r",
      "name": "mapping_section_method_basis_set_atom_centered",
      "referencedSections": [
        "section_method_atom_kind",
        "section_basis_set_atom_centered"
      ],
      "shape": [
        "number_of_basis_sets_atom_centered",
        2
      ],
      "superNames": [
        "section_method_basis_set"
      ]
    }, {
      "description": "Reference to a cell-associated basis set.",
      "dtypeStr": "r",
      "name": "mapping_section_method_basis_set_cell_associated",
      "referencedSections": [
216
        "section_basis_set_cell_dependent"
Luca's avatar
Luca committed
217 218 219 220 221 222
      ],
      "shape": [],
      "superNames": [
        "section_method_basis_set"
      ]
    }, {
223
      "description": "String describing the use of the basis set, i.e, if it used for expanding a wavefunction or an electron density. Allowed values are listed in the [basis\\_set\\_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-kind).",
Luca's avatar
Luca committed
224 225 226 227 228 229
      "dtypeStr": "C",
      "name": "method_basis_set_kind",
      "shape": [],
      "superNames": [
        "section_method_basis_set"
      ]
Luca's avatar
Luca committed
230 231 232 233 234 235 236 237 238 239 240
    }, {
      "description": "Reference to the topology and force fields to be used.",
      "dtypeStr": "r",
      "name": "method_to_topology_ref",
      "referencedSections": [
        "section_topology"
      ],
      "shape": [],
      "superNames": [
        "section_method"
      ]
241
    }, {
242 243 244
      "description": "List of the indexes involved in this constraint. The fist atom has index 1, the last index is number_of_atoms_in_molecule.",
      "dtypeStr": "i",
      "name": "molecule_constraint_atoms",
245
      "shape": [
246 247
        "number_of_molecule_constraints",
        "number_of_atoms_per_molecule_constraint"
248
      ],
249
      "superNames": [
250 251
        "section_molecule_constraint"
      ]
252
    }, {
253 254 255 256
      "description": "Short and unique name for this constraint type. Valid names are described in the [constraint\\_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/constraint-kind).",
      "dtypeStr": "C",
      "name": "molecule_constraint_kind",
      "shape": [],
257
      "superNames": [
258
        "section_molecule_constraint"
259 260
      ]
    }, {
261 262 263 264
      "description": "Explicit constraint parameters for this kind of constraint (depending on the constraint type some might be given implicitly through other means).",
      "dtypeStr": "D",
      "name": "molecule_constraint_parameters",
      "shape": [],
265
      "superNames": [
266
        "section_molecule_constraint"
267 268
      ]
    }, {
Luca's avatar
Luca committed
269
      "description": "List of the indexes involved in this bonded interaction within a molecule. The first atom has index 1, the last index is number_of_atoms_in_.",
270 271
      "dtypeStr": "i",
      "name": "molecule_interaction_atoms",
272
      "shape": [
273 274
        "number_of_molecule_interactions",
        "number_of_atoms_per_molecule_interaction"
275
      ],
276
      "superNames": [
277
        "section_molecule_interaction"
278 279
      ]
    }, {
280 281 282 283
      "description": "Short and unique name for this interaction type, used for bonded interactions for atoms in a molecule. Valid names are described in the [interaction\\_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/interaction-kind).",
      "dtypeStr": "C",
      "name": "molecule_interaction_kind",
      "shape": [],
284
      "superNames": [
285
        "section_molecule_interaction"
286 287
      ]
    }, {
288 289 290 291
      "description": "Explicit interaction parameters for this kind of interaction (depending on the interaction type some might be given implicitly through other means), used for bonded interactions for atoms in a molecule.",
      "dtypeStr": "D",
      "name": "molecule_interaction_parameters",
      "shape": [],
292
      "superNames": [
293
        "section_molecule_interaction"
294
      ]
295
    }, {
296 297 298 299 300 301
      "description": "Mapping from molecules to molecule types.",
      "dtypeStr": "r",
      "name": "molecule_to_molecule_type_map",
      "referencedSections": [
        "section_molecule_type"
      ],
302
      "shape": [
303
        "number_of_topology_molecules"
304
      ],
305
      "superNames": [
306
        "section_topology"
307 308
      ]
    }, {
309
      "description": "Name of the molecule.",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
310
      "dtypeStr": "C",
311
      "name": "molecule_type_name",
312
      "shape": [],
313
      "superNames": [
314
        "section_molecule_type"
315 316
      ]
    }, {
317 318 319 320
      "description": "Number of atoms in this molecule.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_in_molecule",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
321
      "shape": [],
322
      "superNames": [
323
        "section_molecule_type"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
324 325
      ]
    }, {
326
      "description": "Number of atoms involved in this constraint.",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
327
      "dtypeStr": "i",
328 329
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_constraint",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
330 331
      "shape": [],
      "superNames": [
332
        "section_constraint"
333 334
      ]
    }, {
335 336 337 338
      "description": "Number of atoms involved in this interaction.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_interaction",
339 340
      "shape": [],
      "superNames": [
341
        "section_interaction"
342
      ]
343
    }, {
344 345 346 347
      "description": "Number of atoms, in this molecule, involved in this constraint.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_molecule_constraint",
348 349
      "shape": [],
      "superNames": [
350
        "section_molecule_constraint"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
351 352
      ]
    }, {
353 354 355 356
      "description": "Number of atoms, in this molecule, involved in this interaction.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_molecule_interaction",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
357 358
      "shape": [],
      "superNames": [
359
        "section_molecule_interaction"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
360
      ]
Luca's avatar
Luca committed
361 362 363 364 365 366 367 368 369
    }, {
      "description": "String describing the use of the basis set, i.e, if it used for expanding a wavefunction or an electron density. Allowed values are listed in the [basis\\_set\\_kind wiki page](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/basis-set-kind).",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_basis_sets_atom_centered",
      "shape": [],
      "superNames": [
        "section_method_basis_set"
      ]
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
370
    }, {
371 372 373 374
      "description": "Number of constraints of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_constraints",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
375 376
      "shape": [],
      "superNames": [
377
        "section_constraint"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
378
      ]
379
    }, {
380 381 382 383
      "description": "Number of interactions of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_interactions",
384 385
      "shape": [],
      "superNames": [
386 387
        "section_interaction"
      ]
388
    }, {
389 390 391 392
      "description": "Number of constraints of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_molecule_constraints",
393 394
      "shape": [],
      "superNames": [
395
        "section_molecule_constraint"
396
      ]
397
    }, {
398 399 400 401
      "description": "Number of bonded interactions of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_molecule_interactions",
402
      "shape": [],
403
      "superNames": [
404
        "section_molecule_interaction"
405 406
      ]
    }, {
407 408 409 410
      "description": "Number of atoms in the system described by this topology.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_topology_atoms",
411 412
      "shape": [],
      "superNames": [
413
        "section_topology"
414 415
      ]
    }, {
416 417 418 419
      "description": "Number of molecules in the system, as described by this topology.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_topology_molecules",
420 421
      "shape": [],
      "superNames": [
422
        "section_topology"
423
      ]
424
    }, {
425 426 427
      "description": "Section describing a type of atom in the system.",
      "kindStr": "type_section",
      "name": "section_atom_type",
428
      "superNames": [
429
        "section_topology"
430
      ]
431
    }, {
432 433 434
      "description": "Section describing a constraint between arbitrary atoms.",
      "kindStr": "type_section",
      "name": "section_constraint",
435
      "superNames": [
436 437
        "section_topology",
        "settings_constraint"
438 439
      ]
    }, {
440 441 442
      "description": "Section containing the description of a bonded interaction between arbitrary atoms.",
      "kindStr": "type_section",
      "name": "section_interaction",
443
      "superNames": [
444 445
        "section_topology",
        "settings_interaction"
446
      ]
Luca's avatar
Luca committed
447 448 449 450 451 452 453
    }, {
      "description": "This section contains the definition of the basis sets that are defined independently of the atomic configuration.",
      "kindStr": "type_section",
      "name": "section_method_basis_set",
      "superNames": [
        "section_method"
      ]
454
    }, {
455 456 457
      "description": "Section describing a constraint between atoms within a molecule.",
      "kindStr": "type_section",
      "name": "section_molecule_constraint",
458
      "superNames": [
459 460
        "section_molecule_type",
        "settings_constraint"
461 462
      ]
    }, {
463 464 465
      "description": "Section describing a bonded interaction between atoms within a molecule.",
      "kindStr": "type_section",
      "name": "section_molecule_interaction",
466
      "superNames": [
467 468
        "section_molecule_type",
        "settings_interaction"
469
      ]
470
    }, {
471 472 473
      "description": "Section describing a type of molecule in the system.",
      "kindStr": "type_section",
      "name": "section_molecule_type",
474
      "superNames": [
475
        "section_topology"
476
      ]
477
    }, {
478 479 480
      "description": "Section containing the definition of topology (connectivity among atoms in force fileds), force field, and constraints of a system.",
      "kindStr": "type_section",
      "name": "section_topology",
481
      "superNames": [
482
        "section_run"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
483
      ]
484
    }, {
485
      "description": "Parameters of an atom within a molecule.",
486
      "kindStr": "type_abstract_document_content",
487
      "name": "settings_atom_in_molecule",
488
      "superNames": [
489
        "section_molecule_type"
490
      ]
Luca's avatar
Luca committed
491 492 493 494 495 496 497 498 499 500
    }, {
      "description": "Some parameters that describe a constraint",
      "kindStr": "type_abstract_document_content",
      "name": "settings_constraint",
      "superNames": []
    }, {
      "description": "Some parameters that describe a bonded interaction.",
      "kindStr": "type_abstract_document_content",
      "name": "settings_interaction",
      "superNames": []
501
    }, {
502
      "description": "A unique string idenfiying the force field defined in this section. Strategies to define it are discussed in the [topology\\_force\\_field\\_name](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info/wikis/metainfo/topology-force-field-name).",
503 504 505 506 507 508
      "dtypeStr": "C",
      "name": "topology_force_field_name",
      "shape": [],
      "superNames": [
        "section_topology"
      ]
509 510 511 512 513 514 515 516 517 518
    }, {
      "description": "Reference to the topology used for this system; if not given, the trivial topology should be assumed.",
      "dtypeStr": "r",
      "name": "topology_ref",
      "referencedSections": [
        "section_topology"
      ],
      "repeats": false,
      "shape": [],
      "superNames": [
519
        "section_system"
520
      ]
521
    }]
522
}