Changeset a0637de in sasview for src

Timestamp:

Apr 29, 2015 12:55:39 PM (10 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:

8b55460

Parents:

3bc575d

Message:

Work in progress

Location:

src/sas/perspectives/fitting/media

Files:

• fitting.rst (modified) (1 diff)
• fitting_help.rst (modified) (3 diffs)
• pd_help.rst (modified) (6 diffs)
• sm_help.rst (modified) (4 diffs)

src/sas/perspectives/fitting/media/fitting.rst

@@ -5 +5 @@
    :maxdepth: 1
 
-   Fitting Perspective <perspectives/fitting/fitting_help>
+   Fitting Perspective <fitting_help>
 
-   Polydispersity Distributions <perspectives/fitting/pd_help>
+   Polydispersity Distributions <pd_help>
 
-   Smearing Computation <perspectives/fitting/sm_help>
+   Smearing Computation <sm_help>
 
-   Polarisation/Magnetic Scattering <perspectives/fitting/mag_help>
+   Polarisation/Magnetic Scattering <mag_help>
+
+   SasView Optimisers <Bumps/doc/guide/index>

src/sas/perspectives/fitting/media/fitting_help.rst

@@ -26 +26 @@
 ===================
 
-Load_a_File_
+Preparing_to_fit_data_
 
 Single_Fit_
@@ -48 +48 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-..  _Load_a_File:
-
-Load a File
------------
-
-From Menu go to *Data* -> *Load Data File(or Folder)* . Select a file/folder 
-from the menu bar and click on Open button. Data contained in the file will be 
-displayed. To cancel the loading click on *cancel* . In case a file can not be 
-loaded, an error message will be displayed on the statusbar.
+.. _Preparing_to_fit_data:
+
+Preparing to fit data
+---------------------
+
+To fit some data you must first load some data, activate one or more data sets,
+then send those data sets to the fitting perspective.
+
+Instructions on how to do this are in the User Documentation section *Loading*
+*Data*.
+
+SasView can fit data in one of three ways:
+
+*  in *Single* fit mode
+*  in *Simultaneous* fit mode
+*  in *Batch* fit mode
+
+These modes of operation are described below.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -392 +401 @@
 ---------------
 
-Model Documentation <models/model_functions>
+See *Model Documentation*.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

src/sas/perspectives/fitting/media/pd_help.rst

@@ -40 +40 @@
 
 Note that this computation is very time intensive thus applying polydispersion/
-angular distrubtion for more than one paramters or increasing Npts values 
+angular distribution for more than one parameters or increasing Npts values
 might need extensive patience to complete the computation. Also note that 
 even though it is time consuming, it is safer to have larger values of Npts 
@@ -47 +47 @@
 The following five distribution functions are provided
 
-*  *Rectangular_Distribution_*
-*  *Array_Distribution_*
-*  *Gaussian_Distribution_*
-*  *Lognormal_Distribution_*
-*  *Schulz_Distribution_*
+*  *Rectangular Distribution*
+*  *Array Distribution*
+*  *Gaussian Distribution*
+*  *Lognormal Distribution*
+*  *Schulz Distribution*
 
-.. _Rectangular_Distribution:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Rectangular Distribution
@@ -74 +74 @@
 .. image:: pd_image004.jpg
 
-.. _Array_Distribution:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Array Distribution
@@ -96 +96 @@
 given in the control panel, for example ‘radius = 60’, will be ignored.
 
-.. _Gaussian_Distribution:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Gaussian Distribution
@@ -112 +112 @@
 .. image:: pd_image006.jpg
 
-.. _Lognormal_Distribution:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Lognormal Distribution
@@ -140 +140 @@
 p increases, requiring higher values of Nsigmas and Npts.
 
-.. _Schulz_Distribution:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Schulz Distribution

src/sas/perspectives/fitting/media/sm_help.rst

@@ -28 +28 @@
 --------------------
 
-Slit_Smearing_ 
-
-Pinhole_Smearing_
-
-2D_Smearing_
-
-.. _Slit_Smearing:
+The following three smearing algorithms are provided
+
+*  *Slit Smearing*
+*  *Pinhole Smearing*
+*  *2D Smearing*
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Slit Smearing
@@ -74 +74 @@
 Equation 4
 
-Numerical Implementation of Equation 4
---------------------------------------
+Numerical Implementation of Equation 4:
+---------------------------------------
 
 Case 1
@@ -127 +127 @@
 *Is* in *j* < *p* or *j* > *N-1*.
 
-.. _Pinhole_Smearing:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 Pinhole Smearing
@@ -147 +147 @@
 weighting matrix, and considered on *Is* computation.
 
-.. _2D_Smearing:
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
 2D Smearing