Ticket #9567 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Karl Palmen |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Roman Tolchenov |
Description
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 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
- ApplyCalibration.cpp
- ApplyDetailedBalance.cpp
- CopyInstrumentParameters.cpp
- CopyLogs.cpp
- CreateTransmissionWorkspace.cpp
- FilterEvents.cpp
- MaskBinsFromTable.cpp
- NormaliseToUnity.cpp
- PerformIndexOperations.cpp
- ReflectometryReductionOne.cpp
- CreateGroupingWorkspace.cpp
- GeneralisedSecondDifference.cpp
- GetTimeSeriesLogInformation.cpp
- MaskBins.cpp
- NormaliseByCurrent.cpp
- NormaliseToMonitor.cpp
- ReadGroupsFromFile.cpp
- MaxMin.cpp
- FindPeaks.cpp
- CreateCalFileByNames.cpp
- RemoveBins.cpp
- CreateDummyCalFile.cpp
- SumRowColumn.cpp
- ThresholdMD.cpp
- MDHistoToWorkspace2D.cpp
- ClearUB.cpp
- GoniometerAnglesFromPhiRotation.cpp
- IndexPeaks.cpp
- ShowPeakHKLOffsets.cpp
- StepScan.cpp
- LoadFullprofResolution.cpp
- LoadGSASInstrumentFile.cpp
- LoadIDFFromNexus.cpp
- ModifyDetectorDotDatFile.cpp
Change History
comment:2 Changed 6 years ago by Karl Palmen
I sort and group the algorithms according to their folder/category
Algorithms:
- ApplyCalibration.cpp
- ApplyDetailedBalance.cpp
- CopyInstrumentParameters.cpp
- CopyLogs.cpp
- CreateCalFileByNames.cpp
- CreateDummyCalFile.cpp
- CreateGroupingWorkspace.cpp
- CreateTransmissionWorkspace.cpp
- FilterEvents.cpp
- FindPeaks.cpp
- GeneralisedSecondDifference.cpp
- GetTimeSeriesLogInformation.cpp
- MaskBins.cpp
- MaskBinsFromTable.cpp
- MaxMin.cpp
- NormaliseByCurrent.cpp
- NormaliseToMonitor.cpp
- NormaliseToUnity.cpp
- PerformIndexOperations.cpp
- ReadGroupsFromFile.cpp
- ReflectometryReductionOne.cpp
- RemoveBins.cpp
- SumRowColumn.cpp
Crystal:
- ClearUB.cpp
- GoniometerAnglesFromPhiRotation.cpp
- IndexPeaks.cpp
- ShowPeakHKLOffsets.cpp
DataHandling:
- LoadFullprofResolution.cpp
- LoadGSASInstrumentFile.cpp
- LoadIDFFromNexus.cpp
- ModifyDetectorDotDatFile.cpp
MD Algorithms:
- ThresholdMD.cpp
SINQ:
- MDHistoToWorkspace2D.cpp
WorkflowAlogirthms:
- StepScan.cpp
comment:4 Changed 6 years ago by Karl Palmen
Work for ApplyCalibration-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: fa1d23b8f7aae45c73af3607928d14082706fc9c
comment:5 Changed 6 years ago by Karl Palmen
Work on CopyInstrumentParameters-v1.rst re #9567
Also minor changes to ApplyCalibration-v1.rst
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 2606870ccf68c8cc78a22ccafd252a350f493b0c
comment:6 Changed 6 years ago by Karl Palmen
Work on LoadFullprofResolution-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 3beda2dbc2775476e8d10b4415069813d3c44363
comment:7 Changed 6 years ago by Karl Palmen
Work on ApplyDetailedBalance-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 9dbfd906b94c1860fe09b5633f1d442174ed8738
comment:8 Changed 6 years ago by Karl Palmen
Fix ApplyCalibration-v1.rst & LoadFullprofResolution-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 4f1c6afd12ab37ca3fc55ffcd3967d6580d26aee
comment:9 Changed 6 years ago by Karl Palmen
Fix CopyInstrumentParameters-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 3d81e360324d586f577e3990a7e9538933dca328
comment:10 Changed 6 years ago by Karl Palmen
Work on LoadGSASInstrumentFile-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: cfda2956f885c0cae076819f24533700b96c8a4f
comment:11 Changed 6 years ago by Karl Palmen
Reorder printouts of rows re #9567
Also add file missed from previous commit.
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 6e09db40a2002b9f123e7113e5225932161b7483
comment:12 Changed 6 years ago by Karl Palmen
Work on LoadIDFFromNexus-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 1b509c75c5b65e1b460c483ad22655000ad37d4e
comment:13 Changed 6 years ago by Karl Palmen
Correct Example Titles re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: ded160cbe680058de7e199ad01c1f4d7658c3b47
comment:14 Changed 6 years ago by Karl Palmen
Work on ModifyDetectorDotDatFile-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: a25c8bf9f35a43f52ab7c81c3e44777a11c34295
comment:15 Changed 6 years ago by Karl Palmen
Work on CreateCalFileByNames-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 6af5e7e87ba0629114b9e4de21b6ebb29c0d1fc6
comment:16 Changed 6 years ago by Karl Palmen
Initial work on CreateGroupingWorkspace-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: d5306d64c6bb074335dc8046bde64412194beef3
comment:17 Changed 6 years ago by Karl Palmen
Further work on CreateGroupingWorkspace-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 5b5eb80cd1947364bfa9038df8d7d6f2c44754bb
comment:18 Changed 6 years ago by Karl Palmen
Work on CreateDummyCalFile-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 3aad2ffa4c69094f574a9e3c384cc4182c572c01
comment:19 Changed 6 years ago by Karl Palmen
Work on MaxMin-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 6efbaf829ab6f92571ece1114580f2529ae096c4
comment:20 Changed 6 years ago by Karl Palmen
Work on NormaliseToUnity-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 67f614fddbf091ec0225e9ac8cfd3d5bef93f704
comment:21 Changed 6 years ago by Karl Palmen
Work on SumRowColumn-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 5dbea3bf046ca63e0baab8348d03b85f8b1a9f62
comment:22 Changed 6 years ago by Karl Palmen
Work on RemoveBins-v1.rst re #9567
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: f47ef9f8ffe63032deac4f5daa488a086907c570
comment:23 Changed 6 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
comment:24 Changed 6 years ago by Karl Palmen
The algorithms to check consist of all 4 listed under DataHandling along with some listed under Algorithms. They are also listed in the commit comments.
comment:25 Changed 6 years ago by Roman Tolchenov
- Status changed from verify to verifying
- Tester set to Roman Tolchenov
comment:26 Changed 6 years ago by Roman Tolchenov
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9567_rst_doc'
Full changeset: 040e36099e0b9c97121800e6cca9b1139b441acc
comment:27 Changed 6 years ago by Roman Tolchenov
Created a follow-up ticket #9742
comment:28 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10410