Skip to content

SECoP: sample environments #1574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
g-guenther wants to merge 23 commits into
base: main
Choose a base branch
from
Open

SECoP: sample environments #1574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
7abdfb4
Adding FELDNAME field to NXobject
gerrit-guenther Jun 25, 2025
99cf307
NXobject: Rewording of the FIELDNAME field.
gerrit-guenther Jun 26, 2025
4367f66
Restore original state
gerrit-guenther Jun 27, 2025
9596b4d
NXsensor: Adding additional options to measurement field
gerrit-guenther Jun 27, 2025
d2201f0
NXsensor: Adding a description field
gerrit-guenther Jun 27, 2025
5a7a987
NXsample: Adding pH, pH_env, and NX_MOLAR_MASS
gerrit-guenther Jun 27, 2025
bfcb75f
NXsample: Adding electric_field_env group
gerrit-guenther Jun 27, 2025
224d4ec
NXsample: Adding current field and current_env group
gerrit-guenther Jun 27, 2025
792e70c
NXsample: Adding conductivity, conductivity_env, and NX_CONDUCTIVITY
gerrit-guenther Jun 27, 2025
2ba6edb
NXsample: Adding resistance, resistance_env, and NX_RESISTANCE
gerrit-guenther Jul 2, 2025
9da4408
NXsample: Adding voltage and voltage_env
gerrit-guenther Jul 2, 2025
4f60aee
NXsample: Changing rank of voltage
gerrit-guenther Jul 2, 2025
5befb15
NXsample: Adding pressure_env
gerrit-guenther Jul 2, 2025
bd99102
NXsample: Adding flow, flow_env, and NX_FLOW
gerrit-guenther Jul 2, 2025
c354fda
NXsample: Adding stress_field_env
gerrit-guenther Jul 2, 2025
fc9461d
NXsample: Adding strain and strain_field_env
gerrit-guenther Jul 2, 2025
0249083
NXsample: Adding shear_field and shear_field_env
gerrit-guenther Jul 2, 2025
1c44f4c
NXsample: Adding surface_pressure and surface_pressure_env
gerrit-guenther Jul 2, 2025
1669b86
NXsample: Adding humidity and humidity_env
gerrit-guenther Jul 2, 2025
7f57d28
NXsample: Adding viscosity, viscosity_env, and NX_PRESSURE_TIME
gerrit-guenther Jul 2, 2025
b950be3
NXsample: Adding concentration_env
gerrit-guenther Jul 2, 2025
05b6ac6
NXsample: Removing magnetic_field NXlog group
gerrit-guenther Jul 3, 2025
9788a8a
NXsensor: Differ between value and value_set
gerrit-guenther Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 143 additions & 3 deletions base_classes/NXsample.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@
<symbol name="n_mField"><doc>number of values in applied magnetic field</doc></symbol>
<symbol name="n_pField"><doc>number of values in applied pressure field</doc></symbol>
<symbol name="n_sField"><doc>number of values in applied stress field</doc></symbol>
<symbol name="n_pH"><doc>number of pH values</doc></symbol>
<symbol name="n_curr"><doc>number of current values</doc></symbol>
<symbol name="n_cond"><doc>number of conductivity values</doc></symbol>
<symbol name="n_resist"><doc>number of resistance values</doc></symbol>
<symbol name="n_volt"><doc>number of voltage values</doc></symbol>
<symbol name="n_flow"><doc>number of flow rates</doc></symbol>
<symbol name="n_strainField"><doc>number of values in applied strain field</doc></symbol>
<symbol name="n_shearField"><doc>number of shear values</doc></symbol>
<symbol name="n_spField"><doc>number of values in applied surface pressure field</doc></symbol>
<symbol name="n_hum"><doc>number of humidity values</doc></symbol>
<symbol name="n_vis"><doc>number of viscosity values</doc></symbol>
</symbols>

<doc>
Expand Down Expand Up @@ -121,6 +132,93 @@
<dim index="1" value="n_pField"/><!-- could be any length -->
</dimensions>
</field>
<field name="pH" type="NX_FLOAT" units="NX_MOLAR_DENSITY">
<doc>Sample pH value</doc>
<dimensions>
<dim index="1" value="n_pH"/><!-- could be any length -->
</dimensions>
</field>
<field name="current" type="NX_FLOAT" units="NX_CURRENT">
<doc>Applied current</doc>
<dimensions>
<dim index="1" value="n_curr"/><!-- could be any length -->
</dimensions>
</field>
<field name="conductivity" type="NX_FLOAT" units="NX_CONDUCTIVITY">
<doc>Sample electrical conductivity</doc>
<dimensions>
<dim index="1" value="n_cond"/><!-- could be any length -->
</dimensions>
</field>
<field name="resistance" type="NX_FLOAT" units="NX_RESISTANCE">
<doc>Sample electrical resistance</doc>
<dimensions>
<dim index="1" value="n_resist"/><!-- could be any length -->
</dimensions>
</field>
<field name="voltage" type="NX_FLOAT" units="NX_VOLTAGE">
<doc>Applied voltage</doc>
<dimensions>
<dim index="1" value="n_volt"/><!-- could be any length -->
</dimensions>
</field>
<field name="flow" type="NX_FLOAT" units="NX_FLOW">
<doc>Sample flow rate</doc>
<dimensions>
<dim index="1" value="n_flow"/><!-- could be any length -->
</dimensions>
</field>
<field name="strain_field" type="NX_FLOAT" units="NX_DIMENSIONLESS">
<doc>Sample strain field</doc>
<dimensions>
<dim index="1" value="n_strainField"/><!-- could be any length -->
</dimensions>
<attribute name="direction">
<enumeration>
<item value="x"/>
<item value="y"/>
<item value="z"/>
</enumeration>
</attribute>
</field>
<field name="shear_field" type="NX_FLOAT" units="NX_PRESSURE">
<doc>Sample shear stress field</doc>
<dimensions>
<dim index="1" value="n_shearField"/><!-- could be any length -->
</dimensions>
<attribute name="direction">
<enumeration>
<item value="x"/>
<item value="y"/>
<item value="z"/>
</enumeration>
</attribute>
</field>
<field name="surface_pressure" type="NX_FLOAT" units="NX_PRESSURE">
<doc>Sample surface pressure field</doc>
<dimensions>
<dim index="1" value="n_spField"/><!-- could be any length -->
</dimensions>
<attribute name="direction">
<enumeration>
<item value="x"/>
<item value="y"/>
<item value="z"/>
</enumeration>
</attribute>
</field>
<field name="humidity" type="NX_FLOAT" units="NX_DIMENSIONLESS">
<doc>Sample humidity</doc>
<dimensions>
<dim index="1" value="n_hum"/><!-- could be any length -->
</dimensions>
</field>
<field name="viscosity" type="NX_FLOAT" units="NX_PRESSURE_TIME">
<doc>Sample viscosity</doc>
<dimensions>
<dim index="1" value="n_vis"/><!-- could be any length -->
</dimensions>
</field>
<field name="changer_position" type="NX_INT" units="NX_UNITLESS">
<doc>Sample changer position</doc>
</field>
Expand Down Expand Up @@ -338,16 +436,58 @@
<group name="temperature_env" type="NXenvironment">
<doc>Additional sample temperature environment information</doc>
</group>
<group name="magnetic_field" type="NXlog">
<doc>magnetic_field.value is a link to e.g. magnetic_field_env.sensor1.value</doc>
</group>
<group name="magnetic_field_log" type="NXlog"
deprecated="use ``magnetic_field``, see: https://github.com/nexusformat/definitions/issues/816">
<doc>magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value</doc>
</group>
<group name="magnetic_field_env" type="NXenvironment">
<doc>Additional sample magnetic environment information</doc>
</group>
<group name="pH_env" type="NXenvironment">
<doc>Additional sample pH environment information</doc>
</group>
<group name="pressure_env" type="NXenvironment">
<doc>Additional sample pressure environment information</doc>
</group>
<group name="electric_field_env" type="NXenvironment">
<doc>Additional sample electric field environment information</doc>
</group>
<group name="current_env" type="NXenvironment">
<doc>Additional sample current environment information</doc>
</group>
<group name="conductivity_env" type="NXenvironment">
<doc>Additional sample conductivity environment information</doc>
</group>
<group name="resistance_env" type="NXenvironment">
<doc>Additional sample resistance environment information</doc>
</group>
<group name="voltage_env" type="NXenvironment">
<doc>Additional sample voltage environment information</doc>
</group>
<group name="flow_env" type="NXenvironment">
<doc>Additional sample flow environment information</doc>
</group>
<group name="stress_field_env" type="NXenvironment">
<doc>Additional sample stress field environment information</doc>
</group>
<group name="strain_field_env" type="NXenvironment">
<doc>Additional sample strain field environment information</doc>
</group>
<group name="shear_field_env" type="NXenvironment">
<doc>Additional sample shear stress field environment information</doc>
</group>
<group name="surface_pressure_env" type="NXenvironment">
<doc>Additional sample surface pressure field environment information</doc>
</group>
<group name="humidity_env" type="NXenvironment">
<doc>Additional sample humidity environment information</doc>
</group>
<group name="viscosity_env" type="NXenvironment">
<doc>Additional sample viscosity environment information</doc>
</group>
<group name="concentration_env" type="NXenvironment">
<doc>Additional sample concentration environment information</doc>
</group>
<field name="external_DAC" type="NX_FLOAT" units="NX_ANY">
<doc>value sent to user's sample setup</doc>
</field>
Expand Down
16 changes: 12 additions & 4 deletions base_classes/NXsensor.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@
<field name="short_name">
<doc>Short name of sensor used e.g. on monitor display program</doc>
</field>
<field name="description">
<doc>
Description of the sensor
</doc>
</field>
<field name="attached_to">
<doc>where sensor is attached to ("sample" | "can")</doc>
</field>
Expand All @@ -65,6 +70,9 @@
<item value="strain" />
<item value="shear" />
<item value="surface_pressure" />
<item value="humidity" />
<item value="viscosity" />
<item value="concentration" />
</enumeration>
</field>
<field name="type">
Expand Down Expand Up @@ -102,16 +110,16 @@
</field>
<field name="value" type="NX_FLOAT" units="NX_ANY">
<doc>
nominal setpoint or average value
- need [n] as may be a vector
Average value of the sensor - need [n] as may be a vector.
For a nominal setpoint use the generally defined value_set field.
</doc>
<dimensions>
<dim index="1" value="n"/>
</dimensions>
</field>
<field name="value_deriv1" type="NX_FLOAT" units="NX_ANY">
<doc>
Nominal/average first derivative of value
Average first derivative of value
e.g. strain rate
- same dimensions as "value" (may be a vector)
</doc>
Expand All @@ -121,7 +129,7 @@
</field>
<field name="value_deriv2" type="NX_FLOAT" units="NX_ANY">
<doc>
Nominal/average second derivative of value
Average second derivative of value
- same dimensions as "value" (may be a vector)
</doc>
<dimensions>
Expand Down
65 changes: 60 additions & 5 deletions nxdlTypes.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,23 +54,28 @@
nxdl:NX_AREA
nxdl:NX_CROSS_SECTION
nxdl:NX_CHARGE
nxdl:NX_CONDUCTIVITY
nxdl:NX_COUNT
nxdl:NX_CURRENT
nxdl:NX_DIMENSIONLESS
nxdl:NX_EMITTANCE
nxdl:NX_ENERGY
nxdl:NX_FLOW
nxdl:NX_FLUX
nxdl:NX_FREQUENCY
nxdl:NX_LENGTH
nxdl:NX_MASS
nxdl:NX_MASS_DENSITY
nxdl:NX_MOLAR_DENSITY
nxdl:NX_MOLECULAR_WEIGHT
nxdl:NX_PER_AREA
nxdl:NX_PER_LENGTH
nxdl:NX_PERIOD
nxdl:NX_POWER
nxdl:NX_PRESSURE
nxdl:NX_PRESSURE_TIME
nxdl:NX_PULSES
nxdl:NX_COUNT
nxdl:NX_RESISTANCE
nxdl:NX_SCATTERING_LENGTH_DENSITY
nxdl:NX_SOLID_ANGLE
nxdl:NX_TEMPERATURE
Expand Down Expand Up @@ -115,7 +120,17 @@
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>


<xs:simpleType name="NX_CONDUCTIVITY">
<xs:annotation>
<xs:documentation>
units of electrical conductivity
<xs:element name="example">S/m</xs:element>
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>

<xs:simpleType name="NX_COUNT">
<xs:annotation>
<xs:documentation>
Expand Down Expand Up @@ -188,7 +203,17 @@
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>


<xs:simpleType name="NX_FLOW">
<xs:annotation>
<xs:documentation>
units of volumetric or mass flow rate
<xs:element name="example">m^3/s, kg/s</xs:element>
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>

<xs:simpleType name="NX_FLUX">
<xs:annotation>
<xs:documentation>
Expand Down Expand Up @@ -238,6 +263,16 @@
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>

<xs:simpleType name="NX_MOLAR_DENSITY">
<xs:annotation>
<xs:documentation>
units of molar concentration
<xs:element name="example">mol/L</xs:element>
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>

<xs:simpleType name="NX_MOLECULAR_WEIGHT">
<xs:annotation>
Expand Down Expand Up @@ -299,7 +334,17 @@
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>


<xs:simpleType name="NX_PRESSURE_TIME">
<xs:annotation>
<xs:documentation>
units of pressure multiplied by time
<xs:element name="example">Pa * s</xs:element>
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>

<xs:simpleType name="NX_PULSES">
<xs:annotation>
<xs:documentation>
Expand All @@ -310,7 +355,17 @@
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>


<xs:simpleType name="NX_RESISTANCE">
<xs:annotation>
<xs:documentation>
units of electrical resistance
<xs:element name="example">ohm</xs:element>
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>

<xs:simpleType name="NX_SCATTERING_LENGTH_DENSITY">
<xs:annotation>
<xs:documentation>
Expand Down