Opened 4 years ago

Last modified 3 years ago

#378 assigned enhancement

Add documentation for BUMPS usage and integrate rst files to SasView from BUMPS repo

Reported by: butler Owned by: pkienzle
Priority: major Milestone: SasView Next Release +1
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

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.

Change History (12)

comment:1 Changed 4 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 3.1

comment:2 Changed 4 years ago by butler

  • Owner set to pkienzle
  • Status changed from new to assigned

comment:3 Changed 3 years ago by pkienzle

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>

comment:4 Changed 3 years ago by butler

  • Summary changed from Add documentation for BUMPS usage to Add documentation for BUMPS usage and integrate rst files to SasView from BUMPS repo

comment:5 Changed 3 years ago by pkienzle

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.

comment:6 Changed 3 years ago by trnielsen

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.

comment:7 Changed 3 years ago by trnielsen

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.

comment:8 Changed 3 years ago by butler

I have tried the build downloaded from Jenkins on both Mac and PC and the BUMPS docs are "natively" available on both. I thus have removed the web link option as too ugly and unecessary. The only open question I think now is whether we need to add the help button to the BUMPS option panel. Since that panel is part of the bumps package it may be a bit more complicated? Otherwise I vote we close this ticket and open a new one to implement a different approach to getting the bumps documentation into SasView? if this would be appropriate.

comment:9 Changed 3 years ago by trnielsen

After the release I can change the build server setup such that we can pull multiple git projects into the same Jenkins build directory.

In this way new bumps documentation can be pull into SasView? by changing the bumps tag version from within the Jenkins web interface.

comment:10 Changed 3 years ago by butler

  • Milestone changed from SasView 3.1 to SasView Next Release +1
  • Type changed from defect to enhancement

We will not fix the HELP button this release so can now move this ticket to next release

comment:11 Changed 3 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.0.0

comment:12 Changed 3 years ago by butler

  • Milestone changed from SasView 4.0.0 to SasView Next Release +1
Note: See TracTickets for help on using tickets.