Ticket #8684 (closed: fixed)
ISIS Reflectometry Guide
| Reported by: | Owen Arnold | Owned by: | Owen Arnold |
|---|---|---|---|
| Priority: | major | Milestone: | Release 3.1 |
| Component: | Reflectometry | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Arturs Bekasovs |
Description
There has been a significant amount of work performed during this iteration on various aspects of the back-end scripting and Algorithms for reflectometry reduction at ISIS. It would be extremely useful to create a guide to these features so that instrument scientists and new users can navigate their way through them.
The reflectometry work is not complete, and the wiki page should indicate this. We should also link to it from the reflectometry gui via the help, and ensure that Max Skoda, who can update this page as well.
This page would also be a useful feature for the release notes.
Change History
comment:2 Changed 7 years ago by Owen Arnold
- Status changed from new to verify
- Resolution set to fixed
comment:3 Changed 7 years ago by Arturs Bekasovs
- Status changed from verify to verifying
- Tester set to Arturs Bekasovs
comment:4 Changed 7 years ago by Arturs Bekasovs
- Status changed from verifying to closed
The guide is well-written and exhaustively describes what tools are available and what is their current status. Code snippets run to completion, resulting plots do seem OK (though my lack of experience with reflectometry doesn't allow me to verify that they are correct).
The only problem I've found is not with the guide itself, but rather with a few pages linked from it: http://www.mantidproject.org/ReflectometryReductionOne, http://www.mantidproject.org/PerformIndexOperations and http://www.mantidproject.org/CreateTransmissionWorkspace.
These are all auto-generated and because the wiki-formatted description of the algorithms has leading space on all the lines, it is treated in a special way, which leads to these unnecessary borders to be created around the paragraphs. I leave it with Owen to consider whether it's worth fixing.
Guide has been create here http://www.mantidproject.org/Reflectometry_Guide. Also linked to from here http://www.mantidproject.org/ISIS_Reflectometry_GUI
The tester could verify that the code snippets at the end of the guide run to completion. Note that the workspaces used are in the AutoTest directory. If you are not familiar with the reflectometry reduction (you don't have to be to verify this ticket), please check that what I have written reads well enough as a starter. This guide will be updated as more features are added, and others are removed.