common.nomadmetainfo.json 14.5 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
    }, {
      "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"
      ]
174
    }, {
175 176 177
      "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",
178
      "shape": [
179 180
        "number_of_molecule_constraints",
        "number_of_atoms_per_molecule_constraint"
181
      ],
182
      "superNames": [
183 184
        "section_molecule_constraint"
      ]
185
    }, {
186 187 188 189
      "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": [],
190
      "superNames": [
191
        "section_molecule_constraint"
192 193
      ]
    }, {
194 195 196 197
      "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": [],
198
      "superNames": [
199
        "section_molecule_constraint"
200 201
      ]
    }, {
Luca's avatar
Luca committed
202
      "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_.",
203 204
      "dtypeStr": "i",
      "name": "molecule_interaction_atoms",
205
      "shape": [
206 207
        "number_of_molecule_interactions",
        "number_of_atoms_per_molecule_interaction"
208
      ],
209
      "superNames": [
210
        "section_molecule_interaction"
211 212
      ]
    }, {
213 214 215 216
      "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": [],
217
      "superNames": [
218
        "section_molecule_interaction"
219 220
      ]
    }, {
221 222 223 224
      "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": [],
225
      "superNames": [
226
        "section_molecule_interaction"
227
      ]
228
    }, {
229 230 231 232 233 234
      "description": "Mapping from molecules to molecule types.",
      "dtypeStr": "r",
      "name": "molecule_to_molecule_type_map",
      "referencedSections": [
        "section_molecule_type"
      ],
235
      "shape": [
236
        "number_of_topology_molecules"
237
      ],
238
      "superNames": [
239
        "section_topology"
240 241
      ]
    }, {
242
      "description": "Name of the molecule.",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
243
      "dtypeStr": "C",
244
      "name": "molecule_type_name",
245
      "shape": [],
246
      "superNames": [
247
        "section_molecule_type"
248 249
      ]
    }, {
250 251 252 253
      "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
254
      "shape": [],
255
      "superNames": [
256
        "section_molecule_type"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
257 258
      ]
    }, {
259
      "description": "Number of atoms involved in this constraint.",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
260
      "dtypeStr": "i",
261 262
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_constraint",
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
263 264
      "shape": [],
      "superNames": [
265
        "section_constraint"
266 267
      ]
    }, {
268 269 270 271
      "description": "Number of atoms involved in this interaction.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_interaction",
272 273
      "shape": [],
      "superNames": [
274
        "section_interaction"
275
      ]
276
    }, {
277 278 279 280
      "description": "Number of atoms, in this molecule, involved in this constraint.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_atoms_per_molecule_constraint",
281 282
      "shape": [],
      "superNames": [
283
        "section_molecule_constraint"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
284 285
      ]
    }, {
286 287 288 289
      "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
290 291
      "shape": [],
      "superNames": [
292
        "section_molecule_interaction"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
293 294
      ]
    }, {
295 296 297 298
      "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
299 300
      "shape": [],
      "superNames": [
301
        "section_constraint"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
302
      ]
303
    }, {
304 305 306 307
      "description": "Number of interactions of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_interactions",
308 309
      "shape": [],
      "superNames": [
310 311
        "section_interaction"
      ]
312
    }, {
313 314 315 316
      "description": "Number of constraints of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_molecule_constraints",
317 318
      "shape": [],
      "superNames": [
319
        "section_molecule_constraint"
320
      ]
321
    }, {
322 323 324 325
      "description": "Number of bonded interactions of this type.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_molecule_interactions",
326
      "shape": [],
327
      "superNames": [
328
        "section_molecule_interaction"
329 330
      ]
    }, {
331 332 333 334
      "description": "Number of atoms in the system described by this topology.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_topology_atoms",
335 336
      "shape": [],
      "superNames": [
337
        "section_topology"
338 339
      ]
    }, {
340 341 342 343
      "description": "Number of molecules in the system, as described by this topology.",
      "dtypeStr": "i",
      "kindStr": "type_dimension",
      "name": "number_of_topology_molecules",
344 345
      "shape": [],
      "superNames": [
346
        "section_topology"
347
      ]
348
    }, {
349 350 351
      "description": "Section describing a type of atom in the system.",
      "kindStr": "type_section",
      "name": "section_atom_type",
352
      "superNames": [
353
        "section_topology"
354
      ]
355
    }, {
356 357 358
      "description": "Section describing a constraint between arbitrary atoms.",
      "kindStr": "type_section",
      "name": "section_constraint",
359
      "superNames": [
360 361
        "section_topology",
        "settings_constraint"
362 363
      ]
    }, {
364 365 366
      "description": "Section containing the description of a bonded interaction between arbitrary atoms.",
      "kindStr": "type_section",
      "name": "section_interaction",
367
      "superNames": [
368 369
        "section_topology",
        "settings_interaction"
370
      ]
371
    }, {
372 373 374
      "description": "Section describing a constraint between atoms within a molecule.",
      "kindStr": "type_section",
      "name": "section_molecule_constraint",
375
      "superNames": [
376 377
        "section_molecule_type",
        "settings_constraint"
378 379
      ]
    }, {
380 381 382
      "description": "Section describing a bonded interaction between atoms within a molecule.",
      "kindStr": "type_section",
      "name": "section_molecule_interaction",
383
      "superNames": [
384 385
        "section_molecule_type",
        "settings_interaction"
386
      ]
387
    }, {
388 389 390
      "description": "Section describing a type of molecule in the system.",
      "kindStr": "type_section",
      "name": "section_molecule_type",
391
      "superNames": [
392
        "section_topology"
393
      ]
394
    }, {
395 396 397
      "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",
398
      "superNames": [
399
        "section_run"
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
400
      ]
401
    }, {
402
      "description": "Parameters of an atom within a molecule.",
403
      "kindStr": "type_abstract_document_content",
404
      "name": "settings_atom_in_molecule",
405
      "superNames": [
406
        "section_molecule_type"
407
      ]
Luca's avatar
Luca committed
408 409 410 411 412 413 414 415 416 417
    }, {
      "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": []
418
    }, {
419
      "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).",
420 421 422 423 424 425
      "dtypeStr": "C",
      "name": "topology_force_field_name",
      "shape": [],
      "superNames": [
        "section_topology"
      ]
426 427 428 429 430 431 432 433 434 435 436 437
    }, {
      "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"
      ]
438
    }]
439
}