Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Further tweaks to Basic-1D-Fitting tutorials #21

Merged
merged 2 commits into from
Oct 15, 2024
Merged

Conversation

smk78
Copy link
Collaborator

@smk78 smk78 commented Aug 26, 2024

This PR addresses the tweaks suggested by @butlerpd in #14 (comment).

@butlerpd
Copy link
Member

I am confused. I see that the typo seems to have been fixed and the red line on the residual plot properly assigned to +/- 3 instead of 2, but otherwise it looks like the 6.0 version is an update to an old version of the tutorial for 6.0? The plots are now back to being the ones from b1 (without the new logo) and the text around example 2 looks like it did before it was changed to reflect the currently agreed results (chi^2 less than 1 and vol frac of order 17%).
Am I missing something? A quick look at 5.0 suggests it too is back to the old version (from before the last PR).

Were the wrong versions uploaded as "new?" or the wrong versions used as the starting point to do "further tweaks?" or am I misunderstanding or misremembering?

@wpotrzebowski
Copy link
Contributor

Sorry, I didn't have time to look at it and decided that I will stick with the previous version (that I uploaded to sasview.org). Now, I see that probably better to wait with reviewing.

Two comments from students (to the previous version)

  1. In example 2 in the SLD calculation part. It says click on "Calculate" button, which doesn't exist. Then some students thought that SLD will automatically get updated in respective parameters fields (sld and sld_solvent). I am not sure if we can better explain it?
  2. Some students didn't understand what do we mean by "nonsensical uncertainties". I think we should just say something like "uncertainties make no sense" even though it doesn't sound nice.

Definitely not for this PR but I am thinking that providing project files that will cover tutorials content maybe not a bad idea. In most cases, I was able to rescue students if they fit went very wrong but it may be easier to have a such recovery states.

@smk78
Copy link
Collaborator Author

smk78 commented Sep 2, 2024

@butlerpd wrote:

I am confused... Were the wrong versions uploaded as "new?" or the wrong versions used as the starting point to do "further tweaks?"

Ahem. Umm. Yes! Whoops-a-daisy! Re-doing them now.

@smk78
Copy link
Collaborator Author

smk78 commented Sep 2, 2024

@wpotrzebowski wrote:

Two comments from students (to the previous version)

  1. In example 2 in the SLD calculation part. It says click on "Calculate" button, which doesn't exist.

Ooo, good catch! Thanks! The Calculate button was a v4 thang. Have removed it from the v5 & v6 tutorials.

Then some students thought that SLD will automatically get updated in respective parameters fields (sld and sld_solvent). I am not sure if we can better explain it?

A few lines lower on the same page as the now removed Calculate I have changed it to read:
'Enter these values in the FitPage (they are not auto-populated from the SLD Calculator).'

  1. Some students didn't understand what do we mean by "nonsensical uncertainties". I think we should just say something like "uncertainties make no sense" even though it doesn't sound nice.

Done.

@smk78
Copy link
Collaborator Author

smk78 commented Sep 2, 2024

In #14 (comment) @butlerpd wrote:

...The resolution of the images is quite low...

The screenshots have now also been re-done at the same resolution and in the same way as those in the v6 document.

@wpotrzebowski
Copy link
Contributor

I haven't read the entire thing but I looked at the latest changes (since I read it last). They look good.

@smk78
Copy link
Collaborator Author

smk78 commented Oct 15, 2024

Agreed at Leadership Team meeting 15/10/24 to merge this without further review.

@smk78 smk78 merged commit 06673bd into master Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants