Changeset 9d8a027 in sasmodels for doc/guide/plugin.rst

Timestamp:

Nov 15, 2018 10:46:19 PM (6 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:

899e050

Parents:

c6084f1

Message:

add docs for 'model_info=…' to plugin guide

File:

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

doc/guide/plugin.rst

@@ -272 +272 @@
 structure factor to account for interactions between particles.  See
 `Form_Factors`_ for more details.
+
+**model_info = ...** lets you define a model directly, for example, by
+loading and modifying existing models.  This is done implicitly by
+:func:`sasmodels.core.load_model_info`, which can create a mixture model
+from a pair of existing models.  For example::
+
+    from sasmodels.core import load_model_info
+    model_info = load_model_info('sphere+cylinder')
+
+See :class:`sasmodels.modelinfo.ModelInfo` for details about the model
+attributes that are defined.
 
 Model Parameters