.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXroot.nxdl.xml -- DO NOT EDIT .. index:: ! NXroot (base class) ! root (base class) see: root (base class); NXroot .. _NXroot: ====== NXroot ====== **Status**: base class, extends :ref:`NXobject` **Description**: Definition of the root NeXus group. **Symbols**: No symbol table **Groups cited**: :ref:`NXentry` .. index:: NXentry (base class); used in base class **Structure**: .. _/NXroot@NX_class-attribute: .. index:: NX_class (file attribute) **@NX_class**: (optional) :ref:`NX_CHAR ` .. collapse:: The root of any NeXus data file is an ``NXroot`` class ... The root of any NeXus data file is an ``NXroot`` class (no other choice is allowed for a valid NeXus data file). This attribute cements that definition. Obligatory value: ``NXroot`` .. _/NXroot@file_time-attribute: .. index:: file_time (file attribute) **@file_time**: (optional) :ref:`NX_DATE_TIME ` Date and time file was originally created .. _/NXroot@file_name-attribute: .. index:: file_name (file attribute) **@file_name**: (optional) :ref:`NX_CHAR ` File name of original NeXus file .. _/NXroot@file_update_time-attribute: .. index:: file_update_time (file attribute) **@file_update_time**: (optional) :ref:`NX_DATE_TIME ` Date and time of last file change at close .. _/NXroot@NeXus_repository-attribute: .. index:: NeXus_repository (file attribute) **@NeXus_repository**: (optional) :ref:`NX_CHAR ` .. collapse:: A repository containing the application definitions ... A repository containing the application definitions used for creating this file. If the NeXus_version attribute contains a commit distance and hash this should refer to this repository. .. _/NXroot@NeXus_version-attribute: .. index:: NeXus_version (file attribute) **@NeXus_version**: (optional) :ref:`NX_CHAR ` .. collapse:: Version of NeXus definitions used in writing the file. ... Version of NeXus definitions used in writing the file. This may either be a date based version tag of the form `vYYYY.MM` or a version tag with a commit distance and source control (e.g., git) hash of the form `vYYYY.MM.post1.dev.g`. It may contain an additional `.dYYYYMMDD` timestamp appendix for dirty repositories. If the version contains a commit distance and hash the NeXus_repository attribute should be written with the repository url containing this version. Only used when the NAPI or pynxtools has written the file. Note that this is different from the version of the base class or application definition version number. .. _/NXroot@partial-attribute: .. index:: partial (file attribute) **@partial**: (optional) :ref:`NX_CHAR ` .. collapse:: A list of concepts in an application definition this file describes. ... A list of concepts in an application definition this file describes. This is for partially filling an application definition. If this attribute is not present the application definition is assumed to be valid, if not only the specified concepts/paths are assumed to be valid. .. _/NXroot@HDF_version-attribute: .. index:: HDF_version (file attribute) **@HDF_version**: (optional) :ref:`NX_CHAR ` Version of HDF (version 4) library used in writing the file .. _/NXroot@HDF5_Version-attribute: .. index:: HDF5_Version (file attribute) **@HDF5_Version**: (optional) :ref:`NX_CHAR ` .. collapse:: Version of HDF5 library used in writing the file. ... Version of HDF5 library used in writing the file. Note this attribute is spelled with uppercase "V", different than other version attributes. .. _/NXroot@XML_version-attribute: .. index:: XML_version (file attribute) **@XML_version**: (optional) :ref:`NX_CHAR ` Version of XML support library used in writing the XML file .. _/NXroot@h5py_version-attribute: .. index:: h5py_version (file attribute) **@h5py_version**: (optional) :ref:`NX_CHAR ` Version of h5py Python package used in writing the file .. _/NXroot@creator-attribute: .. index:: creator (file attribute) **@creator**: (optional) :ref:`NX_CHAR ` facility or program where file originated .. _/NXroot@creator_version-attribute: .. index:: creator_version (file attribute) **@creator_version**: (optional) :ref:`NX_CHAR ` Version of facility or program used in writing the file .. _/NXroot@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which :ref:`NXentry` group contains ... .. index:: find the default plottable data .. index:: plotting .. index:: default attribute value Declares which :ref:`NXentry` group contains the data to be shown by default. It is used to resolve ambiguity when more than one :ref:`NXentry` group exists. The value :ref:`names ` the default :ref:`NXentry` group. The value must be the name of a child of the current group. The child must be a NeXus group or a link to a NeXus group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXroot/ENTRY-group: **ENTRY**: (optional) :ref:`NXentry` entries Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXroot/ENTRY-group ` * :ref:`/NXroot@creator-attribute ` * :ref:`/NXroot@creator_version-attribute ` * :ref:`/NXroot@default-attribute ` * :ref:`/NXroot@file_name-attribute ` * :ref:`/NXroot@file_time-attribute ` * :ref:`/NXroot@file_update_time-attribute ` * :ref:`/NXroot@h5py_version-attribute ` * :ref:`/NXroot@HDF5_Version-attribute ` * :ref:`/NXroot@HDF_version-attribute ` * :ref:`/NXroot@NeXus_repository-attribute ` * :ref:`/NXroot@NeXus_version-attribute ` * :ref:`/NXroot@NX_class-attribute ` * :ref:`/NXroot@partial-attribute ` * :ref:`/NXroot@XML_version-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXroot.nxdl.xml