Changeset 3c567c6b in sasmodels

Timestamp:

Aug 12, 2016 6:52:30 AM (8 years ago)

Author:

wojciech

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

40e415d

Parents:

9f60c06 (diff), fd19811 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

wpotrzebowski <Wojciech.Potrzebowski@…> (08/12/16 06:51:55)

git-committer:

wpotrzebowski <Wojciech.Potrzebowski@…> (08/12/16 06:52:30)

Message:

Magnetism help file moved to sasmodels - fixing ticket #607

Files:

• sasmodels/conversion_table.py (modified) (1 diff)
• sasmodels/sasview_model.py (modified) (4 diffs)
• doc/ref/img/M_angles_pic.bmp (added)
• doc/ref/img/mag_vector.bmp (added)
• doc/ref/index.rst (modified) (1 diff)
• doc/ref/intro.rst (modified) (1 diff)
• doc/ref/magnetism.rst (added)
• sasmodels/models/core_multi_shell.py (modified) (1 diff)
• sasmodels/models/core_shell_sphere.py (modified) (1 diff)
• sasmodels/models/cylinder.py (modified) (1 diff)
• sasmodels/models/fuzzy_sphere.py (modified) (1 diff)
• sasmodels/models/multilayer_vesicle.py (modified) (2 diffs)
• sasmodels/models/parallelepiped.py (modified) (1 diff)
• sasmodels/models/sphere.py (modified) (1 diff)

sasmodels/conversion_table.py

@@ -363 +363 @@
         }
     ],
-    "hardsphere2": [
-        "HardsphereStructure",
-        {}
-    ],
-    "hardsphere3": [
-        "HardsphereStructure",
-        {}
-    ],
-    "hardsphere4": [
-        "HardsphereStructure",
-        {}
-    ],
     "hayter_msa": [
         "HayterMSAStructure",

sasmodels/sasview_model.py

@@ -18 +18 @@
 
 import numpy as np  # type: ignore
-
-# Monkey patch sas.sascalc.fit as sas.models so that sas.models.pluginmodel
-# is available to the plugin modules.
-import sys
-import sas
-import sas.sascalc.fit
-sys.modules['sas.models'] = sas.sascalc.fit
-sas.models = sas.sascalc.fit
 
 from . import core
@@ -46 +38 @@
     pass
 
+SUPPORT_OLD_STYLE_PLUGINS = True
+
+def _register_old_models():
+    # type: () -> None
+    """
+    Place the new models into sasview under the old names.
+
+    Monkey patch sas.sascalc.fit as sas.models so that sas.models.pluginmodel
+    is available to the plugin modules.
+    """
+    import sys
+    import sas
+    import sas.sascalc.fit
+    sys.modules['sas.models'] = sas.sascalc.fit
+    sas.models = sas.sascalc.fit
+
+    import sas.models
+    from sasmodels.conversion_table import CONVERSION_TABLE
+    for new_name, conversion in CONVERSION_TABLE.items():
+        old_name = conversion[0]
+        module_attrs = {old_name: find_model(new_name)}
+        ConstructedModule = type(old_name, (), module_attrs)
+        old_path = 'sas.models.' + old_name
+        setattr(sas.models, old_path, ConstructedModule)
+        sys.modules[old_path] = ConstructedModule
+
 
 # TODO: separate x_axis_label from multiplicity info
@@ -86 +104 @@
         except Exception:
             logging.error(traceback.format_exc())
+    if SUPPORT_OLD_STYLE_PLUGINS:
+        _register_old_models()
+
     return models
 
@@ -676 +697 @@
             raise
 
+def test_old_name():
+    # type: () -> None
+    """
+    Load and run cylinder model from sas.models.CylinderModel
+    """
+    if not SUPPORT_OLD_STYLE_PLUGINS:
+        return
+    try:
+        # if sasview is not on the path then don't try to test it
+        import sas
+    except ImportError:
+        return
+    load_standard_models()
+    from sas.models.CylinderModel import CylinderModel
+    CylinderModel().evalDistribution([0.1, 0.1])
+
 if __name__ == "__main__":
     print("cylinder(0.1,0.1)=%g"%test_model())

doc/ref/index.rst

@@ -8 +8 @@
 
    intro.rst
+   magnetism.rst
    refs.rst

doc/ref/intro.rst

@@ -44 +44 @@
 ($x$) axis of the plane of the detector.
 
-For information about polarised and magnetic scattering, see here_.
+For information about polarised and magnetic scattering, see :ref:`magnetism`.
 
-
-.. _here: polar_mag_help.html

sasmodels/models/core_multi_shell.py

@@ -26 +26 @@
 
 For information about polarised and magnetic scattering, see
-the :doc:`magnetic help <../sasgui/perspectives/fitting/mag_help>` documentation.
+the :ref:`magnetism` documentation.
 
 Our model uses the form factor calculations implemented in a c-library provided

sasmodels/models/core_shell_sphere.py

@@ -4 +4 @@
 This model provides the form factor, $P(q)$, for a spherical particle with
 a core-shell structure. The form factor is normalized by the particle volume.
+
+For information about polarised and magnetic scattering, see
+the :ref:`magnetism` documentation.
 
 Definition

sasmodels/models/cylinder.py

@@ -3 +3 @@
 r"""
 The form factor is normalized by the particle volume V = \piR^2L.
+For information about polarised and magnetic scattering, see
+the :ref:`magnetism` documentation.
 
 Definition

sasmodels/models/fuzzy_sphere.py

@@ -1 +1 @@
 r"""
 For information about polarised and magnetic scattering, see
-the :doc:`magnetic help <../sasgui/perspectives/fitting/mag_help>`
+the :ref:`magnetism`
 documentation.
 

sasmodels/models/multilayer_vesicle.py

@@ -13 +13 @@
     Geometry of the multilayer_vesicle model.
 
-See the :ref:`core-shell` model for more documentation.
+See the :ref:`core-shell-sphere` model for more documentation.
 
 The 2D scattering intensity is the same as 1D, regardless of the orientation
@@ -28 +28 @@
 
 For information about polarised and magnetic scattering, see
-the :doc:`magnetic help <../sasgui/perspectives/fitting/mag_help>` documentation.
+the :ref:`magnetism` documentation.
 
 This code is based on the form factor calculations implemented in the NIST

sasmodels/models/parallelepiped.py

@@ -3 +3 @@
 r"""
 The form factor is normalized by the particle volume.
+For information about polarised and magnetic scattering, see
+the :ref:`magnetism` documentation.
 
 Definition

sasmodels/models/sphere.py

@@ -1 +1 @@
 r"""
 For information about polarised and magnetic scattering, see
-the :doc:`magnetic help <../sasgui/perspectives/fitting/mag_help>`
+the :ref:`magnetism` documentation.
 documentation.