From c18c06bc54bf8208e68d605df82add07ecd71351 Mon Sep 17 00:00:00 2001
From: Owen Arnold <owen.arnold@stfc.ac.uk>
Date: Tue, 4 Dec 2018 16:51:09 +0000
Subject: [PATCH] refs #24078. Update documentation.
---
.../inc/MantidDataHandling/LoadEventNexus.h | 2 +-
docs/source/algorithms/LoadEventNexus-v1.rst | 14 +++++++++++---
docs/source/release/v3.14.0/framework.rst | 5 ++++-
3 files changed, 16 insertions(+), 5 deletions(-)
diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h b/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h
index dbba6ba8b5e..3688f299e63 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 729a170aa31..30285dabace 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 9546a60e49d..215fe438a01 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
-------------------------
--
GitLab