Changeset 990d8df in sasmodels


Ignore:
Timestamp:
May 7, 2017 9:20:44 PM (8 years ago)
Author:
Paul Kienzle <pkienzle@…>
Branches:
master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests
Children:
2e66ef5
Parents:
8ae8532
Message:

move polydispersity and resolution docs into sasmodels; write installation instructions

Files:
9 added
6 edited

Legend:

Unmodified
Added
Removed
  • TabularUnified doc/gentoc.py

    r8ae8532 r990d8df  
    9898    struct_toc = _make_category( 
    9999        'structure-factor', 'Structure-factor', 'Structure Factors') 
    100     custom_toc = _make_category( 
    101         'custom-models', 'Custom-models', 'Custom Models') 
     100    #custom_toc = _make_category( 
     101    #    'custom-models', 'Custom-models', 'Custom Models') 
    102102 
    103103    # remember to top level categories 
     
    107107        'shape-independent':free_toc, 
    108108        'structure-factor': struct_toc, 
    109         'custom': custom_toc, 
     109        #'custom': custom_toc, 
    110110        } 
    111111 
  • TabularUnified doc/guide/gpu/opencl_installation.rst

    r8ae8532 r990d8df  
    44OpenCL Installation 
    55******************* 
    6 *Warning! GPU devices do not in general offer the same level of memory protection as CPU devices. If your code attempts to write outside allocated memory buffers unpredicatable behaviour may result (eg, your video display may freeze, or your system may crash, etc). Do not install OpenCL drivers without first checking for known issues (eg, some computer manufacturers install modified graphics drivers so replacing these may not be a good idea!). If in doubt, seek advice from an IT professional before proceeding further.* 
     6*Warning! GPU devices do not in general offer the same level of memory 
     7protection as CPU devices. If your code attempts to write outside allocated 
     8memory buffers unpredicatable behaviour may result (eg, your video display 
     9may freeze, or your system may crash, etc). Do not install OpenCL drivers 
     10ithout first checking for known issues (eg, some computer manufacturers 
     11install modified graphics drivers so replacing these may not be a good 
     12idea!). If in doubt, seek advice from an IT professional before proceeding 
     13further.* 
    714 
    8151. Check if you have OpenCL already installed 
     
    2532Mac OSX 
    2633....... 
    27     For OS X operating systems higher than 10.6 OpenCL is shipped along with the system. 
     34    For OS X operating systems higher than 10.6 OpenCL is shipped along with 
     35    the system. 
    2836 
    29     However, OpenCL has had a rocky history on Macs. Apple provide a useful compatibility table at https://support.apple.com/en-us/HT202823 
     37    However, OpenCL has had a rocky history on Macs. Apple provide a useful 
     38    compatibility table at https://support.apple.com/en-us/HT202823 
    3039 
    3140 
     
    4453....... 
    4554    N/A 
    46          
    47         You cannot download OpenCL driver updates for your Mac. They are packaged with the normal quarterly OS X updates from Apple.  
     55 
     56 You cannot download OpenCL driver updates for your Mac. They are packaged 
     57 with the normal quarterly OS X updates from Apple. 
    4858 
    4959 
    5060.. note:: 
    51     Intel provides OpenCL drivers for Intel processors at     https://software.intel.com/en-us/articles/opencl-drivers  
     61    Intel provides OpenCL drivers for Intel processors at 
     62    https://software.intel.com/en-us/articles/opencl-drivers 
    5263    These can sometimes make use of special vector instructions across multiple 
    5364    processors, so it is worth installing if the GPU does not support double 
     
    5566    or AMD. 
    5667 
    57          
     68 
    5869.. note:: 
    5970    This help document was last changed by Steve King, 08Oct2016 
  • TabularUnified doc/guide/index.rst

    r8ae8532 r990d8df  
    88 
    99   intro.rst 
    10    gpu/gpu_computations.rst 
    11    gpu/opencl_installation.rst 
     10   install.rst 
     11   pd/polydispersity.rst 
     12   resolution.rst 
    1213   magnetism/magnetism.rst 
    1314   sesans/sans_to_sesans.rst 
    1415   sesans/sesans_fitting.rst 
     16   plugin.rst 
    1517   refs.rst 
  • TabularUnified doc/guide/magnetism/magnetism.rst

    r8ae8532 r990d8df  
    22 
    33Polarisation/Magnetic Scattering 
    4 ======================================================= 
     4================================ 
    55 
    6 In earlier versions of SasView magnetic scattering was implemented in just five  
    7 (2D) models 
    8  
    9 *  :ref:`sphere` 
    10 *  :ref:`core-shell-sphere` 
    11 *  :ref:`core-multi-shell` 
    12 *  :ref:`cylinder` 
    13 *  :ref:`parallelepiped` 
    14  
    15 From SasView 4.x it is implemented on most models in the 'shape' category. 
    16  
    17 In general, the scattering length density (SLD = $\beta$) in each region where the 
    18 SLD is uniform, is a combination of the nuclear and magnetic SLDs and, for polarised 
    19 neutrons, also depends on the spin states of the neutrons. 
     6Models which define a scattering length density parameter can be evaluated 
     7 as magnetic models. In general, the scattering length density (SLD = 
     8 $\beta$) in each region where the SLD is uniform, is a combination of the 
     9 nuclear and magnetic SLDs and, for polarised neutrons, also depends on the 
     10 spin states of the neutrons. 
    2011 
    2112For magnetic scattering, only the magnetization component $\mathbf{M_\perp}$ 
     
    9889.. note:: 
    9990    This help document was last changed by Steve King, 02May2015 
     91 
     92* Document History * 
     93 
     94| 2017-05-08 Paul Kienzle 
  • TabularUnified sasmodels/resolution.py

    rb32caab r990d8df  
    437437    .. math:: 
    438438 
    439          \log \Delta q = (\log q_n - log q_1) / (n - 1) 
     439         \log \Delta q = (\log q_n - \log q_1) / (n - 1) 
    440440 
    441441    From this we can compute the number of steps required to extend $q$ 
     
    451451 
    452452         n_\text{extend} = (n-1) (\log q_\text{max} - \log q_n) 
    453             / (\log q_n - log q_1) 
     453            / (\log q_n - \log q_1) 
    454454    """ 
    455455    q = np.sort(q) 
     
    459459        log_delta_q = log(10.) / points_per_decade 
    460460    if q_min < q[0]: 
    461         if q_min < 0: q_min = q[0]*MINIMUM_ABSOLUTE_Q 
     461        if q_min < 0: 
     462            q_min = q[0]*MINIMUM_ABSOLUTE_Q 
    462463        n_low = log_delta_q * (log(q[0])-log(q_min)) 
    463464        q_low = np.logspace(log10(q_min), log10(q[0]), np.ceil(n_low)+1)[:-1] 
  • TabularUnified sasmodels/rst2html.py

    r8ae8532 r990d8df  
    211211    sys.exit(app.exec_()) 
    212212 
     213def can_use_qt(): 
     214    """ 
     215    Return True if QWebView exists. 
     216 
     217    Checks first in PyQt5 then in PyQt4 
     218    """ 
     219    try: 
     220        from PyQt5.QtWebKitWidgets import QWebView 
     221        return True 
     222    except ImportError: 
     223        try: 
     224            from PyQt4.QtWebkit import QWebView 
     225            return True 
     226        except ImportError: 
     227            return False 
     228 
    213229def view_help(filename, qt=False): 
    214230    import os 
    215     url="file:///"+os.path.abspath(filename).replace("\\","/") 
     231 
     232    if qt: 
     233        qt = can_use_qt() 
     234 
     235    url = "file:///"+os.path.abspath(filename).replace("\\", "/") 
    216236    if filename.endswith('.rst'): 
    217237        html = load_rst_as_html(filename) 
Note: See TracChangeset for help on using the changeset viewer.