Commits (3)
# Overrides #
This directory contains a collection of override files.
These files describe the new version of a NomadMetaInfo, by listing old gid and new gid, and can thus introduce versioning for NomadMetaInfo.
The name or other keys can be given, but are only informative and can be omitted.
## File Naming convention ##
Normally overrides are given between two tagged versions or between the last checked in version,
and the current state. so override files are by default given as
<oldVersion>_<newVersion>_YYYY-MM-DD.nomadmetainfo_overrides.json
where *oldVersion* can be the first 10 characters of the git sha, a tag name, or even empty;
just like *newVersion*. *YYYY-MM-DD* is the current date, and if required an "\_n" with a suitable
number *n* that does not clash with existing files can be used.
The extension .nomadmetainfo_overrides.json is mandatory.
## Automatic Generation ##
Normally you can generate these files automatically with scripts/nomadscripts/calculate_meta_info_overrides.py
The script works if the name of the NomadMetaInfo is the same but have differen gid.
## Complex Cases ##
In cases in which you have renamed a NomadMetaInfo or there is a NomadMetaInfo outside the
standard that you want to replace with the standard one you have to create (or complete)
the override file by hand.
In these cases the output with --verbose can be useful.
It is also possible to use scripts/nomadscripts/normalize_local_kinds.py --add-gid to update
each NomadMetaInfo with its gid, which then you can use to create manual override files.
Please do not check in the repository the generated .nomadmetainfo.json files with gid.
{
"type": "nomad_meta_info_1_0",
"description": "Metadata for an atom probe tomography or field ion microscopy experiment.",
"dependencies":[
{
"metainfoPath":"general.nomadmetainfo.json"
},
{
"metainfoPath":"general.experimental.nomadmetainfo.json"
}
],
"metaInfos": [
{
"description": "Shape of the None/Null object",
"name": "none_shape",
"dtypeStr": "i",
"kindStr": "type_dimension",
"shape": [],
"superNames": ["section_experiment"]
},
{
"description": "Name of the equipment, instrument with which the experiment was performed e.g. LEAP5000XS",
"name": "experiment_tool_info",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Operation mode of the instrument (APT, FIM or combination)",
"name": "experiment_operation_method",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Pulsing method to enforce a controlled ion evaporation sequence",
"name": "experiment_imaging_method",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Sample description e.g. pure W wire samples trial 2",
"name": "specimen_description",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Number of elements (disjoint element names) expected",
"name": "number_of_disjoint_elements",
"dtypeStr": "i",
"kindStr": "type_dimension",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "List of periodic table names expected contained in dataset",
"name": "specimen_chemistry",
"dtypeStr": "C",
"shape": ["number_of_elements"],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Qualitative type of specimen and microstructure analyzed (e.g. thin films, nano objects, single crystal, polycrystal)",
"name": "specimen_microstructure",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Qualitative information how many phases in the specimen",
"name": "specimen_constitution",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": ""
},
{
"description": "Number of ions successfully evaporated",
"name": "measured_number_ions_evaporated",
"dtypeStr": "i",
"shape": [],
"superNames": ["section_experiment"],
"units": "1"
},
{
"description": "Detector hit positions x and y",
"name": "measured_detector_hit_pos",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": "mm, mm"
},
{
"description": "Detector hit multiplicity",
"name": "measured_detector_hit_mult",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": "1"
},
{
"description": "Detector number of dead pulses",
"name": "measured_detector_dead_pulses",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": "1"
},
{
"description": "Raw ion time of flight",
"name": "measured_time_of_flight",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": "ns"
},
{
"description": "Standing voltage",
"name": "measured_standing_voltage",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": "V"
},
{
"description": "Pulse voltage",
"name": "measured_pulse_voltage",
"dtypeStr": "C",
"shape": [],
"superNames": ["section_experiment"],
"units": "V"
}
]
}
......@@ -2013,7 +2013,7 @@
]
}, {
"description": "Ramen_tensor",
"description": "Ramen tensor scaled by 0.5",
"dtypeStr": "f",
"name": "x_castep_ramen_tensor",
"shape": [
......@@ -2023,7 +2023,7 @@
"superNames": [
"x_castep_section_raman_tensor"
],
"units": "(A/amu)*0.5"
"units": "A / amu"
}, {
"description": "Temporary storing atom labels",
"dtypeStr": "C",
......