.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source ../../../../applications/NXarchive.nxdl.xml

.. index::
    ! NXarchive (application definition)
    ! archive (application definition)
    see: archive (application definition); NXarchive

.. _NXarchive:

=========
NXarchive
=========

**Status**:

  application definition, extends :ref:`NXobject`, version 1.0b

**Description**:

  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**:

  **entry**: :ref:`NXentry`


    .. index:: index (attribute)

    **@index**: :ref:`NX_CHAR <NX_CHAR>`


    .. index:: title (data field)

    **title**: :ref:`NX_CHAR <NX_CHAR>`


    .. index:: experiment_identifier (data field)

    **experiment_identifier**: :ref:`NX_CHAR <NX_CHAR>`

      unique identifier for the experiment

    .. index:: experiment_description (data field)

    **experiment_description**: :ref:`NX_CHAR <NX_CHAR>`

      Brief description of the experiment and its objectives

    .. index:: collection_identifier (data field)

    **collection_identifier**: :ref:`NX_CHAR <NX_CHAR>`

      ID of user or DAQ define group of data files

    .. index:: collection_description (data field)

    **collection_description**: :ref:`NX_CHAR <NX_CHAR>`

      Brief summary of the collection, including grouping criteria

    .. index:: entry_identifier (data field)

    **entry_identifier**: :ref:`NX_CHAR <NX_CHAR>`

      unique identifier for this measurement as provided by the facility

    .. index:: start_time (data field)

    **start_time**: :ref:`NX_DATE_TIME <NX_DATE_TIME>`


    .. index:: end_time (data field)

    **end_time**: :ref:`NX_DATE_TIME <NX_DATE_TIME>`


    .. index:: duration (data field)

    **duration**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`}

      TODO: needs documentation

    .. index:: collection_time (data field)

    **collection_time**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`}

      TODO: needs documentation

    .. index:: run_cycle (data field)

    **run_cycle**: :ref:`NX_CHAR <NX_CHAR>`

      TODO: needs documentation

    .. index:: revision (data field)

    **revision**: :ref:`NX_CHAR <NX_CHAR>`

      revision ID of this file, may be after recalibration, reprocessing etc.

    .. index:: definition (data field)

    **definition**: :ref:`NX_CHAR <NX_CHAR>`

      Official NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXarchive``

    .. index:: program (data field)

    **program**: :ref:`NX_CHAR <NX_CHAR>`

      The program and version used for generating this file

      .. index:: version (attribute)

      **@version**: :ref:`NX_CHAR <NX_CHAR>`


    .. index:: release_date (data field)

    **release_date**: :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_TIME <NX_TIME>`}

      when this file is to be released into PD

    **user**: :ref:`NXuser`


      .. index:: name (data field)

      **name**: :ref:`NX_CHAR <NX_CHAR>`


      .. index:: role (data field)

      **role**: :ref:`NX_CHAR <NX_CHAR>`

        role of the user

      .. index:: facility_user_id (data field)

      **facility_user_id**: :ref:`NX_CHAR <NX_CHAR>`

        ID of the user in the facility burocracy database

    **instrument**: :ref:`NXinstrument`


      .. index:: name (data field)

      **name**: :ref:`NX_CHAR <NX_CHAR>`


      .. index:: description (data field)

      **description**: :ref:`NX_CHAR <NX_CHAR>`

        Brief description of the instrument

      **(source)**: :ref:`NXsource`


        .. index:: type (data field)

        **type**: :ref:`NX_CHAR <NX_CHAR>`


          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``


        .. index:: name (data field)

        **name**: :ref:`NX_CHAR <NX_CHAR>`


        .. index:: probe (data field)

        **probe**: :ref:`NX_CHAR <NX_CHAR>`


          Any of these values: ``neutron`` | ``x-ray`` | ``electron``

    **sample**: :ref:`NXsample`


      .. index:: name (data field)

      **name**: :ref:`NX_CHAR <NX_CHAR>`

        Descriptive name of sample

      .. index:: sample_id (data field)

      **sample_id**: :ref:`NX_CHAR <NX_CHAR>`

        Unique database id of the sample

      .. index:: description (data field)

      **description**: :ref:`NX_CHAR <NX_CHAR>`


      .. index:: type (data field)

      **type**: :ref:`NX_CHAR <NX_CHAR>`


        Any of these values:

          * ``sample``

          * ``sample+can``

          * ``calibration sample``

          * ``normalisation sample``

          * ``simulated data``

          * ``none``

          * ``sample_environment``


      .. index:: chemical_formula (data field)

      **chemical_formula**: :ref:`NX_CHAR <NX_CHAR>`

        Chemical formula formatted according to CIF conventions

      .. index:: preparation_date (data field)

      **preparation_date**: :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_TIME <NX_TIME>`}


      .. index:: situation (data field)

      **situation**: :ref:`NX_CHAR <NX_CHAR>`

        Description of the environment the sample is in: 
        air, vacuum, oxidizing atmosphere, dehydrated, etc.

      .. index:: temperature (data field)

      **temperature**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`}


      .. index:: magnetic_field (data field)

      **magnetic_field**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}


      .. index:: electric_field (data field)

      **electric_field**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}


      .. index:: stress_field (data field)

      **stress_field**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}


      .. index:: pressure (data field)

      **pressure**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PRESSURE <NX_PRESSURE>`}


**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/applications/NXarchive.nxdl.xml