SasView / sasmodels

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

core_multi_shell contextual help indicates that there is max 4 shells #496

Closed wpotrzebowski closed 2 years ago

wpotrzebowski commented 2 years ago

Reported by the user

The core_multi_shell contextual help (so as documentation) indicates that there is max 4 shells

"This model provides the scattering from a spherical core with 1 to 4 concentric shell structures. The SLDs of the core and each shell are individually specified."

but in fact the model accepts 10 shells (at least that seems to work) so the contextual and online helps should be udpated accordingly.

smk78 commented 2 years ago

@wpotrzebowski what version of SasView was this User using? As far as I can see the 4 shells in the documentation is only pre-Version4!

image

The current online docs (and those in 5.0.5rc1) say 'up to 9 shells': image

RichardHeenan commented 2 years ago

There are bugs in the current model, in both the "title" and the "description" strings, which are often overlooked, someone need to edit core_multi_shell.py which currently has the text below,

title = "This model provides the scattering from a spherical core with 1 to 4 \ concentric shell structures. The SLDs of the core and each shell are \ individually specified."

description = """\ Form factor for a core muti-shell (up to 4) sphere normalized by the volume. Each shell can have a unique thickness and sld.

background:background,
rad_core0: radius of sphere(core)
thick_shell#:the thickness of the shell#
sld_core0: the SLD of the sphere
sld_solv: the SLD of the solvent
sld_shell: the SLD of the shell#
A_shell#: the coefficient in the exponential function

scale: 1.0 if data is on absolute scale
volfraction: volume fraction of spheres
radius: the radius of the core
sld: the SLD of the core
thick_shelli: the thickness of the i'th shell from the core
sld_shelli: the SLD of the i'th shell from the core
sld_solvent: the SLD of the solvent
background: incoherent background

"""

butlerpd commented 2 years ago

This was in sasview so did not get closed when it was fixed despite the "fixes" keyword in the sasmodels PR. This has now been moved to sasmodels and am manually closing it.