Changeset 78f02c3 in sasview for src/sas/calculator/media/slit_calculator_help.rst

Timestamp:

Feb 14, 2015 10:12:40 AM (9 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

898a8b9

Parents:

3e2ebbb

Message:

Level 1 sphinx-ready commit of remaining help files

File:

• src/sas/calculator/media/slit_calculator_help.rst (modified) (1 diff)

src/sas/calculator/media/slit_calculator_help.rst

@@ -1 +1 @@
 ..slit_calculator_help.rst
+
+.. This is a port of the original SasView html help file to ReSTructured text
+.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
 
 Slit Size Calculator Tool
 =========================
 
-Placeholder for slit calculator help
+Description
+-----------
+This tool is for X-ray users to calculate the slit size (FWHM/2) for smearing 
+based on their half beam profile data (SAXSess).
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+How To
+-------
+To calculate the slit size (FWHM/2), just load the beam profile data using the 
+browse button.
+
+Once a data is loaded, the slit size will be computed and show up in the text 
+box.
+
+Because the unit is not specified in the data file, we do not convert it into 
+1/Angstrom so  users are responsible for converting the units of their data.
+
+Note: This slit size calculator only works for beam profile data produced by 
+'SAXSess'.
+
+To see the file format, check the file, 'beam profile.DAT', in the 'test' 
+folder of SasView.