Changeset 31d7803 in sasview


Ignore:
Timestamp:
Sep 26, 2016 12:05:13 PM (5 years ago)
Author:
smk78
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, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
a0373d5, e925f61
Parents:
7f23423
Message:

Completed review - minor changes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sasgui/perspectives/fitting/media/plugin.rst

    r7f23423 r31d7803  
    288288        ["radius",      "Ang",        50, [0, inf],    "volume", "Sphere radius"], 
    289289    ] 
     290    # pylint: enable=bad-whitespace, line-too-long 
    290291 
    291292**parameters = [["name", "units", default, [min,max], "type", "tooltip"],...]** 
     
    577578............ 
    578579 
    579 :: 
    580  
    581     def ER(radius, thickness): 
    582         """Effective radius of a core-shell sphere.""" 
    583         return radius + thickness 
    584  
    585580Away from the dilute limit you can estimate scattering including 
    586581particle-particle interactions using $I(q) = P(q)*S(q)$ where $P(q)$ 
     
    591586form averaged over all the polydispersity values. 
    592587 
    593 Consider the *core_shell_sphere*, which has a simple effective radius 
     588:: 
     589 
     590    def ER(radius, thickness): 
     591        """Effective radius of a core-shell sphere.""" 
     592        return radius + thickness 
     593 
     594Now consider the *core_shell_sphere*, which has a simple effective radius 
    594595equal to the radius of the core plus the thickness of the shell, as 
    595596shown above. Given polydispersity over *(r1, r2, ..., rm)* in radius and 
     
    616617one return value for each point in the mesh grid. 
    617618 
    618 *NOTE: we may be removing or modifying this feature soon.*  As of this 
    619 writing, core-shell sphere returns (1., 1.) for *VR*, giving a volume 
    620 ratio of 1.0. 
     619*NOTE: we may be removing or modifying this feature soon. As of the  
     620time of writing, core-shell sphere returns (1., 1.) for VR, giving a volume 
     621ratio of 1.0.* 
    621622 
    622623Unit Tests 
     
    660661 
    661662If you are editing your model from the SasView GUI, you can test it 
    662 by selecting *Run -> Compile* from the *Model Editor* menu bar. An 
     663by selecting *Run > Compile* from the *Model Editor* menu bar. An 
    663664*Info* box will appear with the results of the compilation and a 
    664665check that the model runs. 
    665666 
    666667If the model compiles and runs, you can next run the unit tests that 
    667 you have added using the **test=** values. Switch to the *Shell* tab 
     668you have added using the **test =** values. Switch to the *Shell* tab 
    668669and type the following:: 
    669670 
     
    705706For the random models, 
    706707 
    707 - sld will be in(-0.5,10.5), 
    708 - angles (theta, phi, psi) will be in (-180,180), 
    709 - angular dispersion will be in (0,45), 
    710 - polydispersity will be in (0,1) 
    711 - other values will be in (0, 2*v) where v is the value of the parameter in demo. 
    712  
    713 Dispersion parameters n, sigma and type will be unchanged from demo so that 
     708- *sld* will be in the range (-0.5,10.5), 
     709- angles (*theta, phi, psi*) will be in the range (-180,180), 
     710- angular dispersion will be in the range (0,45), 
     711- polydispersity will be in the range (0,1) 
     712- other values will be in the range (0, 2\ *v*), where *v* is the value of the parameter in demo. 
     713 
     714Dispersion parameters *n*\, *sigma* and *type* will be unchanged from demo so that 
    714715run times are predictable. 
    715716 
     
    723724^^^^^^^^^^ 
    724725 
    725 **NB: For now we are not providing pylint with SasView; unless you have a 
    726 SasView development environment available, you can ignore this section.** 
     726**NB: For now we are not providing pylint with SasView; so unless you have a 
     727SasView development environment available, you can ignore this section!** 
    727728 
    728729Run the lint check with:: 
     
    736737for standard model functions *Iq*, *Iqxy*, etc. 
    737738 
    738 We will have delinting sessions at the SasView code camps, where we can 
     739We will have delinting sessions at the SasView Code Camps, where we can 
    739740decide on standards for model files, parameter names, etc. 
    740741 
    741 For now, you can tell pylint to ignore things.  For example, to align you 
     742For now, you can tell pylint to ignore things.  For example, to align your 
    742743parameters in blocks:: 
    743744 
     
    775776- `amsmath <http://www.ams.org/publications/authors/tex/amslatex>`_ 
    776777 
     778There is also a neat online WYSIWYG ReStructuredText editor at http://rst.ninjs.org\ . 
     779 
    777780Finally 
    778781^^^^^^^ 
     
    780783Once compare and the unit test(s) pass properly and everything is done, 
    781784consider adding your model to the 
    782 `model marketplace <http://marketplace.sasview.org/>`_. 
     785`Model Marketplace <http://marketplace.sasview.org/>`_. 
Note: See TracChangeset for help on using the changeset viewer.