Changeset a9dc4eb in sasview


Ignore:
Timestamp:
May 1, 2015 4: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)

Files:
14 edited

Legend:

Unmodified
Added
Removed
  • docs/sphinx-docs/source/user/user.rst

    r2c96db5 ra9dc4eb  
    2323   Density/Volume Calculator Tool <perspectives/calculator/density_calculator_help> 
    2424    
    25    Generic Scattering Calculator Tool <perspectives/calculator/sas_calculator_help> 
     25   Generic SANS Calculator Tool <perspectives/calculator/sas_calculator_help> 
    2626    
    2727   Image Viewer Tool <perspectives/calculator/image_viewer_help> 
     
    3333   Slit Size Calculator Tool <perspectives/calculator/slit_calculator_help> 
    3434    
    35    SANS Resolution Estimator Tool <perspectives/calculator/resolution_calculator_help> 
     35   Q Resolution Estimator Tool <perspectives/calculator/resolution_calculator_help> 
    3636    
    3737   Python Shell Tool <perspectives/calculator/python_shell_help> 
  • src/sas/guiframe/media/data_explorer_help.rst

    r0cdf1af ra9dc4eb  
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
    55 
     6.. _Loading_data: 
     7 
    68Loading Data 
    79============ 
    8  
    9 Help is available on: 
    10  
    11 The_data_explorer_ 
    12  
    13 Loading_data_ 
    14  
    15 The_handy_menu_ 
    16  
    17 Activating_data_ 
    18  
    19 Removing_data_ 
    20  
    21 Creating_a_new_plot_ 
    22  
    23 Appending_plots_to_a_graph_ 
    24  
    25 Freezing_the_theory_ 
    26  
    27 Sending_data_to_applications_ 
    28  
    29 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    30  
    31 .. _The_data_explorer: 
    3210 
    3311The data explorer 
     
    4624 
    4725.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    48  
    49 .. _Loading_data: 
    5026 
    5127Loading data 
     
    6743.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6844 
    69 .. _The_handy_menu: 
    70  
    7145The handy menu 
    7246-------------- 
     
    7953 
    8054.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    81  
    82 .. _Activating_data: 
    8355 
    8456Activating data 
     
    9567.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    9668 
    97 .. _Removing_data: 
    98  
    9969Removing data 
    10070------------- 
     
    10777.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    10878 
    109 .. _Creating_a_new_plot: 
    110  
    11179Creating a new plot 
    11280------------------- 
     
    11684 
    11785.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    118  
    119 .. _Appending_plots_to_a_graph: 
    12086 
    12187Appending plots to a graph 
     
    136102.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    137103 
    138 .. _Freezing_the_theory: 
    139  
    140104Freezing the theory 
    141105------------------- 
     
    147111 
    148112.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    149  
    150 .. _Sending_data_to_applications: 
    151113 
    152114Sending data to applications 
     
    165127.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    166128 
    167 .. note::  This help document was last changed by Steve King, 30Apr2015 
     129.. note::  This help document was last changed by Steve King, 01May2015 
  • src/sas/guiframe/media/data_formats_help.rst

    r3fd3d5a4 ra9dc4eb  
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
    55 
     6.. _Formats: 
     7 
    68Data Formats 
    79============ 
    810 
    9 1D_Formats_ 
    10  
    11 2D_Formats_ 
    12  
    13 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    14  
    15 .. _1D_Formats: 
     11SasView reads several different 1D (I(Q) vs Q) and 2D (I(Qx,Qy) vs (Qx,Qy)) 
     12data files. But please note that SasView does not at present load data where 
     13the Q and I(Q) data are in separate files. 
    1614 
    17151D Formats 
     
    4644http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf 
    4745 
    48 *NOTE! SasView does not at present load data where the Q and I(Q) data are in  
    49 separate files.* 
    50  
    5146.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    52  
    53 .. _2D_Formats: 
    5447 
    55482D Formats 
     
    6760.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6861 
    69 .. note::  This help document was last changed by Steve King, 18Feb2015 
     62.. note::  This help document was last changed by Steve King, 01May2015 
  • src/sas/guiframe/media/graph_help.rst

    r0cdf1af ra9dc4eb  
    1111==================== 
    1212 
    13 Help is available on: 
    14  
    15 Graph_window_options_ 
    16  
    17 Dataset_menu_options_ 
    18  
    19 2D_data_averaging_ 
    20  
    21 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    22  
    23 .. _Graph_window_options: 
    24  
    2513Graph window options 
    2614-------------------- 
    27  
    28 Invoking_the_graph_menu_ 
    29  
    30 How_to_Hide-Show-Delete_a_graph_ 
    31  
    32 Dragging_a_plot_ 
    33  
    34 Zooming_In-Out_on_a_plot_ 
    35  
    36 Saving_a_plot_image_ 
    37  
    38 Printing_a_plot_ 
    39  
    40 Resetting_the_graph_ 
    41  
    42 Modifying_the_graph_ 
    43  
    44 Changing_scales_ 
    45  
    46 Toggling_scales_ 
    47  
    48 2D_color_maps_ 
    49  
    50 Getting_data_coordinates_ 
    51  
    52 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    5315 
    5416.. _Invoking_the_graph_menu: 
     
    6123Then select a menu item. 
    6224 
    63 .. _How_to_Hide-Show-Delete_a_graph: 
    64  
    6525How to Hide-Show-Delete a graph 
    6626^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
     
    8343*NOTE! If a residuals graph (when fitting data) is hidden, it will not show up  
    8444after computation.* 
    85  
    86 .. _Dragging_a_plot: 
    8745 
    8846Dragging a plot 
     
    9654To disable dragging mode, unselect the *crossed arrows* icon on the toolbar. 
    9755 
    98 .. _Zooming_In-Out_on_a_plot: 
    99  
    10056Zooming In-Out on a plot 
    10157^^^^^^^^^^^^^^^^^^^^^^^^ 
     
    11773To return to the original view of the data, click the the *Reset* (home) icon  
    11874in the toolbar at the bottom of the plot (see Resetting_the_graph_ for further details). 
    119  
    120 .. _Saving_a_plot_image: 
    12175 
    12276Saving a plot image 
     
    14397*  TIF/TIFF (tagged iamge file) 
    14498 
    145 .. _Printing_a_plot: 
    146  
    14799Printing a plot 
    148100^^^^^^^^^^^^^^^ 
     
    159111Range* on the *Graph Menu* (see Invoking_the_graph_menu_). Alternatively, use 
    160112the *Reset* (home) icon in the toolbar at the bottom of the plot. 
    161  
    162 .. _Modifying_the_graph: 
    163113 
    164114Modifying the graph 
     
    176126*  adding a grid overlay 
    177127 
    178 .. _Changing_scales: 
    179  
    180128Changing scales 
    181129^^^^^^^^^^^^^^^ 
     
    203151levels, via a linear fit (see Making_a_linear_fit_). 
    204152 
    205 .. _Toggling_scales: 
    206  
    207153Toggling scales 
    208154^^^^^^^^^^^^^^^ 
     
    214160selected is written alongside the colour scale. 
    215161 
    216 .. _2D_color_maps: 
    217  
    2181622D color maps 
    219163^^^^^^^^^^^^^ 
     
    221165This menu option is only available with 2D data. 
    222166 
    223 From the *Graph Menu* (see Invoking_the_Graph_Menu_) select *2D Color Map* to  
     167From the *Graph Menu* (see Invoking_the_graph_menu_) select *2D Color Map* to 
    224168choose a different color scale for the image and/or change the maximum or  
    225169minimum limits of the scale. 
    226  
    227 .. _Getting_data_coordinates: 
    228170 
    229171Getting data coordinates 
     
    235177.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    236178 
    237 .. _Dataset_menu_options: 
    238  
    239179Dataset menu options 
    240180-------------------- 
    241181 
    242 Invoking_the_dataset_menu_ 
    243  
    244 Getting_data_info_ 
    245  
    246 Saving_data_ 
    247  
    248 Making_a_linear_fit_ 
    249  
    250 Removing_data_from_the_plot_ 
    251  
    252 Show-Hide_error_bars_ 
    253  
    254 Modify_plot_properties_ 
    255  
    256 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    257  
    258182.. _Invoking_the_dataset_menu: 
    259183 
     
    263187From the *Graph Menu* (see Invoking_the_graph_menu_) highlight a plotted 
    264188dataset. 
    265  
    266 .. _Getting_data_info: 
    267189 
    268190Getting data info 
     
    273195data set. 
    274196 
    275 .. _Saving_data: 
    276  
    277197Saving data 
    278198^^^^^^^^^^^ 
     
    283203 
    2842041D data can be saved in either ASCII text (.TXT) or CanSAS/SASXML (.XML)  
    285 formats (see :ref:`1D_Formats`). 
    286  
    287 2D data can only be saved in the NIST 2D format (.DAT) (see :ref:`2D_Formats`). 
     205formats (see :ref:`Formats`). 
     206 
     2072D data can only be saved in the NIST 2D format (.DAT) (see :ref:`Formats`). 
    288208 
    289209.. _Making_a_linear_fit: 
     
    307227.. image:: guinier_fit.png 
    308228 
    309 .. _Removing_data_from_the_plot: 
    310  
    311229Removing data from the plot 
    312230^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
     
    316234 
    317235*NOTE! This action cannot be undone.* 
    318  
    319 .. _Show-Hide_error_bars: 
    320236 
    321237Show-Hide error bars 
     
    326242with the chosen dataset.  
    327243 
    328 .. _Modify_plot_properties: 
    329  
    330244Modify plot properties 
    331245^^^^^^^^^^^^^^^^^^^^^^ 
     
    337251.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    338252 
    339 .. _2D_data_averaging: 
    340  
    3412532D data averaging 
    342254----------------- 
    343  
    344 Purpose_ 
    345  
    346 How_to_average_ 
    347  
    348 Unmasked_circular_average_ 
    349  
    350 Masked_circular_average_ 
    351  
    352 Sector_average_ 
    353  
    354 Annular_average_ 
    355  
    356 Box_sum_ 
    357  
    358 Box_averaging_in_Qx_ 
    359  
    360 Box_averaging_in_Qy_ 
    361  
    362 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    363  
    364 .. _Purpose: 
    365255 
    366256Purpose 
     
    372262data. The region to be averaged is displayed in the plot window and its limits  
    373263can be modified by dragging the boundaries around. 
    374  
    375 .. _How_to_average: 
    376264 
    377265How to average 
     
    411299To remove a 'slicer', bring back the *Dataset menu* and select *Clear Slicer*. 
    412300 
    413 .. _Unmasked_circular_average: 
    414  
    415301Unmasked circular average 
    416302^^^^^^^^^^^^^^^^^^^^^^^^^ 
     
    419305pixel location of the beam center. 
    420306 
    421 .. _Masked_circular_average: 
    422  
    423307Masked circular average 
    424308^^^^^^^^^^^^^^^^^^^^^^^ 
     
    427311masked region is excluded. 
    428312 
    429 .. _Sector_average: 
    430  
    431313Sector average [Q View] 
    432314^^^^^^^^^^^^^^^^^^^^^^^ 
     
    437319of the central angle (|phi|\). 
    438320 
    439 .. _Annular_average: 
    440  
    441321Annular average [|phi| View] 
    442322^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
     
    448328degrees at the 3 O'clock position. 
    449329 
    450 .. _Box_sum: 
    451  
    452330Box sum 
    453331^^^^^^^ 
     
    457335When editing the slicer parameters, the user can enter the length and the width  
    458336the rectangular slicer and the coordinates of the center of the rectangle. 
    459  
    460 .. _Box_averaging_in_Qx: 
    461337 
    462338Box Averaging in Qx 
     
    470346is, the central value of each bin on the x-axis. 
    471347 
    472 .. _Box_averaging_in_Qy: 
    473  
    474348Box Averaging in Qy 
    475349^^^^^^^^^^^^^^^^^^^ 
     
    484358.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    485359 
    486 .. note::  This help document was last changed by Steve King, 30Apr2015 
     360.. note::  This help document was last changed by Steve King, 01May2015 
  • 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.