common.nomadmetainfo.json 16.3 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 126 127 128 129 130 131 132 133 134 135
    }, {
      "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"
    }, {
      "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"
136
    }, {
137
      "description": "List of the indexes involved in this interaction. The fist atom has index 1, the last atom index number_of_topology_atoms.",
138
      "dtypeStr": "i",
139
      "name": "interaction_atoms",
140
      "shape": [
141 142
        "number_of_interactions",
        "number_of_atoms_per_interaction"
143 144
      ],
      "superNames": [
145
        "section_interaction"
146
      ]
147
    }, {
148
      "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).",
149
      "dtypeStr": "C",
150
      "name": "interaction_kind",
151 152
      "shape": [],
      "superNames": [
153
        "section_interaction"
154
      ]
155
    }, {
156 157 158 159
      "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": [],
160
      "superNames": [
161
        "section_interaction"
162
      ]
Luca's avatar
Luca committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
    }, {
      "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": [
        "section_basis_set_cell_associated"
      ],
      "shape": [],
      "superNames": [
        "section_method_basis_set"
      ]
    }, {
      "description": "",
      "dtypeStr": "C",
      "name": "method_basis_set_kind",
      "shape": [],
      "superNames": [
        "section_method_basis_set"
      ]
Luca's avatar
Luca committed
197 198 199 200 201 202 203 204 205 206 207
    }, {
      "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"
      ]
208
    }, {
209 210 211
      "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",
212
      "shape": [
213 214
        "number_of_molecule_constraints",
        "number_of_atoms_per_molecule_constraint"
215
      ],
216
      "superNames": [
217 218
        "section_molecule_constraint"
      ]
219
    }, {
220 221 222 223
      "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": [],
224
      "superNames": [
225
        "section_molecule_constraint"
226 227
      ]
    }, {
228 229 230 231
      "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": [],
232
      "superNames": [
233
        "section_molecule_constraint"
234 235
      ]
    }, {
Luca's avatar
Luca committed
236
      "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_.",
237 238
      "dtypeStr": "i",
      "name": "molecule_interaction_atoms",
239
      "shape": [
240 241
        "number_of_molecule_interactions",
        "number_of_atoms_per_molecule_interaction"
242
      ],
243
      "superNames": [
244
        "section_molecule_interaction"
245 246
      ]
    }, {
247 248 249 250
      "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": [],
251
      "superNames": [
252
        "section_molecule_interaction"
253 254
      ]
    }, {
255 256 257 258
      "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": [],
259
      "superNames": [
260
        "section_molecule_interaction"
261
      ]
262
    }, {
263 264 265 266 267 268
      "description": "Mapping from molecules to molecule types.",
      "dtypeStr": "r",
      "name": "molecule_to_molecule_type_map",
      "referencedSections": [
        "section_molecule_type"
      ],
269
      "shape": [
270
        "number_of_topology_molecules"
271
      ],
272
      "superNames": [
273
        "section_topology"
274 275
      ]
    }, {
276
      "description": "Name of the molecule.",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
277
      "dtypeStr": "C",
278
      "name": "molecule_type_name",
279
      "shape": [],
280
      "superNames": [
281
        "section_molecule_type"
282 283
      ]
    }, {
284 285 286 287
      "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
288
      "shape": [],
289
      "superNames": [
290
        "section_molecule_type"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
291 292
      ]
    }, {
293
      "description": "Number of atoms involved in this constraint.",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
294
      "dtypeStr": "i",
295 296
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_constraint",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
297 298
      "shape": [],
      "superNames": [
299
        "section_constraint"
300 301
      ]
    }, {
302 303 304 305
      "description": "Number of atoms involved in this interaction.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_interaction",
306 307
      "shape": [],
      "superNames": [
308
        "section_interaction"
309
      ]
310
    }, {
311 312 313 314
      "description": "Number of atoms, in this molecule, involved in this constraint.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_molecule_constraint",
315 316
      "shape": [],
      "superNames": [
317
        "section_molecule_constraint"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
318 319
      ]
    }, {
320 321 322 323
      "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
324 325
      "shape": [],
      "superNames": [
326
        "section_molecule_interaction"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
327
      ]
Luca's avatar
Luca committed
328 329 330 331 332 333 334 335 336
    }, {
      "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
337
    }, {
338 339 340 341
      "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
342 343
      "shape": [],
      "superNames": [
344
        "section_constraint"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
345
      ]
346
    }, {
347 348 349 350
      "description": "Number of interactions of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_interactions",
351 352
      "shape": [],
      "superNames": [
353 354
        "section_interaction"
      ]
355
    }, {
356 357 358 359
      "description": "Number of constraints of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_molecule_constraints",
360 361
      "shape": [],
      "superNames": [
362
        "section_molecule_constraint"
363
      ]
364
    }, {
365 366 367 368
      "description": "Number of bonded interactions of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_molecule_interactions",
369
      "shape": [],
370
      "superNames": [
371
        "section_molecule_interaction"
372 373
      ]
    }, {
374 375 376 377
      "description": "Number of atoms in the system described by this topology.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_topology_atoms",
378 379
      "shape": [],
      "superNames": [
380
        "section_topology"
381 382
      ]
    }, {
383 384 385 386
      "description": "Number of molecules in the system, as described by this topology.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_topology_molecules",
387 388
      "shape": [],
      "superNames": [
389
        "section_topology"
390
      ]
391
    }, {
392 393 394
      "description": "Section describing a type of atom in the system.",
      "kindStr": "type_section",
      "name": "section_atom_type",
395
      "superNames": [
396
        "section_topology"
397
      ]
398
    }, {
399 400 401
      "description": "Section describing a constraint between arbitrary atoms.",
      "kindStr": "type_section",
      "name": "section_constraint",
402
      "superNames": [
403 404
        "section_topology",
        "settings_constraint"
405 406
      ]
    }, {
407 408 409
      "description": "Section containing the description of a bonded interaction between arbitrary atoms.",
      "kindStr": "type_section",
      "name": "section_interaction",
410
      "superNames": [
411 412
        "section_topology",
        "settings_interaction"
413
      ]
Luca's avatar
Luca committed
414 415 416 417 418 419 420
    }, {
      "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"
      ]
421
    }, {
422 423 424
      "description": "Section describing a constraint between atoms within a molecule.",
      "kindStr": "type_section",
      "name": "section_molecule_constraint",
425
      "superNames": [
426 427
        "section_molecule_type",
        "settings_constraint"
428 429
      ]
    }, {
430 431 432
      "description": "Section describing a bonded interaction between atoms within a molecule.",
      "kindStr": "type_section",
      "name": "section_molecule_interaction",
433
      "superNames": [
434 435
        "section_molecule_type",
        "settings_interaction"
436
      ]
437
    }, {
438 439 440
      "description": "Section describing a type of molecule in the system.",
      "kindStr": "type_section",
      "name": "section_molecule_type",
441
      "superNames": [
442
        "section_topology"
443
      ]
444
    }, {
445 446 447
      "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",
448
      "superNames": [
449
        "section_run"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
450
      ]
451
    }, {
452
      "description": "Parameters of an atom within a molecule.",
453
      "kindStr": "type_abstract_document_content",
454
      "name": "settings_atom_in_molecule",
455
      "superNames": [
456
        "section_molecule_type"
457
      ]
Luca's avatar
Luca committed
458 459 460 461 462 463 464 465 466 467
    }, {
      "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": []
468
    }, {
469
      "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).",
470 471 472 473 474 475
      "dtypeStr": "C",
      "name": "topology_force_field_name",
      "shape": [],
      "superNames": [
        "section_topology"
      ]
476 477 478 479 480 481 482 483 484 485 486 487
    }, {
      "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": [
        "section_system_description"
      ]
488
    }]
489
}