Add documentation for BUMPS usage and integrate rst files to SasView from BUMPS repo (Trac #378)

[butlerpd]

We do need to add documentation to explain How to use the BUMPS optimization options including: the meaning of the options (DREAM vs LM vs NMS etc), the meaning of the parameters for each option, and how to interpret the diagnostic plots produced.

Migrated from http://trac.sasview.org/ticket/378

{
    "status": "closed",
    "changetime": "2019-03-26T10:08:09",
    "_ts": "2019-03-26 10:08:09.126789+00:00",
    "description": "We do need to add documentation to explain How to use the BUMPS optimization options including: the meaning of the options (DREAM vs LM vs NMS etc), the meaning of the parameters for each option, and how to interpret the diagnostic plots produced.",
    "reporter": "butler",
    "cc": "",
    "resolution": "fixed",
    "workpackage": "SasView Documentation",
    "time": "2015-03-10T16:31:46",
    "component": "SasView",
    "summary": "Add documentation for BUMPS usage and integrate rst files to SasView from BUMPS repo",
    "priority": "major",
    "keywords": "",
    "milestone": "SasView Next Release +1",
    "owner": "pkienzle",
    "type": "enhancement"
}

[butlerpd]

Trac update at 2015/03/22 22:30:32: butler changed milestone from "SasView Next Release +1" to "SasView 3.1"

[butlerpd]

Trac update at 2015/03/24 14:53:05:

• butler changed owner from "" to "pkienzle"
• butler changed status from "new" to "assigned"

[pkienzle]

Trac update at 2015/05/08 19:11:08: pkienzle commented:

If the bumps source tree is available, then the doc build can copy in the optimizer info as part of the build process. This is done in:

docs/sphinx-docs/build_sphinx.py

Before closing the ticket, update the build machines so that bumps source is available, and update src/sas/perspectives/fitting/media/fitting.rst so that it includes:

Information on the SasView Optimisers <optimizer>

[butlerpd]

Trac update at 2015/05/19 14:36:54: butler changed summary from "Add documentation for BUMPS usage" to "Add documentation for BUMPS usage and integrate rst files to SasView from BUMPS repo"

[pkienzle]

Trac update at 2015/06/16 14:25:56: pkienzle commented:

Need a Help button on the optimizer selection form. This will need to be a parameter to the dialog panel giving the URL for the help page; if the URL is not provided, then no Help button should appear.

[sasview-bot]

Trac update at 2015/06/18 12:47:50: trnielsen commented:

I have added a file in build_tools to clone bumps to the build server. The file is called: Jenkins_bumps_docs.py

I just installed the SasView from the latest build on a clean Windows VM. And the bumps documentation is not to be seen from Help -> Documentation -> User Documentation -> Fitting Perspectives

The Jenkings error log says:
“ File "C:\Python27\lib\subprocess.py", line 958, in _execute_child
startupinfo)
WindowsError: [Error 2] The system cannot find the file specified
“

Logging onto the Win7 Build slave and building locally everything works fine. So now I just need to find out why Jenkins cannot find some files.

[sasview-bot]

Trac update at 2015/06/19 12:43:37: trnielsen commented:

Build machines have been updated.

For the purpose of the upcoming releases bumps has manually been cloned onto the build servers. After the release, one could consider a setting up a general approach.

Status:

Win7: bumps docs are available from the SasView installer

OSX: (bumps) docs are NOT available from the SasView installer. On the build server bumps doc are included in the docs/sphinx-docs/build/html/index.html file.

Ubuntu: (bumps) docs are NOT available from the SasView installer egg or from python run.py. On the build server bumps doc are included in the docs/sphinx-docs/build/html/index.html file.