Changeset 1eb86a5 in sasview

Timestamp:

Feb 13, 2018 9:57:55 AM (6 years ago)

Author:

smk78

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

61bfd36

Parents:

7b4676a

Message:

Updated help text in data_formats_help.rst & marketplace.rst

Files:

• docs/sphinx-docs/source/user/marketplace.rst (modified) (2 diffs)
• src/sas/sasgui/guiframe/media/data_formats_help.rst (modified) (2 diffs)

docs/sphinx-docs/source/user/marketplace.rst

@@ -8 +8 @@
 .. note:: 
     These plug-in models require SasView version 4.0 or later. However, 
-    not *all* models may work with *every* version of *SasView* because 
+    not *all* models may work with *every* version of SasView because 
     of changes to our API.
 
@@ -16 +16 @@
 code files to the Marketplace!
 
-Please put a comment in your code to indicate which version of *SasView* you 
+Please put a comment in your code to indicate which version of SasView you 
 wrote the model for.
 

src/sas/sasgui/guiframe/media/data_formats_help.rst

@@ -28 +28 @@
 
 *  .TXT
-*  .ASC
 *  .DAT
 *  .XML (in canSAS format v1.0 and 1.1)
+*  .H5  (as NeXus NXcanSAS only)
+*  .NXS (as NeXus NXcanSAS only)
+
+.. note::
+    From SasView version 4.2 onwards files written in the NIST .ASC format are no longer read. This is because that 
+    format normally represents *raw* and not reduced data.
 
 If using CSV output from, for example, a spreadsheet, ensure that it is not using commas as delimiters for thousands.
@@ -58 +63 @@
 --------------
 
-SasView will read ASCII ('text') files in the NIST 2D format (with the extensions .ASC or .DAT) or files in the NeXus NXcanSAS (HDF5) format (with the extension .H5). File extensions are not case-sensitive. Both of these formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_.
+SasView will read ASCII ('text') files in the NIST 2D format (with the extension .DAT) or files in the NeXus NXcanSAS (HDF5) format (with the extension .H5 or .NXS). File extensions are not case-sensitive. Both of these formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_.
 
 Most of the header lines in the NIST 2D format can actually be removed except the last line, and only the first three columns (*Qx, Qy,* and *I(Qx,Qy)*) are actually required.
+
+.. note::
+    From SasView version 4.2 onwards files written in the NIST .ASC format are no longer read. This is because that 
+    format normally represents *raw* and not reduced data.
+
+.. note::
+    SasView does not read the standard NeXus format, only the NXcanSAS subset. 
 
 The SasView :ref:`File_Converter_Tool` available in SasView 4.1 onwards can be used to convert data sets in the 2D BSL/OTOKO format into the NeXus NXcanSAS (HDF5) format.