Changeset 78f02c3 in sasview for src/sas/calculator/media/sld_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/sld_calculator_help.rst (modified) (1 diff)

src/sas/calculator/media/sld_calculator_help.rst

@@ -1 +1 @@
 ..sld_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.
 
 SLD Calculator Tool
 ===================
 
-Placeholder for SLD calculator help
+Description
+-----------
+
+The neutron scattering length density is defined as
+
+SLD = (b_c1 +b_c2+...+b_cn )/Vm
+
+where 
+
+b_ci is the bound coherent scattering length of ith of n atoms in a molecule 
+with the molecular volume Vm
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+How to Format the Compound Name
+-------------------------------
+
+To calculate scattering length densities enter a compound and a mass density 
+and click "Calculate". Entering a wavelength value is optional (a default 
+value of 6.0 Angstroms will be used).
+
+* Formula strings consist of counts and atoms such as "CaCO3+6H2O".
+
+* Groups can be separated by *'+'* or *space*, so "CaCO3 6H2O" works as well.
+
+* Groups and be defined using parentheses, such as "CaCO3(H2O)6".
+
+* Parentheses can be nested, such as "(CaCO3(H2O)6)1".
+
+* Isotopes are represented by their index, e.g., "CaCO[18]3+6H2O", H[1], or 
+H[2].
+
+* Counts can be integer or decimal, e.g. "CaCO3+(3HO0.5)2".
+
+* Other compositions can be calculated as well, for example, for a 70-30 
+mixture of H2O/D2O write *H14O7+ D6O3* or more simply *H7D3O5* (i.e. this says 
+7 hydrogens, 3 deuteriums, and 5 oxygens) and the mass density calculated 
+based on the percentages of H and D.
+
+* Type *C[13]6 H[2]12 O[18]6* for C(13)6H(2)12O(18)6 (6 Carbon-13 atoms, 12 
+deuterium atoms, and 6 Oxygen-18 atoms)