Changeset 2015f02 in sasmodels


Ignore:
Timestamp:
Sep 18, 2018 3:40:20 AM (5 weeks ago)
Author:
smk78
Branches:
master, beta_approx, cuda-test, py3, ticket-1074-gammainc, ticket-1084, ticket-1102-pinhole, ticket-1142-plugin-reload, ticket-1155BE_PolyElectrolyte, ticket-1157, ticket-608-user-defined-weights
Children:
ce1eed5, 1657e21, dd16e07, cdcd80f, 315ac3a
Parents:
2c12061
Message:

Added definition of def random() to plugin.rst

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/guide/plugin.rst

    rf796469 r2015f02  
    423423calculations, but instead rely on numerical integration to compute the 
    424424appropriately smeared pattern. 
     425 
     426Each .py file also contains a function:: 
     427 
     428        def random(): 
     429        ... 
     430         
     431This function provides a model-specific random parameter set which shows model  
     432features in the USANS to SANS range.  For example, core-shell sphere sets the  
     433outer radius of the sphere logarithmically in `[20, 20,000]`, which sets the Q  
     434value for the transition from flat to falling.  It then uses a beta distribution  
     435to set the percentage of the shape which is shell, giving a preference for very  
     436thin or very thick shells (but never 0% or 100%).  Using `-sets=10` in sascomp  
     437should show a reasonable variety of curves over the default sascomp q range.   
     438The parameter set is returned as a dictionary of `{parameter: value, ...}`.   
     439Any model parameters not included in the dictionary will default according to  
     440the code in the `_randomize_one()` function from sasmodels/compare.py. 
    425441 
    426442Python Models 
Note: See TracChangeset for help on using the changeset viewer.