Changeset 234c532 in sasmodels

Timestamp:

Oct 10, 2016 2:56:16 PM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

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

Children:

e4bf271

Parents:

689b7c4

Message:

add -html option to sascomp to show the model help

Location:

sasmodels

Files:

• compare.py (modified) (6 diffs)
• generate.py (modified) (1 diff)

sasmodels/compare.py

@@ -80 +80 @@
     -edit starts the parameter explorer
     -default/-demo* use demo vs default parameters
+    -html shows the model docs instead of running the model
 
 Any two calculation engines can be selected for comparison:
@@ -736 +737 @@
     'linear', 'log', 'q4',
     'hist', 'nohist',
-    'edit',
+    'edit', 'html',
     'demo', 'default',
     ])
@@ -845 +846 @@
         'use_demo'  : True,
         'zero'      : False,
+        'html'      : False,
     }
     engines = []
@@ -886 +888 @@
         elif arg == '-demo':    opts['use_demo'] = True
         elif arg == '-default':    opts['use_demo'] = False
+        elif arg == '-html':    opts['html'] = True
     # pylint: enable=bad-whitespace
 
@@ -961 +964 @@
     return opts
 
+def show_docs(opts):
+    # type: (Dict[str, Any]) -> None
+    """
+    show html docs for the model
+    """
+    import wx  # type: ignore
+    from .generate import view_html_from_info
+    app = wx.App() if wx.GetApp() is None else None
+    view_html_from_info(opts['def'])
+    if app: app.MainLoop()
+
+
 def explore(opts):
     # type: (Dict[str, Any]) -> None
     """
-    Explore the model using the Bumps GUI.
+    explore the model using the bumps gui.
     """
     import wx  # type: ignore
@@ -1057 +1072 @@
     opts = parse_opts(argv)
     if opts is not None:
-        if opts['explore']:
+        if opts['html']:
+            show_docs(opts)
+        elif opts['explore']:
             explore(opts)
         else:

sasmodels/generate.py

@@ -912 +912 @@
 
 def view_html(model_name):
-    from . import rst2html
     from . import modelinfo
     kernel_module = load_kernel_module(model_name)
     info = modelinfo.make_model_info(kernel_module)
+    view_html_from_info(info)
+
+def view_html_from_info(info):
+    from . import rst2html
     url = "file://"+dirname(info.filename)+"/"
     rst2html.wxview(make_html(info), url=url)