Changeset 0639476 in sasview for docs

Timestamp:

Oct 6, 2016 12:21:22 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:

8d3d20a

Parents:

3a22ce7 (diff), 5e906207 (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:21:22)

git-committer:

GitHub <noreply@…> (10/06/16 12:21:22)

Message:

Merge pull request #12 from lewisodriscoll/file-converter

Implement File Converter Tool

Location:

docs/sphinx-docs/source

Files:

• user/sasgui/perspectives/file_converter/file_converter_help.rst (added)
• user/tools.rst (modified) (1 diff)
• conf.py (modified) (1 diff)
• user/analysis.rst (modified) (1 diff)
• user/gpu_computations.rst (added)
• user/menu_bar.rst (added)
• user/opencl_installation.rst (added)
• user/sasgui/guiframe/data_formats_help.rst (modified) (4 diffs)
• user/sasgui/guiframe/graph_help.copy (deleted)
• user/sasgui/perspectives/calculator/kiessig_calculator_help.copy (deleted)
• user/sasgui/perspectives/calculator/resolution_calculator_help.copy (deleted)
• user/sasgui/perspectives/calculator/sas_calculator_help.copy (deleted)
• user/sasgui/perspectives/calculator/sld_calculator_help.copy (deleted)
• user/sasgui/perspectives/calculator/slit_calculator_help.copy (deleted)
• user/sasgui/perspectives/fitting/fitting_help.copy (deleted)
• user/sasgui/perspectives/fitting/mag_help.copy (deleted)
• user/sasgui/perspectives/fitting/mag_vector.bmp (modified) (previous)
• user/sasgui/perspectives/fitting/pd_help.copy (deleted)
• user/sasgui/perspectives/fitting/residuals_help.copy (deleted)
• user/sasgui/perspectives/fitting/sm_help.copy (deleted)
• user/sasgui/perspectives/invariant/invariant_help.copy (deleted)
• user/sasgui/perspectives/invariant/invariant_help.rst (modified) (5 diffs)
• user/sasgui/perspectives/pr/pr_help.copy (deleted)
• user/tutorial.rst (modified) (1 diff)
• user/user.rst (modified) (1 diff)
• user/working.rst (modified) (1 diff)

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

@@ -10 +10 @@
 
    Data Operations Utility <sasgui/perspectives/calculator/data_operator_help>
-      
+
    Density/Volume Calculator <sasgui/perspectives/calculator/density_calculator_help>
-   
+
    Generic SANS Calculator <sasgui/perspectives/calculator/sas_calculator_help>
-   
+
    Image Viewer <sasgui/perspectives/calculator/image_viewer_help>
-   
+
    Kiessig Thickness Calculator <sasgui/perspectives/calculator/kiessig_calculator_help>
-   
+
    SLD Calculator <sasgui/perspectives/calculator/sld_calculator_help>
-   
+
    Slit Size Calculator <sasgui/perspectives/calculator/slit_calculator_help>
-   
+
    Q Resolution Estimator <sasgui/perspectives/calculator/resolution_calculator_help>
-   
+
    Python Shell <sasgui/perspectives/calculator/python_shell_help>
-   
+
+   File Converter <sasgui/perspectives/file_converter/file_converter_help>

docs/sphinx-docs/source/conf.py

@@ -60 +60 @@
 #
 # The short X.Y version.
-version = '4.0.0'
+version = '4.0'
 # The full version, including alpha/beta/rc tags.
-release = '4.0.0-alpha'
+release = '4.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation

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

@@ +1 @@
+.. _analysis:
+
 Types of Analysis
 =================

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

@@ -3 +3 @@
 .. 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.
+.. WG Bouwman, DUT, added during CodeCamp-V in Oct 2016 the SESANS data format
 
 .. _Formats:
@@ -9 +10 @@
 ============
 
-SasView reads several different 1D (I(Q) vs Q) and 2D (I(Qx,Qy) vs (Qx,Qy))
+SasView reads several different 1D (I(Q) vs Q), 2D SANS(I(Qx,Qy) vs (Qx,Qy))
+and SESANS (P(z) vs z)
 data files. But please note that SasView does not at present load data where
 the Q and I(Q) data are in separate files.
 
-1D Formats
-----------
+1D Formats SANS
+---------------
 
 SasView will read files with 2 to 4 columns of numbers in the following order: 
@@ -46 +48 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-2D Formats
-----------
+2D Formats SANS
+---------------
 
 SasView will only read files in the NIST 2D format with the extensions 
@@ -60 +62 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Steve King, 01May2015
+Format SESANS
+---------------
+
+The current file extension is .ses or .sesans (not case sensitive).
+
+The 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.
+
+Following that is a 6 column list of instrument experimental variables:
+
+- Spin echo length (z, in Angstroms)
+- Spin echo length error (:math:`\Delta` z, in Angstroms) (experimental resolution)
+- neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments)
+- neutron wavelength error (:math:`\Delta \lambda`, in Angstroms)
+- Normalized polarization (:math:`P/P_0`, unitless)
+- Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error)
+
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Wim Bouwman, 05Oct2016

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

@@ -4 +4 @@
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
 
-Invariant Calculation Perspective
-=================================
+Invariant Calculation
+=====================
 
 Description
@@ -19 +19 @@
 .. image:: image001.gif
 
-where *g = Q* for pinhole geometry (SAS) and *g = Qv* (the slit height) for  
+where *g = q* for pinhole geometry (SAS) and *g = q*\ :sub:`v` (the slit height) for  
 slit geometry (USAS).
 
@@ -45 +45 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-Using the perspective
----------------------
+Using invariant analysis
+------------------------
 
 1) Select *Invariant* from the *Analysis* menu on the SasView toolbar.
@@ -53 +53 @@
 
 3) Select a dataset and use the *Send To* button on the *Data Explorer* to load 
-   the dataset into the *Invariant* perspective.
+   the dataset into the *Invariant* panel.
 
-4) Use the *Customised Input* boxes on the *Invariant* perspective to subtract 
+4) Use the *Customised Input* boxes on the *Invariant* panel to subtract 
    any background, specify the contrast (i.e. difference in SLDs - this must be 
    specified for the eventual value of Q*\  to be on an absolute scale), or to 
@@ -73 +73 @@
 
 8) If the value of Q*\  calculated with the extrapolated regions is invalid, a 
-   red warning will appear at the top of the *Invariant* perspective panel.
+   red warning will appear at the top of the *Invariant* panel.
 
    The details of the calculation are available by clicking the *Details* 

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

@@ -1 +1 @@
 .. tutorial.rst
+
+.. _tutorial:
 
 Tutorial

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

@@ -7 +7 @@
    :maxdepth: 1
 
-   SasView Model Documentation <index>
+   Model Documentation <index>
+   
+   Menu Bar <menu_bar>
 
    Analysis <analysis>

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

@@ -16 +16 @@
       
    Tutorial <tutorial.rst>
+   
+   Computations with a GPU <gpu_computations>
+