search

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

Doc Update: SESANS in Sasmodels #477

Closed smk78 closed 3 years ago

smk78 commented 3 years ago

This is one of two PRs (the other for SasView) addressing https://github.com/SasView/sasview/issues/1684 . This PR should be merged first (since the SasView doc build copies down from Sasmodels).

The changes here are purely textual. A reference to Jurrian's paper (published in 2020) has been added, and the title of the page explaining how to use the functionality has been clarified. The latter is necessary because an equivalent page is added to the SasView docs by the second PR.

smk78 commented 3 years ago

Oops! Well spotted @gonzalezma

wpotrzebowski commented 3 years ago

sasmodels ready for testing on OSX

smk78 commented 3 years ago

In response to @butler:

  1. I wonder if we should start adding DOIs (with external links perhaps?) to references? in which case the DOI: would be 10.3233/JNR-200154 and the link would be https://doi.org/10.3233/JNR-200154

Have added this DOI & link in sans_to_sesans.rst. Have also linked the existing DOI in sesans_fitting.rst.

I agree that adding DOIs throughout our help docs would be good, but it won't be a small task...

  1. I think the line It is possible to fit SESANS data from the command line in Python is now utterly redundant and in facts looks very odd indeed placed where it is. In other words, in the section titled "fitting using the command line" and after the stuff about installing the developer environment. I can see how that was in there originally but suggest it be removed now

Agreed. Now removed.

  1. Speaking of which, as another comment, it seems like this section should just be entirely replaced/deleted now and be part of the instructions on CLI use of SasView in general (using for example jupyter notebooks?

Remember that sans_to_sesans.rst & sesans_fitting.rst are part of Sasmodels which is agnostic in respect of Sasview. But also see https://github.com/SasView/sasview/pull/1931.

butlerpd commented 3 years ago

Have added this DOI & link in sans_to_sesans.rst. Have also linked the existing DOI in sesans_fitting.rst.

I agree that adding DOIs throughout our help docs would be good, but it won't be a small task...

Great! I agree - the bigger task is "no small task" indeed! My thinking was that if we agreed that DOI would be a good idea in this day and age (seems a no brainer?) we could start by asking for them to be included whenever a new reference is addedd and or an update of a document with some references is made? This will take time to get "full coverage of references" but at least gets us started and without more resources probably the best we can do at the moment?

  1. Speaking of which, as another comment, it seems like this section should just be entirely replaced/deleted now and be part of the instructions on CLI use of SasView in general (using for example jupyter notebooks?

Remember that sans_to_sesans.rst & sesans_fitting.rst are part of Sasmodels which is agnostic in respect of Sasview. But also see SasView/sasview#1931.

My point exactly. We do not tell people to install the full developer environment in order to use sasmodels in scripting mode do we? though perhaps a better question for @wpotrzebowski 😃 My real point was this should just be part of the CLI instructions eventually.... or do we have them in rst? I know we have a number of presentations in the documents repo and some demonstration scripts for sasmodels (as well as one for PR in sasview) but maybe we don't have rst describing the CLI interface/usage? If not maybe that needs to be a ticket?

That said. It was meant as a discussion point. I do not think that level of change is one to do for the next release - that would be crazy talk 😄

Now to check what all has been done and move this to done ...

smk78 commented 3 years ago

@butlerpd commented:

We do not tell people to install the full developer environment in order to use sasmodels in scripting mode do we? though perhaps a better question for @wpotrzebowski 😃 My real point was this should just be part of the CLI instructions eventually.... or do we have them in rst? I know we have a number of presentations in the documents repo and some demonstration scripts for sasmodels (as well as one for PR in sasview) but maybe we don't have rst describing the CLI interface/usage? If not maybe that needs to be a ticket?

There is scripting.rst which becomes https://www.sasview.org/docs/user/qtgui/Perspectives/Fitting/scripting.html.

butlerpd commented 3 years ago

sasmodels ready for testing on Win

butlerpd commented 3 years ago

Right I give ... I will cheat and make a proper build to review. my installation is also breaking ☚ī¸

butlerpd commented 3 years ago

Right ... it did not remember my major comment. Lets try that again shall we (clearly I'm not good with the tools here ☚ī¸

smk78 commented 3 years ago

Replying to @butlerpd

"that the polarisation ins not plotted,"

I suspect that arose from the original Dutch! :-) Now changed to "...that the polarisation is not plotted..."

Have also changed the trac link to point to the Github wiki