Ticket #9590 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Nick Draper |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Karl Palmen |
Description (last modified by Nick Draper) (diff)
Please check the documentation for these algorithms (check images, formatting etc) and add testable algorithm usage examples. We have tried to allocate algorithms as fairly and sensibly as possible, but there will be some that you do not consider "yours".
There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation http://www.mantidproject.org/Algorithm_Usage_Examples And there are examples implemented for Fit, Load, LoadISISNexus, DiffractionFocussing and Rebin.
To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.
In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.
If you are using Linux/Mac look here: https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md
- FilterByXValue.cpp
- AppendSpectra.cpp
- FlatPlateAbsorption.cpp
- Scale.cpp
- AlignAndFocusPowder.cpp
- FakeISISHistoDAE.cpp
- LoadLiveData.cpp
- MonitorLiveData.cpp
- StartLiveData.cpp - Seperate ticket to improve later
- FindSXPeaks.cpp
- HasUB.cpp
- ConvertMDHistoToMatrixWorkspace.cpp
- ConvertTableToMatrixWorkspace.cpp
- DefineGaugeVolume.cpp
- DetermineChunking.cpp
- CreateMDFitWorkspace.cpp - Does not exist
- ExtractSingleSpectrum.cpp
- Q1DTOF.cpp - Does not exist
- Q1DWeighted.cpp
- DeleteTableRows.cpp
- LoadHKL.cpp
- ExtractMask.cpp
- FFTDerivative.cpp
- FFTSmooth.cpp
- FindDetectorsOutsideLimits.cpp
- SumNeighbours.cpp
- CreatePSDBleedMask.cpp
- EQSANSTofStructure.cpp - Inner Workflow alg
- FindCenterOfMassPosition2.cpp - Inner Workflow alg
- DetectorEfficiencyVariation.cpp
Change History
comment:1 Changed 6 years ago by Nick Draper
- Owner changed from Michael Wedel to Russell Taylor
- Status changed from new to assigned
- Description modified (diff)
- Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation and add algorithm usage examples
comment:3 Changed 6 years ago by Nick Draper
- Status changed from assigned to inprogress
re #9590 done algs 1-3
Changeset: 0e98abdadebc35bf6fa8f858c2fe4f949c0711a7
comment:4 Changed 6 years ago by Nick Draper
re #9590 Done up to and including 15
Changeset: a4c286e8845b57445e2bffc4ae86e25735b92e33
comment:7 Changed 6 years ago by Nick Draper
re #9590 done up to and including 27
Changeset: da5133c2a9158a581048e0e34890d147ed67e1fd
comment:10 Changed 6 years ago by Nick Draper
re #9590 done all of them
Changeset: 904768cf1b95e6acbc97222c6133f6beb8e8d562
comment:11 Changed 6 years ago by Nick Draper
re #9590 resolve an ittitating failure
Changeset: 7e7ee419ba5b8545b28da60a9da82ba2631e6e8a
comment:12 Changed 6 years ago by Nick Draper
re #9590 solve merge conflicts
Changeset: deb9d590b8713f49633f666bed66d241ff5fd48a
comment:13 Changed 6 years ago by Nick Draper
re #9590 improve speed of absorptioncorrection test
Changeset: fa9a74de3c5922aab983c6e05e4fe4f0b032f537
comment:14 Changed 6 years ago by Nick Draper
re #9590 improve speed of absorptioncorrection test
Changeset: 1ac5b8e0cee2428732f701ed67e7b271be20c539
comment:15 Changed 6 years ago by Nick Draper
To test:
- Check the doctests pass either locally or on develop.
- Look on the pages to check they are acceptable
comment:16 Changed 6 years ago by Nick Draper
- Status changed from inprogress to verify
- Resolution set to fixed
comment:17 Changed 6 years ago by Vickie Lynch
Refs #9590 fix two tests
Changeset: 54501adafdc1aecf5d9d562258e5978ebdbf8a18
comment:18 Changed 6 years ago by Vickie Lynch
Refs #9590 test fixed now
Changeset: 4482bc3ceb5d88c64867ad0ad5d4d349a6294a10
comment:19 Changed 6 years ago by Karl Palmen
- Status changed from verify to verifying
- Tester set to Karl Palmen
comment:20 Changed 6 years ago by Karl Palmen
Thanks to Keith Brown and Martyn Gigg for helping me install the capability to create the mathemical expressions so I can check them.
comment:21 Changed 6 years ago by Karl Palmen
QiDToff still does not exist (assumed removed).
comment:22 Changed 6 years ago by Karl Palmen
CreateMDFitWorkspace still does not exist (assumed removed)
comment:23 Changed 6 years ago by Karl Palmen
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9590_RT_doc_usage'
Full changeset: be028ea032004c5f0c1f5dd91c12151f46719a62
comment:24 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10433