Skip to content

Commit

Permalink
Prepare nomad examples._
Browse files Browse the repository at this point in the history
  • Loading branch information
RubelMozumder committed Nov 28, 2024
1 parent 033b75a commit 911af69
Show file tree
Hide file tree
Showing 13 changed files with 10,378 additions and 6 deletions.
3,406 changes: 3,406 additions & 0 deletions src/pynxtools_spm/nomad/examples/afm/A151216.123306-02602.sxm

Large diffs are not rendered by default.

276 changes: 276 additions & 0 deletions src/pynxtools_spm/nomad/examples/afm/AFM.scheme.archive.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
definitions:
name: An ELN example for AFM ( Atomic Force Microscopy).
sections:
sts:
base_sections:
- pynxtools.nomad.dataconverter.NexusDataConverter
- nomad.datamodel.data.EntryData
m_annotations:
template:
reader: spm
nxdl: NXafm
eln:
hide: []
quantities:
default:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
The name of the NXdata group that comes as child of the entry group for default plot visualization
to be displayed upon the entry of NeXus file.
definition:
type:
type_kind: Enum
type_data:
- NXafm
m_annotations:
eln:
component: EnumEditQuantity
description: |
Name of the definitions from NeXus app def designed for STS experiments, one can use
NXsts or NXspm, but NXsts is recommended.
scan_mode:
type:
type_kind: Enum
type_data:
- contact mode
- tapping mode
- non-contact mode
- Kelvin probe
- electric force
m_annotations:
eln:
component: EnumEditQuantity
description: |
Mode of scan in AFM experiment.
experiment_description:
type: str
m_annotations:
eln:
component: RichTextEditQuantity
description: |
Descriptive comments for this experiment, added by the experimenter in eln or
coming from the output file, e.g. Comment01 SYNC & Filter LP 8order WITHDRAW
600 steps, locked Au(111), 50pA, 100 mV set point, 1mV DCA, 973Hz,138
1st H, -84 2nd H.
sub_sections:
experiment_identifier:
section:
m_annotations:
eln:
overview: true
quantities:
identifier:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
An unique identifier fot the experiment. e.g. the identifier
could be specific for a lab or experiment team.
collection_identifier:
section:
m_annotations:
eln:
overview: true
quantities:
identifier:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
An unique identifier of a collection. Use this
if the experiment if part of a collection of experiments
user:
section:
m_annotations:
eln:
overview: true
quantities:
name:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
Name of the user who performed the experiment.
affiliation:
type: str
shape: "*"
m_annotations:
eln:
component: StringEditQuantity
description: |
Affiliation of the user who performed the experiment.
email:
type: str
shape: "*"
m_annotations:
eln:
component: StringEditQuantity
description: |
List of emails from users who performed the experiment.
experiment_instrument:
section:
m_annotations:
eln:
overview: true
sub_sections:
hardware:
section:
m_annotations:
eln:
overview: true
quantities:
name:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
Name of the hardware. (e.g. Nanonis).
model:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
Version or model of the component named by the manufacturer (e.g. Nanonis).
model/@version:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
If model has a distinquishable version (e.g. BP5e).
software:
section:
m_annotations:
eln:
overview: true
quantities:
name:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
Name of the software. (e.g. Nanonis).
model:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
Version or model of the component named by the manufacturer (e.g. Nanonis).
model/@version:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
If model has a distinquishable version (e.g. BP5e).
scan_environment:
section:
m_annotations:
eln:
overview: true
quantities:
tip_temp:
type: np.float64
m_annotations:
eln:
component: NumberEditQuantity
defaultDisplayUnit: K
description: |
Temperature of STM head. Note: At least one field from tip_temp,
cryo_bottom_temp and cryo_shield_temp must be provided.
At least one field from tip_temp, cryo_bottom_temp and cryo_shield_temp must be provided.
cryo_bottom_temp:
type: np.float64
m_annotations:
eln:
component: NumberEditQuantity
defaultDisplayUnit: K
description: |
Temperature of the cold tail of the cryostat. Note:
At least one field from tip_temp, cryo_bottom_temp and cryo_shield_temp must be provided.
cryo_shield_temp:
type: np.float64
m_annotations:
eln:
component: NumberEditQuantity
defaultDisplayUnit: K
description: |
Temperature of liquid nitrogen shield. Note: At
least one field from tip_temp, cryo_bottom_temp and cryo_shield_temp.
Sample:
section:
m_annotations:
eln:
overview: true
quantities:
name:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
Name of the sample.
chemical_formula:
type: str
m_annotations:
eln:
component: StringEditQuantity
description: |
The chemical formula specified using CIF conventions.
Abbreviated version of CIF standard:
* Only recognized element symbols may be used.
* Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
* A space or parenthesis must separate each cluster of (element symbol + count).
* Where a group of elements is enclosed in parentheses, the multiplier for the
group must follow the closing parentheses. That is, all element and group
multipliers are assumed to be printed as subscripted numbers.
* Unless the elements are ordered in a manner that corresponds to their chemical
structure, the order of the elements within any group or moiety depends on
whether or not carbon is present.
* If carbon is present, the order should be:
- C, then H, then the other elements in alphabetical order of their symbol.
- If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
* This is the *Hill* system used by Chemical Abstracts.
description:
type: str
m_annotations:
eln:
component: RichTextEditQuantity
description: |
Description of the sample or sample preparation.
sample_component:
type: str
shape: "*"
m_annotations:
eln:
component: StringEditQuantity
description: |
The components of the sample comes as a list of components.
sub_sections:
History:
section:
m_annotations:
eln:
overview: true
quantities:
notes:
type: str
m_annotations:
eln:
component: RichTextEditQuantity
description: |
Notes about the sample history.
Loading

0 comments on commit 911af69

Please sign in to comment.