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