v6.0.0

6.0.0 release checklist

Page contents:

1. Beta release status
2. Pre-release tasks
3. Release candidate tasks
4. Full release tasks

Beta release status

• Updated to SLD documentation https://github.com/SasView/sasview/pull/2785 (CURRENTLY AGAINST MAIN)
• Magnetic SANS models moved from marketplace https://github.com/SasView/sasmodels/pull/592
  • This looks like two separate models?
  • There may be one or two more? PR need to be submitted soon
• Example data
  • Move to sasdata package https://github.com/SasView/sasview/pull/2637 and https://github.com/SasView/sasdata/pull/58
  • Add new example data https://github.com/SasView/sasview/pull/2742 (CURRENTLY AGAINST MAIN)
• Custom fit model: https://github.com/SasView/sasview/pull/2565
• New Slicer Features https://github.com/SasView/sasview/issues/1919 CURRENTLY AGAINST MAIN and https://github.com/SasView/sasdata/issues/61
• Batch processing and 2D slicing for PR https://github.com/SasView/sasview/pull/2181
• Update sesans plot axis per new standards https://github.com/SasView/sasdata/pull/60 and https://github.com/SasView/sasview/pull/2742 (ready to merge CURRENTLY AGAINST MAIN)
• Multiplicity models: https://github.com/SasView/sasview/pull/2647
  • Will not address RPA model question ==> keep RPA from
  • Questions about https://github.com/SasView/sasview/issues/1897 and https://github.com/SasView/sasview/issues/1089
• Fixes to category manager https://github.com/SasView/sasview/pull/2649 (ready to merge CURRENTLY AGAINST MAIN)
• Fix quote in file name error https://github.com/SasView/sasview/pull/2793 (NOW REBASED ONTO RELEASE_6.0.0)
• Reduce size of mac installer https://github.com/SasView/sasview/pull/2777
• Fill in What's New box.
• Remove deprecated modules https://github.com/SasView/sasview/pull/2809
• Local documentation generation: https://github.com/SasView/sasview/pull/2576
• Building sasdata docs and include in SasView https://github.com/SasView/sasdata/pull/53 and https://github.com/SasView/sasview/pull/2672

Features added without documentation (No PR yet)

• New tutorials need to be added from the tutorials repo (two ready for 6.0.0)
• Corfunc docs https://github.com/SasView/sasview/pull/2674 (CURRENTLY AGAINST MAIN)
• Orientation Viewer https://github.com/SasView/sasview/issues/2660
• New Slicer Features https://github.com/SasView/sasview/issues/2661
• Simultaneous Fitting Weights https://github.com/SasView/sasview/issues/2678
• Residual Plot Preferences https://github.com/SasView/sasview/issues/2679

Issues Found During Alpha Testing

• Default directory not persistent https://github.com/SasView/sasview/issues/2669
• Doc Window is Blank for MacOS https://github.com/SasView/sasview/issues/2813
• Documentation editor fixes: https://github.com/SasView/sasview/pull/2795 (Related issues: https://github.com/SasView/sasview/issues/2719, https://github.com/SasView/sasview/issues/2727, https://github.com/SasView/sasview/issues/2733)
• Re-enable "close window" on modal dialogs https://github.com/SasView/sasview/pull/2690 needs a windows functionality reviewer
• Generate Developer Docs in sasdata https://github.com/SasView/sasdata/pull/56
• Cannot save reports https://github.com/SasView/sasview/issues/2675
• Batch Fitting CSV file https://github.com/SasView/sasview/issues/2676

Nice to have but not top priority

• Data operations upgrade (interpolation) https://github.com/SasView/sasdata/pull/62 and https://github.com/SasView/sasview/pull/2782 (CURRENTLY AGAINST MAIN)
• Allow F(Q) in python models https://github.com/SasView/sasmodels/pull/570
• New css stylesheet for QtWidgets https://github.com/SasView/sasview/pull/2258 (CURRENTLY AGAINST MAIN)
• Slit nomenclature fix https://github.com/SasView/sasmodels/pull/533
• Fixed inverse q-spacing in the geometric extrapolation function https://github.com/SasView/sasmodels/pull/571 - merged into related PR 533 and working on fix for failing unit test
• Gen scattering Debye calculation https://github.com/SasView/sasview/pull/2731 (CURRENTLY AGAINST MAIN)
• Spelling fixes in two_power_law model https://github.com/SasView/sasmodels/pull/449 (may be a good first issue for the workshop?)

Questions?

For a Future Release

• Two Yukawa model https://github.com/SasView/sasmodels/issues/590
  • Question about defining envelope?
• Pore size Distribution
• 3 phase Invariant
• sasdata manipulations rewrite: https://github.com/SasView/sasview/pull/2615
  • Associated PR on sasdata: https://github.com/SasView/sasdata/pull/47 - DRAFT .. may become obsolete?
• Oriented sesans transform https://github.com/SasView/sasmodels/pull/536
• fitting widget refactor https://github.com/SasView/sasview/pull/2651
• Plotting refactor https://github.com/SasView/sasview/pull/2786
• Add Analytics https://github.com/SasView/sasview/pull/2702
• Generalized Data object https://github.com/SasView/sasdata/pull/28

Pre-release tasks

• Create SasView branch from v6.0.0 release point: release_6.0.0
• Lock SasView:release_6.0.0 branch
• Create sasmodels branch from v1.0.8 release point: release_1.0.8 CHECK VERSION!
• Lock sasmodels:release_1.0.8 branch CHECK VERSION!
• Create sasdata branch from v0.9 release point: release_0.9.0
• Lock sasdata:release_0.9 branch
• Update branch workflow to use sasmodels release branch
• Update branch workflow to use sasdata release branch (https://github.com/SasView/sasview/pull/2691)
• Compile list of potential bug fixes to add to this release (this page)
• Choose bug fixes that will be added to release
• Update version number
• Change the version number of the target folder (in installers/installer.iss)
• Update version number in /sas/system/config/config.py > LAST_WHATS_NEW_HIDDEN_VERSION to previous version number
• Create What's New messages in sasview/src/sas/qtgui/Utilities/WhatsNew/messages

Release candidate

• Any new test datasets documented (/src/sas/sasview/test/media/testdata_help.rst)
• Zenodo generated (script)
• sasview init and licenses updated (script)
• sasmodels init and licences files updated (script)
• sasdata init and licences files updated (script)
• sasview release notes in source (RELEASE.rst)
• sasmodels release notes in source (CHANGES.rst)
• sasdata release notes in source (CHANGES.rst)
• Release notes on github
• Tag sasview, sasdata, and sasmodels (on github)
• Upload assets to github

Full release

• Check & update lists of developers/contributors (release_automation.py & people.md)
• Release notes on github (update notes and remove pre-release)
• Update docs on website
• Update release link to the on website
• Update latestversion.json
• Update 'Current Release' link in download.md
• Create post on website to announce new release
• Announce release to [email protected] (with 'newsletter')
• Announce release to sa_scat & neutron mailing lists
• Publish zenodo
• Publish sasmodels on pypi
• Merge release branches with main (sasview) and master (sasmodels)
• Increment version number to x.x.x.a1 (sasview and sasmodels)
• Release conda package