Ticket #10393 (closed: fixed)
Add ISIS SANS 'what is calculated' documentation
Reported by: | Anders Markvardsen | Owned by: | Anders Markvardsen |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.3 |
Component: | SANS | Keywords: | |
Cc: | peter.parker@…, richard.heenan@… | Blocked By: | |
Blocking: | Tester: | Federico M Pouzols |
Description
http://www.mantidproject.org/ISIS_SANS contains various documentation about, how to use gui, batch files, user file commends, scripting....
But is missing documentation that gives a description of what is actually calculated in the SANS reduction, without saying in much detail how (since this may change).
Add 'what is calculated' documentation.
The audience/purposes are:
- To help other facilities to understand what sans reduction calculates
- To help developers understand what is calculated
- To help new instrument scientists and isis users
Put as critical, since there is a certain urgency for Bilby to use/modify Mantid SANS
Change History
comment:3 Changed 6 years ago by Anders Markvardsen
- Status changed from assigned to inprogress
make reference to new documentation in q1d. re #10393
Changeset: 731dbaead910bbf415f75c87c88f65475522c649
comment:4 Changed 6 years ago by Anders Markvardsen
- Cc peter.parker@…, richard.heenan@… added
http://www.mantidproject.org/SANS_ISIS_Data_Reduction has been created. Thanks to Richard for feedback to this page.
This page now links from http://www.mantidproject.org/ISIS_SANS and added as an example of using q1d in q1d rst documentation
comment:5 Changed 6 years ago by Anders Markvardsen
- Status changed from inprogress to verify
- Resolution set to fixed
To test:
- check that http://www.mantidproject.org/SANS_ISIS_Data_Reduction exist and is linked from http://www.mantidproject.org/ISIS_SANS
- check that it is linked from Q1D rst documentation also
remember to merge branch into master.
Optionally, please do not hesitate to provide any comments to the content of http://www.mantidproject.org/SANS_ISIS_Data_Reduction
comment:6 Changed 6 years ago by Federico M Pouzols
- Status changed from verify to verifying
- Tester set to Federico M Pouzols
comment:7 Changed 6 years ago by Federico Montesino Pouzols
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/10393_doc_what_is_cal_sans'
Full changeset: 545857101d83e19c0057bce944b2096a2ee9ae34
comment:8 Changed 6 years ago by Federico M Pouzols
The new SANS_ISIS_Data_Reduction' page is linked from the main ISIS SANS page, and also from thew new Q1D-v2 algorithm documentation (rst). Some clarifications have been also made in the algorithm source code. All code modifications look fine.
I read the new page from the viewpoint of an ignorant developer that wants to understand what it does. I think it is overall good and accessible. These are my comments and suggestions:
- I get an idea of what each term is and how it is obtained
- I get a good idea of how the ISIS implementation works and the steps involved.
- It definitely helps to understand what the commands in the ISIS-SANS example scripts do, and what the ISIS-SANS GUI tabs and components are about.
I couldn't come up with any relevant improvement or suggestion, I think all the pieces fit well together. I just took the liberty to edit a few typos and details in this and other SANS wiki pages.
Updates to Q1D documentation. re #10393
Changeset: a314c65865bd26f3381ac94fad485b96aba45f7a