diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h b/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h index dbba6ba8b5e8c500a9273e7fa9ae0421863422c5..3688f299e63c9cd81558eac34878e0f62f53c976 100644 --- a/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h +++ b/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h @@ -620,7 +620,7 @@ void LoadEventNexus::loadEntryMetadata(const std::string &nexusfilename, T WS, } file.closeData(); } catch (::NeXus::Exception &) { - // let it drop on floor + // Nexus format does not require a run_number to be present } if (!run.empty()) { diff --git a/docs/source/algorithms/LoadEventNexus-v1.rst b/docs/source/algorithms/LoadEventNexus-v1.rst index 729a170aa3190bd10b554f491a1c31d76bc7d60f..30285dabacefd99200001075ba42f97c39baed5b 100644 --- a/docs/source/algorithms/LoadEventNexus-v1.rst +++ b/docs/source/algorithms/LoadEventNexus-v1.rst @@ -25,10 +25,18 @@ also loaded using :ref:`LoadNexusLogs <algm-LoadNexusLogs>`. **Monitors** are loaded using :ref:`LoadNexusMonitors <algm-LoadNexusMonitors>`. -**Instrument geometry** is loaded using :ref:`LoadIDFFromNexus -<algm-LoadIDFFromNexus>`. If the instrument geometry is not in the -file :ref:`LoadInstrument <algm-LoadInstrument>` is used. +**Instrument geometry** +There are a series of approaches for extracting the instrument geometry. +These follow the escalation path as follows: + +- Tries to load embedded instrument_xml from the NXinstrument if present + using :ref:`LoadIDFFromNexus <algm-LoadIDFFromNexus>`. +- Else tries to load embedded nexus geometry from the NXinstrument if present +- Else tries to load the instrument using the name extracted from NXinstrument + +The latter two possibilities are achieved via +:ref:`LoadInstrument <algm-LoadInstrument>` Optional properties ################### diff --git a/docs/source/release/v3.14.0/framework.rst b/docs/source/release/v3.14.0/framework.rst index 9546a60e49da5508b4a827f4ffd8119277856628..215fe438a01c89d3098b7fea1ee7e5e683afcdb8 100644 --- a/docs/source/release/v3.14.0/framework.rst +++ b/docs/source/release/v3.14.0/framework.rst @@ -27,7 +27,10 @@ Logging Nexus Geometry Loading ---------------------- -:ref:`LoadEmptyInstrument <algm-LoadEmptyInstrument>` will now load instrument geometry from hdf5 `NeXus <https://www.nexusformat.org/>`_ format files. Files consistent with the standard following the introduction of `NXoff_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXoff_geometry.html>`_ and `NXcylindrical_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXcylindrical_geometry.html>`_ will be used to build the entire in-memory instrument geometry within Mantid. This IDF-free route is primarily envisioned for the ESS. This marks the completion of the first phase in the feasibility and rollout of support for the new format. Over coming releases we will be expanding our support for the NeXus geometry both across Loading and Saving algorithms. While dependent on the instrument, we are overall seeing significant improvements in instrument load times over loading from equivalent IDF based implementations. +:ref:`LoadEmptyInstrument <algm-LoadEmptyInstrument>` will now load instrument geometry from hdf5 `NeXus <https://www.nexusformat.org/>`_ format files. Files consistent with the standard following the introduction of `NXoff_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXoff_geometry.html>`_ and `NXcylindrical_geometry <http://download.nexusformat.org/sphinx/classes/base_classes/NXcylindrical_geometry.html>`_ will be used to build the entire in-memory instrument geometry within Mantid. This IDF-free route is primarily envisioned for the ESS. While dependent on the instrument, we are overall seeing significant improvements in instrument load times over loading from equivalent IDF based implementations. :ref:`LoadInstrument <algm-LoadInstrument>` also supports the nexus geometry format in the same was as LoadEmptyInstrument. + +The changes above have also been encorporated directly into :ref:`LoadEventNexus <algm-LoadEventNexus>`, so it is possible to store data and geometry together for the first time in a NeXus compliant format for Mantid. These changes have made it possible to load experimental ESS event data files directly into Mantid. + Archive Searching / ONCat -------------------------