SasView 3.1.0 Release Punch List

This is a running list of things to address for release 3.1

Remaining tickets

Tickets

Outstanding Questions (mostly from Richard)

1. “report” button does nothing (nor for Steve King on build 83)

   FIXED

2. The very nice help documentation works fine for me (apart from the previously mentioned irritating lack of “back” button on screen, though there is one if you right click, or use ALT/leftArrow; whilst ALT/rightArrow is forward.). However the section on the optimizers is not rendering equations so has $n$, $1-sigma$ etc. [PAK: the main issue is that the dollarmath extension was not included in sphinx, so $n$, etc, were not being parsed as latex expressions. This is now fixed, but the $1-\sigma$ markup is wrong, and should instead be 1-\ $\sigma$. .]

   FIX PENDING - NEXT RELEASE awaiting the next bumps release; may still be an issue connecting to https Mathjax CDN over proxy, which may mean we need to include mathjax in distributable.

3. I think, from experiment with data rather than looking at the code, the docs for the Hayter MSA structure factor needs to note that even if no salt has been specifically added to the sample, the “salt conc” may need to be non-zero to allow for counterions that have come off say a micelle as it charges up. One day I will code up a version of the Hayter MSA where the Debye length is explicitly entered. NOTE added by PDB: I'm not sure that is true. The implication fromt the documentation (again without delving deeply into the code) is that the counterions are accounted for (assumed to be monovalent one per charge on colloid). The documentation already indicates that currently the ionic strength cannot be directly entered and that the counterions and salts are all assumed mono-valent.

   TICKET FOR NEXT RELEASE #439

4. The “help about” box does not report the exact build number, just has 1>

   KNOWN ISSUE - NEXT RELEASE #419

5. Why are the parameter errors now appearing in red? (Which we usually keep around here for “fault” messages, so is giving me unnecessary stress.) - NOTE added by PDB: Vaguely remember adding red when something was wrong. Also limits sometimes show up prepopulated. QUESTION: are we accidentally using the new sasmodels? ANSWER: No.

   TO FIX - MIGUEL

6. If I set up 3 data sets with constraints, say have M2.radius=M1.radius, M3.radius=M1.radius but then fix M1.radius at say 30 ang, I would expect the constraints to still work, but I get error message on hitting Fit in constraints page.

                   Traceback (most recent call last):
     File "sas\perspectives\fitting\fit_thread.pyc", line 82, in compute
     File "sas\perspectives\fitting\fit_thread.pyc", line 14, in map_apply
     File "sas\perspectives\fitting\fit_thread.pyc", line 11, in map_getattr
     File "sas\fit\BumpsFitting.pyc", line 262, in fit
     File "sas\fit\BumpsFitting.pyc", line 345, in run_bumps
     File "bumps\fitters.pyc", line 859, in stderr
     File "bumps\lsqerror.pyc", line 79, in hessian
     File "bumps\numdifftools.pyc", line 1159, in __call__
     File "bumps\numdifftools.pyc", line 1170, in hessian
     File "bumps\numdifftools.pyc", line 1084, in hessdiag
     File "bumps\numdifftools.pyc", line 720, in _partial_der
     File "bumps\numdifftools.pyc", line 424, in _derivative
     File "bumps\numdifftools.pyc", line 686, in _romb_extrap
   ValueError: operands could not be broadcast together with shapes (24,) (0,)
    
    None
   

   OK the work around for this is to also fix M2.radius etc manually. However if I do that and then hit Fit on constraints page, nothing happens not even an error message. So if I “Remove” the constraints on M2.radius and M3.radius, “Fit” now attempts to work but comes back with same error message as above in red, presumably because it now has an issue with radius.width which is still constrained and fitting. Indeed if I remove the constraints on radius.width the fit now works, but with independent values for the polydispersity.

I would expect the constraints to work regardless of whether the base parameters in them are fixed or adjusting.

Meanwhile perhaps there can be a quick fix in this release to put up a message that “constrained parameters must all be adjusting” ?

If anyone wants a simple 3 contrast core/shell microemulsion project, with real SANS data, to test the above just ask. I am grateful that “Save project” does now actually save all 3 data sets and models. (It would be nice if it also remembered which parameters are on/off, and in the +1 release, saved the constraints also, so that a fully working project could be emailed to someone else, as setting up the constraints etc is still non-trivial.)

TICKETED FOR NEXT RELEASE IF NOT FOUND #441

7. In Model Documentation, the Table of contents on left side has repeats of sections 2.2, 2.3 and 2.4. (There is also a note at top of screen about proof reading, which is no doubt still true!)

   FIXED

8. The customised functions section of this section could do with a pointer to more docs on custom models hiding in User documentation/fitting perspective/fitting data/adding your own models

   FIXED

9. Might be useful if the “fit option” type was display on screen somewhere.

   TICKET FOR NEXT RELEASE #434

10. though there may be some good underlying reason, can we do away with the top level menu of the documentation? Model documentation is duplicated in User documentation, so just put Developer documentation at the bottom of the main menu and save clicks for everyone except developers (who get one more). NOTE added by PDB: this was discussed briefly at code camp. My personal feeling was similar (go directly to user docs) but would argue that developer docs do not need to be included in the GUI application. They should be available from command line or from a web page (do we push the docs yet to the web page?).

    TICKET FOR NEXT RELEASE #436

11. A “compute” button on the “const & simul fit” tab for a forward calculation only but with all the constraints applied would be useful.

    TICKET FOR NEXT RELEASE #435

12. In the DREAM parameter 2d correlation plots are very good but don’t actually quantify how large the correlation is. It might be useful to have some scale markers on the axes. The 2d plots are of course very small, so normal axis labels would likely look a mess, perhaps try sticks on the sides at 0 and say +-3sigma. (Normal correlation coefficients as I recall say how many standard deviations parameter A moves if parameter B moves one standard deviation.) [PAK: yes, I left off the labels because the plots would be too busy. Since the points used on the correlations are the same 95% interval as used on the 1-D variable plots, you can use those plots to read off the actual values, or look on the console log to get a parameter table. I created a ticket to print the correlation coefficient on the 2-D plots.]

    TICKET FOR NEXT RELEASE #437

13. Ubuntu egg has as a minimum of two faults:
    1. Docs are not included in python egg
    2. Reports can not be generated

    ADDED TO TICKET #194

14. On mac when loading project, the following is repeated multiple times:

    Traceback (most recent call last):
      File "/Users/pkienzle/anaconda/envs/bumps/lib/python2.7/site-packages/wx-3.0-osx_cocoa/wx/_core.py", line 16767, in <lambda>
        lambda event: event.callable(*event.args, **event.kw) )
      File "/Users/pkienzle/Source/sasview/src/sas/guiframe/data_panel.py", line 689, in load_data_list
        process.__str__())
      File "/Users/pkienzle/anaconda/envs/bumps/lib/python2.7/site-packages/wx-3.0-osx_cocoa/wx/lib/agw/customtreectrl.py", line 5138, in AppendItem
        return self.DoInsertItem(parent, len(parent.GetChildren()), text, ct_type, wnd, image, selImage, data)
      File "/Users/pkienzle/anaconda/envs/bumps/lib/python2.7/site-packages/wx-3.0-osx_cocoa/wx/lib/agw/customtreectrl.py", line 4886, in DoInsertItem
        raise Exception("\nERROR: In Order To Append/Insert A MultiLine Text You Have To Use The Style TR_HAS_VARIABLE_ROW_HEIGHT")
    Exception: 
    ERROR: In Order To Append/Insert A MultiLine Text You Have To Use The Style TR_HAS_VARIABLE_ROW_HEIGHT
    

    CHECK - NEXT RELEASE IF NOT OBVIOUS unless doesn't work for mac or gives error on mac. #440