Changeset 40a87fa in sasmodels for sasmodels/core.py

Timestamp:

Aug 8, 2016 11:24:11 AM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

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:

2472141

Parents:

2d65d51

Message:

lint and latex cleanup

File:

• sasmodels/core.py (modified) (4 diffs)

sasmodels/core.py

@@ -40 +40 @@
     # CRUFT: np.meshgrid requires multiple vectors
     def meshgrid(*args):
+        """Allow meshgrid with a single argument"""
         if len(args) > 1:
             return np.meshgrid(*args)
@@ -63 +64 @@
     """
     Return the list of available models on the model path.
+
+    *kind* can be one of the following:
+
+        * all: all models
+        * py: python models only
+        * c: compiled models only
+        * single: models which support single precision
+        * double: models which require double precision
+        * 1d: models which are 1D only, or 2D using abs(q)
+        * 2d: models which can be 2D
+        * magnetic: models with an sld
+        * nommagnetic: models without an sld
     """
     if kind and kind not in KINDS:
@@ -88 +101 @@
     elif kind == "2d" and any(p.type == 'orientation' for p in pars):
         return True
-    elif kind == "1d" and any(p.type != 'orientation' for p in pars):
+    elif kind == "1d" and all(p.type != 'orientation' for p in pars):
         return True
     elif kind == "magnetic" and any(p.type == 'sld' for p in pars):
@@ -252 +265 @@
 
 def list_models_main():
+    # type: () -> None
+    """
+    Run list_models as a main program.  See :func:`list_models` for the
+    kinds of models that can be requested on the command line.
+    """
     import sys
     kind = sys.argv[1] if len(sys.argv) > 1 else "all"