Changeset 0d5a655 in sasmodels for doc

Timestamp:

Jan 24, 2018 4:41:26 PM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

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

Children:

3fb9404

Parents:

31a02f1

Message:

make jitter explorer available from sasview app

Location:

doc

Files:

• developer/overview.rst (modified) (2 diffs)
• genapi.py (modified) (1 diff)
• guide/orientation/orientation.rst (modified) (1 diff)

doc/developer/overview.rst

@@ -190 +190 @@
 *sasmodels.generate.PROJECTION*, with the default *PROJECTION=1* for
 equirectangular and *PROJECTION=2* for sinusoidal.  The more complicated
-Guyou and Postel projections are not implemented. See explore.jitter.draw_mesh
+Guyou and Postel projections are not implemented. See jitter.draw_mesh
 for details.
 
@@ -274 +274 @@
 code.
 
-*explore/jitter.py* is for exploring different options for handling
-orientation and orientation dispersity.  It uses *explore/guyou.py* to
+*sasmodels/jitter.py* is for exploring different options for handling
+orientation and orientation dispersity.  It uses *sasmodels/guyou.py* to
 generate the Guyou projection.
 

doc/genapi.py

@@ -69 +69 @@
     ('exception', 'Annotate exceptions'),
     ('generate', 'Model parser'),
+    ('jitter', 'Orientation explorer'),
+    ('guyou', 'Guyou map projection'),
     ('kernel', 'Evaluator type definitions'),
     ('kernelcl', 'OpenCL model evaluator'),

doc/guide/orientation/orientation.rst

@@ -52 +52 @@
 yaw angle $\theta$ about the $b$-axis and pitch angle $\phi$ about the
 $a$-axis.
+
+You can explore the view and jitter angles interactively using
+:func:`sasmodels.jitter.run`.  Enter the following into the python
+interpreter::
+
+    from sasmodels import jitter
+    jitter.run()
 
 More formally, starting with axes $a$-$b$-$c$ of the particle aligned