Changeset 2fe39d1 in sasmodels for doc

Timestamp:

Mar 25, 2019 6:37:54 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:

b6422c7

Parents:

78cf85e

Message:

Clarified orientation/magnetism not supported in pure Python models.

Fixes #1253

File:

• doc/guide/plugin.rst (modified) (3 diffs)

doc/guide/plugin.rst

@@ -512 +512 @@
 hollow shapes.
 
-Note: Pure python models do not yet support direct computation of the
-average of $F(q)$ and $F^2(q)$.
+**Note: Pure python models do not yet support direct computation of the**
+**average of $F(q)$ and $F^2(q)$. Neither do they support orientational**
+**distributions or magnetism (use C models if these are required).**
 
 Embedded C Models
@@ -614 +615 @@
 laboratory frame and beam travelling along $-z$.
 
-The oriented C model is called using *Iqabc(qa, qb, qc, par1, par2, ...)* where
+The oriented C model (oriented pure Python models are not supported) 
+is called using *Iqabc(qa, qb, qc, par1, par2, ...)* where
 *par1*, etc. are the parameters to the model.  If the shape is rotationally
 symmetric about *c* then *psi* is not needed, and the model is called
@@ -718 +720 @@
 to compute the proper magnetism and orientation, which you can implement
 using *Iqxy(qx, qy, par1, par2, ...)*.
+
+**Note: Magnetism is not supported in pure Python models.**
 
 Special Functions