Opened 2 years ago

Closed 2 years ago

#1240 closed defect (wontfix)

Many models do not have their equation in the documentation

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


The Structure factors along with a number of other more complex models do not list the math used to compute them. Every model should have that which should of course match what the code is doing.

These omissions can at times be irritating when trying to answer a question about the model, often with the user sitting next to me and explaining how they just need to go to the documentation. Usually the documentation does refer to the underlying articles with equations but that can be a huge barrier.

One caveat may be that some models can be quite complex and the math itself may look daunting if not placed judiciously in the docs?

Change History (7)

comment:1 Changed 2 years ago by butler

  • Priority changed from major to critical

comment:2 Changed 2 years ago by smk78

The lack of equations for S(q) is noted in ticket #1187

P(q) models requiring attention are:

  • flexible_cylinder
  • flexible_cylinder_elliptical
  • core_shell_ellipsoid (some reformatting needed)
  • rpa

comment:3 Changed 2 years ago by smk78

After looking at the original reference and our codebase, I have concluded that it would be a tall order to accurately provide the equations for the flexible cylinder models in the model documentation. I have therefore highlighted this complexity in the docs and provided links to the source code for the interested reader to work it out for themselves if needs be.

comment:4 Changed 2 years ago by smk78

Corrected missing/poor rst/latex markup in the core_shell_ellipsoid docs.

comment:5 Changed 2 years ago by smk78

Similar to above, the sheer complexity of the rpa model makes it too daunting to provide the equations in the model documentation. I have made some minor tweaks to the docs but do not propose any further detail.

There is a separate problem with the auto-generated plot for the rpa model noted in Ticket #871.

comment:6 Changed 2 years ago by smk78

Following a discussion at Code Camp IX this ticket is being closed as wontfix.

comment:7 Changed 2 years ago by smk78

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