Changeset 2015f02 in sasmodels for doc/guide/plugin.rst

Timestamp:

Sep 18, 2018 5:40:20 AM (6 years ago)

Author:

smk78

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

f64b154, c11d09f, dd16e07

Parents:

2c12061

Message:

Added definition of def random() to plugin.rst

File:

• doc/guide/plugin.rst (modified) (1 diff)

doc/guide/plugin.rst

@@ -423 +423 @@
 calculations, but instead rely on numerical integration to compute the
 appropriately smeared pattern.
+
+Each .py file also contains a function::
+
+        def random():
+        ...
+        
+This function provides a model-specific random parameter set which shows model 
+features in the USANS to SANS range.  For example, core-shell sphere sets the 
+outer radius of the sphere logarithmically in `[20, 20,000]`, which sets the Q 
+value for the transition from flat to falling.  It then uses a beta distribution 
+to set the percentage of the shape which is shell, giving a preference for very 
+thin or very thick shells (but never 0% or 100%).  Using `-sets=10` in sascomp 
+should show a reasonable variety of curves over the default sascomp q range.  
+The parameter set is returned as a dictionary of `{parameter: value, ...}`.  
+Any model parameters not included in the dictionary will default according to 
+the code in the `_randomize_one()` function from sasmodels/compare.py.
 
 Python Models