.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXarchive.nxdl.xml -- DO NOT EDIT .. index:: ! NXarchive (application definition) ! archive (application definition) see: archive (application definition); NXarchive .. _NXarchive: ========= NXarchive ========= .. Contributors List .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: This is a definition for data to be archived by ICAT (http://www.icatproject.org ... This is a definition for data to be archived by ICAT (http://www.icatproject.org/). .. text from the icatproject.org site the database (with supporting software) that provides an interface to all ISIS experimental data and will provide a mechanism to link all aspects of ISIS research from proposal through to publication. **Symbols**: No symbol table **Groups cited**: :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXsample`, :ref:`NXsource`, :ref:`NXuser` .. index:: NXentry (base class); used in application definition, NXuser (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXsample (base class); used in application definition **Structure**: .. _/NXarchive/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXarchive/entry@index-attribute: .. index:: index (group attribute) **@index**: (required) :ref:`NX_CHAR ` .. _/NXarchive/entry/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarchive/entry/experiment_identifier-field: .. index:: experiment_identifier (field) **experiment_identifier**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` unique identifier for the experiment .. _/NXarchive/entry/experiment_description-field: .. index:: experiment_description (field) **experiment_description**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Brief description of the experiment and its objectives .. _/NXarchive/entry/collection_identifier-field: .. index:: collection_identifier (field) **collection_identifier**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` ID of user or DAQ define group of data files .. _/NXarchive/entry/collection_description-field: .. index:: collection_description (field) **collection_description**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Brief summary of the collection, including grouping criteria .. _/NXarchive/entry/entry_identifier-field: .. index:: entry_identifier (field) **entry_identifier**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` unique identifier for this measurement as provided by the facility .. _/NXarchive/entry/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXarchive/entry/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXarchive/entry/duration-field: .. index:: duration (field) **duration**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} TODO: needs documentation .. _/NXarchive/entry/collection_time-field: .. index:: collection_time (field) **collection_time**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} :ref:`⤆ ` TODO: needs documentation .. _/NXarchive/entry/run_cycle-field: .. index:: run_cycle (field) **run_cycle**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` TODO: needs documentation .. _/NXarchive/entry/revision-field: .. index:: revision (field) **revision**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` revision ID of this file, may be after recalibration, reprocessing etc. .. _/NXarchive/entry/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Official NeXus NXDL schema to which this file conforms ... Official NeXus NXDL schema to which this file conforms Obligatory value: ``NXarchive`` .. _/NXarchive/entry/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` The program and version used for generating this file .. _/NXarchive/entry/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXarchive/entry/release_date-field: .. index:: release_date (field) **release_date**: (required) :ref:`NX_CHAR ` {units=\ :ref:`NX_TIME `} when this file is to be released into PD .. _/NXarchive/entry/user-group: **user**: (required) :ref:`NXuser` :ref:`⤆ ` .. _/NXarchive/entry/user/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarchive/entry/user/role-field: .. index:: role (field) **role**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` role of the user .. _/NXarchive/entry/user/facility_user_id-field: .. index:: facility_user_id (field) **facility_user_id**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` ID of the user in the facility burocracy database .. _/NXarchive/entry/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXarchive/entry/instrument/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarchive/entry/instrument/description-field: .. index:: description (field) **description**: (required) :ref:`NX_CHAR ` Brief description of the instrument .. _/NXarchive/entry/instrument/SOURCE-group: **SOURCE**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXarchive/entry/instrument/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: * ``Spallation Neutron Source`` * ``Pulsed Reactor Neutron Source`` * ``Reactor Neutron Source`` * ``Synchrotron X-Ray Source`` * ``Pulsed Muon Source`` * ``Rotating Anode X-Ray`` * ``Fixed Tube X-Ray`` .. _/NXarchive/entry/instrument/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarchive/entry/instrument/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` | ``electron`` .. _/NXarchive/entry/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXarchive/entry/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXarchive/entry/sample/sample_id-field: .. index:: sample_id (field) **sample_id**: (required) :ref:`NX_CHAR ` Unique database id of the sample .. _/NXarchive/entry/sample/description-field: .. index:: description (field) **description**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarchive/entry/sample/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: * ``sample`` * ``sample+can`` * ``calibration sample`` * ``normalisation sample`` * ``simulated data`` * ``none`` * ``sample_environment`` .. _/NXarchive/entry/sample/chemical_formula-field: .. index:: chemical_formula (field) **chemical_formula**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Chemical formula formatted according to CIF conventions .. _/NXarchive/entry/sample/preparation_date-field: .. index:: preparation_date (field) **preparation_date**: (required) :ref:`NX_CHAR ` {units=\ :ref:`NX_TIME `} .. _/NXarchive/entry/sample/situation-field: .. index:: situation (field) **situation**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Description of the environment the sample is in: ... Description of the environment the sample is in: air, vacuum, oxidizing atmosphere, dehydrated, etc. .. _/NXarchive/entry/sample/temperature-field: .. index:: temperature (field) **temperature**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TEMPERATURE `} :ref:`⤆ ` .. _/NXarchive/entry/sample/magnetic_field-field: .. index:: magnetic_field (field) **magnetic_field**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_CURRENT `} :ref:`⤆ ` .. _/NXarchive/entry/sample/electric_field-field: .. index:: electric_field (field) **electric_field**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} :ref:`⤆ ` .. _/NXarchive/entry/sample/stress_field-field: .. index:: stress_field (field) **stress_field**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` .. _/NXarchive/entry/sample/pressure-field: .. index:: pressure (field) **pressure**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_PRESSURE `} :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXarchive/entry-group ` * :ref:`/NXarchive/entry/collection_description-field ` * :ref:`/NXarchive/entry/collection_identifier-field ` * :ref:`/NXarchive/entry/collection_time-field ` * :ref:`/NXarchive/entry/definition-field ` * :ref:`/NXarchive/entry/duration-field ` * :ref:`/NXarchive/entry/end_time-field ` * :ref:`/NXarchive/entry/entry_identifier-field ` * :ref:`/NXarchive/entry/experiment_description-field ` * :ref:`/NXarchive/entry/experiment_identifier-field ` * :ref:`/NXarchive/entry/instrument-group ` * :ref:`/NXarchive/entry/instrument/description-field ` * :ref:`/NXarchive/entry/instrument/name-field ` * :ref:`/NXarchive/entry/instrument/SOURCE-group ` * :ref:`/NXarchive/entry/instrument/SOURCE/name-field ` * :ref:`/NXarchive/entry/instrument/SOURCE/probe-field ` * :ref:`/NXarchive/entry/instrument/SOURCE/type-field ` * :ref:`/NXarchive/entry/program-field ` * :ref:`/NXarchive/entry/program@version-attribute ` * :ref:`/NXarchive/entry/release_date-field ` * :ref:`/NXarchive/entry/revision-field ` * :ref:`/NXarchive/entry/run_cycle-field ` * :ref:`/NXarchive/entry/sample-group ` * :ref:`/NXarchive/entry/sample/chemical_formula-field ` * :ref:`/NXarchive/entry/sample/description-field ` * :ref:`/NXarchive/entry/sample/electric_field-field ` * :ref:`/NXarchive/entry/sample/magnetic_field-field ` * :ref:`/NXarchive/entry/sample/name-field ` * :ref:`/NXarchive/entry/sample/preparation_date-field ` * :ref:`/NXarchive/entry/sample/pressure-field ` * :ref:`/NXarchive/entry/sample/sample_id-field ` * :ref:`/NXarchive/entry/sample/situation-field ` * :ref:`/NXarchive/entry/sample/stress_field-field ` * :ref:`/NXarchive/entry/sample/temperature-field ` * :ref:`/NXarchive/entry/sample/type-field ` * :ref:`/NXarchive/entry/start_time-field ` * :ref:`/NXarchive/entry/title-field ` * :ref:`/NXarchive/entry/user-group ` * :ref:`/NXarchive/entry/user/facility_user_id-field ` * :ref:`/NXarchive/entry/user/name-field ` * :ref:`/NXarchive/entry/user/role-field ` * :ref:`/NXarchive/entry@index-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXarchive.nxdl.xml