Opened 2 years ago

Closed 18 months ago

#1187 closed defect (wontfix)

S(Q) models need function descriptions in documentation

Reported by: butler Owned by:
Priority: critical Milestone: SasView 4.3.0
Component: sasmodels Keywords:
Cc: Work Package: SasView Documentation


As noted by smk78 none of the structure factor functions have their mathematical functions described in the documentation.

Change History (4)

comment:1 Changed 18 months ago by butler

  • Priority changed from major to critical

comment:2 Changed 18 months ago by smk78

The current S(q) models are:

  • hardsphere
  • hayter_msa
  • squarewell
  • stickyhardsphere

The wording of the documentation for all of these has been reviewed and tweaked. In particular:

  • a useful empirical formula for calculating epsilon has been added to hayter_msa
  • a legacy png formula was removed from squarewell
  • the meaning of epsilon and tau in the stickyhardsphere docs HAVE BEEN REVERSED so that the meaning of epsilon is now consistent across the S(q) models
  • mention of Beta(q) has been added to all S(q) descriptions

comment:3 Changed 18 months ago by smk78

Rather like some of the P(q) models noted in #1240, the equations for the S(q) models are lengthy and complex. Following a discussion at Code Camp IX it was decided to close this ticket as wontfix.

Note that the S(q) model docs may require some additional editing when Beta(q) documentation becomes available (see #1096).

comment:4 Changed 18 months ago by smk78

  • Resolution set to wontfix
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.