Changeset a9dc4eb in sasview for src/sas/perspectives


Ignore:
Timestamp:
May 1, 2015 6:21:43 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:
f256d9b
Parents:
0cdf1af
Message:

Sphinx formatting changes (sections → sections & subsections; many
'html'ised internal links removed as Sphinx will autogenerate navigation
links from the sectioning)

Location:
src/sas/perspectives
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • src/sas/perspectives/calculator/media/data_operator_help.rst

    r0cdf1af ra9dc4eb  
    1818.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    1919 
    20 How To 
    21 ------ 
     20Using the tool 
     21-------------- 
    2222 
    23231) Enure you have loaded data into the *Data Explorer* (see :ref:`Loading_data`). 
    … …  
    5353.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    5454 
    55 .. note::  This help document was last changed by Steve King, 18Feb2015  
     55.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/calculator/media/density_calculator_help.rst

    rcbae5a2 ra9dc4eb  
    1616.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    1717 
    18 How To 
    19 ------ 
     18Using the tool 
     19-------------- 
    2020 
    21211) Select *Density/Volume Calculator* from the *Tool* menu on the SasView toolbar. 
    … …  
    3333.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    3434 
    35 .. note::  This help document was last changed by Steve King, 18Feb2015 
     35.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/calculator/media/image_viewer_help.rst

    r80c84b5 ra9dc4eb  
    2424.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    2525 
    26 How To 
    27 ------ 
     26Using the tool 
     27-------------- 
    2828 
    29291) Select *Image Viewer* from the *Tool* menu on the SasView toolbar. 
    … …  
    5353.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    5454 
    55 .. note::  This help document was last changed by Steve King, 18Feb2015 
     55.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/calculator/media/kiessig_calculator_help.rst

    r1e01486 ra9dc4eb  
    2121.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    2222 
    23 How To 
    24 ------ 
     23Using the tool 
     24-------------- 
    2525 
    2626To get a rough thickness or particle size, simply type the fringe or peak  
    … …  
    2929.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    3030 
    31 .. note::  This help document was last changed by Steve King, 18Feb2015 
     31.. note::  This help document was last changed by Steve King, 01May2015 
    3232 

  • src/sas/perspectives/calculator/media/resolution_calculator_help.rst

    r850c753 ra9dc4eb  
    88.. |Ang| unicode:: U+212B 
    99 
    10 Q Resolution Estimator 
    11 ====================== 
     10Q Resolution Estimator Tool 
     11=========================== 
    1212 
    1313Description 
    … …  
    2020.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    2121 
    22 How To 
    23 ------ 
     22Using the tool 
     23-------------- 
    2424 
    25251) Select *SAS Resolution Estimator* from the *Tool* menu on the SasView toolbar. 
    … …  
    105105.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    106106 
    107 .. note::  This help document was last changed by Steve King, 19Feb2015 
     107.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/calculator/media/sas_calculator_help.rst

    r850c753 ra9dc4eb  
    1414.. |noteql| unicode:: U+2260 
    1515 
    16 Generic Scattering Calculator Tool 
    17 ================================== 
     16Generic SANS Calculator Tool 
     17============================ 
    1818 
    19 Nuclear_Scattering_ 
     19Description 
     20----------- 
    2021 
    21 Magnetic_Scattering_Polarisation_ 
     22This tool attempts to simulate the SANS expected from a specified 
     23shape/structure or scattering length density profile. The tool can 
     24handle both nuclear and magnetic contributions to the scattering. 
    2225 
    23 Using_the_SAS_Calculator_GUI_ 
    24  
    25 Using_PDB_Data_ 
    26  
    27 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    28  
    29 .. _Nuclear_Scattering: 
    30  
    31 Nuclear Scattering 
    32 ------------------ 
     26Theory 
     27------ 
    3328 
    3429In general, a particle with a volume *V* can be described by an ensemble  
    … …  
    6459of the neutrons as follows. 
    6560 
    66 .. _Magnetic_Scattering_Polarisation: 
    67  
    68 Magnetic Scattering & Polarisation 
    69 ---------------------------------- 
     61Magnetic Scattering 
     62^^^^^^^^^^^^^^^^^^^ 
    7063 
    7164For magnetic scattering, only the magnetization component, *M*\ :sub:`perp`\ ,  
    … …  
    125118.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    126119 
    127 .. _Using_the_SAS_Calculator_GUI: 
    128  
    129 Using the SAS Calculator GUI 
    130 ---------------------------- 
     120Using the tool 
     121-------------- 
    131122 
    132123.. image:: gen_gui_help.bmp 
    … …  
    152143.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    153144 
    154 .. _Using_PDB_Data: 
     145Using PDB/OMF or SLD files 
     146-------------------------- 
    155147 
    156 Using PDB Data 
    157 -------------- 
    158  
    159 The SAS Calculator tool can read some PDB, OMF or SLD files but ignores  
     148The SANS Calculator tool can read some PDB, OMF or SLD files but ignores 
    160149polarized/magnetic scattering when doing so, thus related parameters such as  
    161150*Up_frac_in*, etc, will be ignored. 
    … …  
    175164.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    176165 
    177 .. note::  This help document was last changed by Steve King, 19Feb2015 
     166.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/calculator/media/sld_calculator_help.rst

    r850c753 ra9dc4eb  
    1212----------- 
    1313 
    14 The neutron scattering length density is defined as 
     14The neutron scattering length density (SLD) is defined as 
    1515 
    1616  SLD = (b_c1 + b_c2 + ... + b_cn) / Vm 
    1717 
    18 where  
    19  
    20 b_ci is the bound coherent scattering length of ith of n atoms in a molecule  
     18where b_ci is the bound coherent scattering length of ith of n atoms in a molecule 
    2119with the molecular volume Vm 
    2220 
    2321.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    2422 
    25 How to Format the Compound Name 
    26 ------------------------------- 
     23Specifying the Compound Name 
     24---------------------------- 
    2725 
    2826To calculate scattering length densities enter the empirical formula of a  
    … …  
    5755.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    5856 
    59 .. note::  This help document was last changed by Steve King, 19Feb2015 
     57.. note::  This help document was last changed by Steve King, 01May2015 
    6058 

  • src/sas/perspectives/calculator/media/slit_calculator_help.rst

    r8a22b5b ra9dc4eb  
    2222.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    2323 
    24 How To 
    25 ------- 
     24Using the tool 
     25-------------- 
    2626 
    27271) Select *Slit Size Calculator* from the *Tool* menu on the SasView toolbar. 
    … …  
    3636 
    3737*NOTE! The beam profile file does not carry any information about the units of  
    38 the Q data. This calculator assumes the data has units of 1/\ |Ang| . If the  
     38the Q data. This calculator assumes the data has units of 1/\ |Ang|\ . If the 
    3939data is not in these units it must be manually converted beforehand.* 
    4040 
    4141.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    4242 
    43 .. note::  This help document was last changed by Steve King, 19Feb2015 
     43.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/invariant/media/invariant_help.rst

    r0721c3d ra9dc4eb  
    1313================================= 
    1414 
    15 Scattering_Invariant_ 
    16  
    17 How_to_Use_ 
    18  
    19 Volume_Fraction_ 
    20  
    21 Specific_Surface_Area_ 
    22  
    23 Reference_ 
    24  
    25 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    26  
    27 .. _Scattering_Invariant: 
    28  
    29 Scattering (Porod) Invariant 
    30 ---------------------------- 
     15Description 
     16----------- 
    3117 
    3218The scattering, or Porod, invariant (Q*\) is a model-independent quantity that  
    … …  
    6551.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6652 
    67 .. _How_to_Use: 
    68  
    69 How to Use 
    70 ---------- 
     53Using the perspective 
     54--------------------- 
    7155 
    72561) Select *Invariant* from the *Analysis* menu on the SasView toolbar. 
    … …  
    10488.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    10589 
    106 .. _Volume_Fraction: 
     90Parameters 
     91---------- 
    10792 
    10893Volume Fraction 
    109 --------------- 
     94^^^^^^^^^^^^^^^ 
    11095 
    11196The volume fraction |phi| is related to Q*\  by 
    … …  
    119104.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    120105 
    121 .. _Specific_Surface_Area: 
    122  
    123106Specific Surface Area 
    124 --------------------- 
     107^^^^^^^^^^^^^^^^^^^^^ 
    125108 
    126109The specific surface area *Sv* is related to Q*\  by 
    … …  
    132115.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    133116 
    134 .. _Reference: 
    135  
    136 References 
    137 ---------- 
     117Reference 
     118--------- 
    138119 
    139120O. Glatter and O. Kratky 
    … …  
    145126.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    146127 
    147 .. note::  This help document was last changed by Steve King, 19Feb2015 
     128.. note::  This help document was last changed by Steve King, 01May2015 

  • src/sas/perspectives/pr/media/pr_help.rst

    r8a22b5b ra9dc4eb  
    3737.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    3838 
    39 How To 
    40 ------ 
     39Using the perspective 
     40--------------------- 
    4141 
    4242The user must enter 
    … …  
    6060.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6161 
    62 .. note::  This help document was last changed by Steve King, 19Feb2015 
     62.. note::  This help document was last changed by Steve King, 01May2015 
Note: See TracChangeset for help on using the changeset viewer.