Changeset 8d3d20a in sasview for docs


Ignore:
Timestamp:
Oct 6, 2016 12:35:24 PM (8 years ago)
Author:
GitHub <noreply@…>
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, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
4c3be25
Parents:
0639476 (diff), e32e35a (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
git-author:
Andrew Jackson <andrew.jackson@…> (10/06/16 12:35:24)
git-committer:
GitHub <noreply@…> (10/06/16 12:35:24)
Message:

Merge pull request #11 from SasView?/corfunc

Implement Correlation Function Perspective

Location:
docs/sphinx-docs/source
Files:
10 added
9 edited

Legend:

Unmodified
Added
Removed

  • docs/sphinx-docs/source/user/analysis.rst

    rec860a8f r8d3d20a  
    88.. toctree:: 
    99   :maxdepth: 1 
    10     
     10 
    1111   Model Fitting <sasgui/perspectives/fitting/fitting> 
    12     
     12 
    1313   P(r) Inversion <sasgui/perspectives/pr/pr_help> 
    14     
     14 
    1515   Invariant Calculation <sasgui/perspectives/invariant/invariant_help> 
     16 
     17   Correlation Function <sasgui/perspectives/corfunc/corfunc_help> 

  • docs/sphinx-docs/source/conf.py

    r4394be16 r9a182b2  
    6060# 
    6161# The short X.Y version. 
    62 version = '4.0.0' 
     62version = '4.0' 
    6363# The full version, including alpha/beta/rc tags. 
    64 release = '4.0.0-beta' 
     64release = '4.0.0' 
    6565 
    6666# The language for content autogenerated by Sphinx. Refer to documentation 

  • docs/sphinx-docs/source/user/sasgui/guiframe/data_formats_help.rst

    r49148bb r756f288  
    33.. This is a port of the original SasView html help file to ReSTructured text 
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
     5.. WG Bouwman, DUT, added during CodeCamp-V in Oct 2016 the SESANS data format 
    56 
    67.. _Formats: 
    … …  
    910============ 
    1011 
    11 SasView reads several different 1D (I(Q) vs Q) and 2D (I(Qx,Qy) vs (Qx,Qy)) 
     12SasView reads several different 1D (I(Q) vs Q), 2D SANS(I(Qx,Qy) vs (Qx,Qy)) 
     13and SESANS (P(z) vs z) 
    1214data files. But please note that SasView does not at present load data where 
    1315the Q and I(Q) data are in separate files. 
    1416 
    15 1D Formats 
    16 ---------- 
     171D Formats SANS 
     18--------------- 
    1719 
    1820SasView will read files with 2 to 4 columns of numbers in the following order:  
    … …  
    4648.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    4749 
    48 2D Formats 
    49 ---------- 
     502D Formats SANS 
     51--------------- 
    5052 
    5153SasView will only read files in the NIST 2D format with the extensions  
    … …  
    6062.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6163 
    62 .. note::  This help document was last changed by Steve King, 01May2015 
     64Format SESANS 
     65--------------- 
     66 
     67The current file extension is .ses or .sesans (not case sensitive). 
     68 
     69The file format is to have a list of name-value pairs as a header at the top of the file, detailing general experimental parameters necessary for fitting and analyzing data. This list should contain all information necessary for the file to be 'portable' between users. 
     70 
     71Following that is a 6 column list of instrument experimental variables: 
     72 
     73- Spin echo length (z, in Angstroms) 
     74- Spin echo length error (:math:`\Delta` z, in Angstroms) (experimental resolution) 
     75- neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments) 
     76- neutron wavelength error (:math:`\Delta \lambda`, in Angstroms) 
     77- Normalized polarization (:math:`P/P_0`, unitless) 
     78- Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error) 
     79 
     80 
     81.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     82 
     83.. note::  This help document was last changed by Wim Bouwman, 05Oct2016 

  • docs/sphinx-docs/source/user/sasgui/perspectives/invariant/invariant_help.rst

    r49148bb r9bbc074  
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
    55 
    6 Invariant Calculation Perspective 
    7 ================================= 
     6Invariant Calculation 
     7===================== 
    88 
    99Description 
    … …  
    1919.. image:: image001.gif 
    2020 
    21 where *g = Q* for pinhole geometry (SAS) and *g = Qv* (the slit height) for   
     21where *g = q* for pinhole geometry (SAS) and *g = q*\ :sub:`v` (the slit height) for   
    2222slit geometry (USAS). 
    2323 
    … …  
    4545.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    4646 
    47 Using the perspective 
    48 --------------------- 
     47Using invariant analysis 
     48------------------------ 
    4949 
    50501) Select *Invariant* from the *Analysis* menu on the SasView toolbar. 
    … …  
    5353 
    54543) Select a dataset and use the *Send To* button on the *Data Explorer* to load  
    55    the dataset into the *Invariant* perspective. 
     55   the dataset into the *Invariant* panel. 
    5656 
    57 4) Use the *Customised Input* boxes on the *Invariant* perspective to subtract  
     574) Use the *Customised Input* boxes on the *Invariant* panel to subtract  
    5858   any background, specify the contrast (i.e. difference in SLDs - this must be  
    5959   specified for the eventual value of Q*\  to be on an absolute scale), or to  
    … …  
    7373 
    74748) If the value of Q*\  calculated with the extrapolated regions is invalid, a  
    75    red warning will appear at the top of the *Invariant* perspective panel. 
     75   red warning will appear at the top of the *Invariant* panel. 
    7676 
    7777   The details of the calculation are available by clicking the *Details*  

  • docs/sphinx-docs/source/user/tools.rst

    r8f46df7 r0639476  
     1.. _tools: 
     2 
    13Tools 
    24===== 
    … …  
    810 
    911   Data Operations Utility <sasgui/perspectives/calculator/data_operator_help> 
    10        
     12 
    1113   Density/Volume Calculator <sasgui/perspectives/calculator/density_calculator_help> 
    12     
     14 
    1315   Generic SANS Calculator <sasgui/perspectives/calculator/sas_calculator_help> 
    14     
     16 
    1517   Image Viewer <sasgui/perspectives/calculator/image_viewer_help> 
    16     
     18 
    1719   Kiessig Thickness Calculator <sasgui/perspectives/calculator/kiessig_calculator_help> 
    18     
     20 
    1921   SLD Calculator <sasgui/perspectives/calculator/sld_calculator_help> 
    20     
     22 
    2123   Slit Size Calculator <sasgui/perspectives/calculator/slit_calculator_help> 
    22     
     24 
    2325   Q Resolution Estimator <sasgui/perspectives/calculator/resolution_calculator_help> 
    24     
     26 
    2527   Python Shell <sasgui/perspectives/calculator/python_shell_help> 
    26     
     28 
     29   File Converter <sasgui/perspectives/file_converter/file_converter_help> 

  • docs/sphinx-docs/source/user/tutorial.rst

    r13161ac rec860a8f  
    11.. tutorial.rst 
     2 
     3.. _tutorial: 
    24 
    35Tutorial 

  • docs/sphinx-docs/source/user/user.rst

    r5a71761 rbdae317  
    77   :maxdepth: 1 
    88 
    9    SasView Model Documentation <index> 
     9   Model Documentation <index> 
     10    
     11   Menu Bar <menu_bar> 
    1012 
    1113   Analysis <analysis> 

  • docs/sphinx-docs/source/user/working.rst

    r3a6b10d rc43953ef  
    1616       
    1717   Tutorial <tutorial.rst> 
     18    
     19   Computations with a GPU <gpu_computations> 
     20    
Note: See TracChangeset for help on using the changeset viewer.