Skip to content

Commit

Permalink
Adds docstring extensions for gas_pressure and temperature in NXsample
Browse files Browse the repository at this point in the history
  • Loading branch information
domna authored and lukaspie committed Jul 12, 2024
1 parent 263c872 commit 9ad5e73
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
16 changes: 16 additions & 0 deletions contributed_definitions/NXmpes_liquid.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,22 @@
(users are encouraged to expand on that in group preparation_description).
</doc>
</field>
<field name="temperature" type="NX_NUMBER" optional="true">
<doc>
The temperature set for the liquid jet or the injection assembly.
Details may be added to the preparation description how this
temperature value is obtained
(whether a chiller unit was used, point of cooling, temperature reading etc.)
and where this value would be expected
(estimate for the jet assembly, the liquid prior to injection,
or at the interaction point taking into account evaporative cooling etc.).
</doc>
</field>
<field name="gas_pressure" type="NX_NUMBER" optional="true">
<doc>
Pressure reading in the interaction chamber under operation conditions.
</doc>
</field>
<field name="depends_on" recommended="true">
<doc>
Connects this liquidjet to its transformation chain.
Expand Down
14 changes: 14 additions & 0 deletions contributed_definitions/nyaml/NXmpes_liquid.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,20 @@ NXmpes_liquid(NXmpes):
doc: |
Material the microjet nozzle is made of
(users are encouraged to expand on that in group preparation_description).
temperature(NX_NUMBER):
exists: optional
doc: |
The temperature set for the liquid jet or the injection assembly.
Details may be added to the preparation description how this
temperature value is obtained
(whether a chiller unit was used, point of cooling, temperature reading etc.)
and where this value would be expected
(estimate for the jet assembly, the liquid prior to injection,
or at the interaction point taking into account evaporative cooling etc.).
gas_pressure(NX_NUMBER):
exists: optional
doc: |
Pressure reading in the interaction chamber under operation conditions.
depends_on:
exists: recommended
doc: |
Expand Down

0 comments on commit 9ad5e73

Please sign in to comment.