SasView / sasmodels

Package for calculation of small angle scattering models using OpenCL.
BSD 3-Clause "New" or "Revised" License
16 stars 28 forks source link

Improve documentation for unified_power_rg model #469

Open smk78 opened 3 years ago

smk78 commented 3 years ago

Having watched Greg Beaucage demonstrate fitting his unified model in IRENA at the 2021 CNMS/SHUG User Workshop last week, it became evident that the documentation for the unified_power_rg model in SasView could do with some re-working and improvement. The documentation currently advises the reader to go and read the original literature but, in truth, the literature is not the most accessible. For this model to be used correctly, some practical guidance is necessary.

Potential starting points are the following (co-written by Beaucage) https://saxs-igorcodedocs.readthedocs.io/en/stable/Irena/UnifiedFit.html and the model description (3.3.8) in the SasFit Manual (https://docs.sasfit.org/, pages 87-89).