Ticket #9571 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Andrei Savici |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | #9766 | Tester: | Nick Draper |
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 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
- IntegrateByComponent.cpp
- Min.cpp
- ChangeLogTime.cpp
- GeneratePeaks.cpp
- RemovePromptPulse.cpp
- SassenaFFT.cpp
- ShiftLogTime.cpp
- CreateLogPropertyTable.cpp
- CopySample.cpp
- AverageLogData.cpp
- ConvertToReflectometryQ.cpp
- LoadIsawUB.cpp
- SaveIsawUB.cpp
- SetGoniometer.cpp
- SetUB.cpp
- NormaliseByThickness.py
- SavePlot1D.py
- CheckForSampleLogs.py
- ConjoinFiles.py
- CorrectLogTimes.py
- DakotaChiSquared.py
- GenerateGroupingSNSInelastic.py
- GetEiMonDet.py
- GetEiT0atSNS.py
- LoadMultipleGSS.py
- MaskAngle.py
- MaskBTP.py
- PearlMCAbsorption.py
- GenerateGroupingPowder.cpp
- LoadDetectorsGroupingFile.cpp
- RemoveLogs.cpp
- SortDetectors.py
Change History
comment:1 Changed 6 years ago by Nick Draper
- Owner changed from Keith Brown to Andrei Savici
- Status changed from new to assigned
- Description modified (diff)
comment:2 Changed 6 years ago by Nick Draper
- Summary changed from Check Documentation and add algorithm usage examples (cloned) (cloned) (cloned) to Check Documentation and add algorithm usage examples
comment:3 Changed 6 years ago by Andrei Savici
- Status changed from assigned to inprogress
SortDetectors documentation. Refs #9571
Changeset: 71877cbdcfcaf036bebdbe1d1b5d5f7849ee2700
comment:4 Changed 6 years ago by Andrei Savici
Usage examples for RemoveLogs. Refs #9571
Changeset: 8acb1cac0c8cf0b2a832d5f47b5dc156d6850a16
comment:5 Changed 6 years ago by Pete Peterson
Re #9571. Moving implementation out of header.
Changeset: 23c56e6d4d400427f1ed88683a9246e88b635014
comment:6 Changed 6 years ago by Pete Peterson
Re #9571. Fixing up markup for algorithm documentation.
Changeset: 62603cd15bee6c63a7d3a017137acb8243415f8d
comment:7 Changed 6 years ago by Andrei Savici
Documentation for LoadDetectorsGroupingFile. Refs #9571
Changeset: 631a8a2d63bb9e5ff23d34514badaf16bd691048
comment:8 Changed 6 years ago by Andrei Savici
Documentation GenerateGroupingPowder. Refs #9571
Changeset: d0ef52a6644a3ae8ce8833aaff3302887cd983ad
comment:9 Changed 6 years ago by Andrei Savici
Documentation GenerateGroupingSNSInelastic. Refs #9571
Changeset: b0cf429218fb1c46597c4bbaec786ce1de1ba8ff
comment:10 Changed 6 years ago by Andrei Savici
SetUB documentation. Refs #9571
Changeset: 0e47055cc4986caaa8104f4ce02061709d07271a
comment:11 Changed 6 years ago by Andrei Savici
Documentation MaskBTP. Refs #9571
Also fixed problem that MaskBTP on an instrument does not show the history
Changeset: 07168905814baef6693555d1596454b63ce09307
comment:12 Changed 6 years ago by Andrei Savici
Documentation for SavePlot1D. Refs #9571
Changeset: 22886a415b3f04239f82e2f2ff26e33c9934ca63
comment:13 Changed 6 years ago by Andrei Savici
Min usage example. Refs #9571
Changeset: 4c57aa51ab20a5bed73961de965fc2e873a7e91c
comment:14 Changed 6 years ago by Andrei Savici
MaskAngle documentation. Refs #9571
Changeset: b4d4a814805b5341e67baff971b61342222ea317
comment:15 Changed 6 years ago by Andrei Savici
DakotaChiSquared documentation. Refs #9571
Changeset: 6313d92a5da4e623bdf17474d05ae74444ff257b
comment:16 Changed 6 years ago by Andrei Savici
Fixes for documentation. Refs #9571
Changeset: c1e418ee0a519da9565bda01ecc22cf5481b282b
comment:17 Changed 6 years ago by Andrei Savici
One more fix for usage tests. Refs #9571
Changeset: bf6cc8b63f6060c81f1cf3c3759ae030cdc2b8bb
comment:18 Changed 6 years ago by Andrei Savici
ChangeLogTime documentation. Refs #9571
Changeset: 14930f48ca8404b957b167ea734abcc56aa2e0bf
comment:19 Changed 6 years ago by Andrei Savici
Minor changes. Refs #9571
Changeset: d087dfa725f702531eb50cffab119615d7b7f4d8
comment:20 Changed 6 years ago by Andrei Savici
Fix descrition of input workspace. Refs #9571
Changeset: bed1ad674150a7469b7543774ab91f6d329e4547
comment:21 Changed 6 years ago by Andrei Savici
SaveIsawUB documentation. Refs #9571
Changeset: a1d40d3f9f4e7ca647688c2c2443474b9385eef5
comment:22 Changed 6 years ago by Andrei Savici
LoadIsawUB documentation. Refs #9571
Changeset: c2c79968509807f2f0e0c07d9fcba245d8e3ba63
comment:23 Changed 6 years ago by Andrei Savici
RemovePromptPulse documentation. Refs #9571
Changeset: e8d778bd0e7eb0adb902c72e97a0d0cc386d6dc8
comment:24 Changed 6 years ago by Andrei Savici
AverageLogData documentation. refs #9571
Changeset: 74c5bc88479d801ace6f14d2f25822fad9ac065b
comment:25 Changed 6 years ago by Andrei Savici
IntegrateByComponents documentation. Refs #9571
Changeset: 7dc5e95ef7578e9948e2522b797b05923209c65b
comment:26 Changed 6 years ago by Andrei Savici
CheckForSampleLogs documentation. Refs #9571
Changeset: 07087370f846f51a6e9a01fc61621dc188ba4e99
comment:27 Changed 6 years ago by Andrei Savici
ShiftLogTime documentation. Refs #9571
Changeset: d108708a48899c905a299f4cfc833dd020a4d95b
comment:29 Changed 6 years ago by Andrei Savici
GeneratePeaks documentation. Refs #9571
This needs to be rewritten, since major changes happened in the last week. See ticket #9766
Changeset: d7fce4d7a1f3231fca9f58faea706506a2ebba57
comment:30 Changed 6 years ago by Andrei Savici
Documentation for CreateLogPropertyTable. Refs #9571
Changeset: 0d27019fc3cd15fb8228694639eaa59cd310ca2d
comment:31 Changed 6 years ago by Andrei Savici
CopySample documentation. refs #9571
Changeset: ac6671205878b9b90713ab44fa63205bcb3cb852
comment:32 Changed 6 years ago by Andrei Savici
Usage for SetGoniometer. Refs #9571
Changeset: 77ae88e65af2ef1f2237e16798a778052ae78710
comment:33 Changed 6 years ago by Andrei Savici
NormaliseByThickness documentation. Refs #9571
Changeset: acd04dea2eb69a97112a0eb45b2d4cd11f492990
comment:34 Changed 6 years ago by Andrei Savici
Documentation for LoadMultipleGSS. Refs #9571
Moved example files to usage data directory. Also, a minor change in ConvertToReflectometryQ
Changeset: 468a3c3c1fdd908b39b02f06e78ab1fb76d689d5
comment:35 Changed 6 years ago by Andrei Savici
Documentation for GetEiMonDet and GetEiT0atSNS. Refs #9571
Changeset: f4e7c1c0aa16db73c00e2eefa09ae1531df136ea
comment:36 Changed 6 years ago by Andrei Savici
Documentation for CorrectLogTimes. Refs #9571
Changeset: 9864bff7d636e540739de9aec09e4880c627ed5e
comment:37 Changed 6 years ago by Andrei Savici
Fix some links in SassenaFFT documentation. Refs #9571
Changeset: 5f53c67ab29e1fb777fabcc8b99a8aea7a72916d
comment:38 Changed 6 years ago by Andrei Savici
merge conflict. Refs #9571
Changeset: a67c321dd9a5987cff9ed0e24185b88de4023422
comment:39 Changed 6 years ago by Andrei Savici
Sphinx warnings. Refs #9571
Changeset: 170bdde7c75c4e66dd6592541cb3424dc84a7b84
comment:40 Changed 6 years ago by Andrei Savici
- Status changed from inprogress to verify
- Resolution set to fixed
A few usage examples are missing for ConvertToReflectometryQ, ConjoinFiles (a new ticket will be created for Owen), PearlMCAbsorption (Martyn). I am thinking of deprecating GetEiMonDet. SassenaFFT has also two problems with the figure. After I will talk to Jose, I will write the usage example for that as well.
comment:41 Changed 6 years ago by Andrei Savici
Note, you might have a merge conflict on GeneratePeaks. The documentation of that will be rewritten
comment:42 Changed 6 years ago by Andrei Savici
Fix a link and a warning. Refs #9571
Changeset: 745ecbc75e0a7c7dc282dc6a0db9b862ae4c4058
comment:43 Changed 6 years ago by Karl Palmen
- Status changed from verify to verifying
- Tester set to Karl Palmen
comment:44 Changed 6 years ago by Karl Palmen
- Status changed from verifying to reopened
- Resolution fixed deleted
There was a merge conflict for GeneratePeaks that I could not resolve. I reopen for this conflict to resolved.
comment:45 Changed 6 years ago by Andrei Savici
- Status changed from reopened to verify
- Resolution set to fixed
The conflict could be much easier solved by the tester.
comment:46 Changed 6 years ago by Nick Draper
re #9571 resolve conflict
Changeset: 94570d3f63831c5f0dcefecd06db91e5d81db790
comment:47 Changed 6 years ago by Nick Draper
In general I couldn't disagree more, the responsibility of maintaining a clean branch that of the developer, and the developer is best placed to resolve any merges.
Also in this case the merge fix during testing will not work - I've tried it.
However in this case I'll do your work for you and merge master into your branch and resolve the merge.
comment:48 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester changed from Karl Palmen to Nick Draper
comment:49 Changed 6 years ago by Nick Draper
Merge branch 'feature/9571_UsageExamples' into develop
re #9571 Conflicts:
Code/Mantid/docs/CMakeLists.txt Code/Mantid/docs/source/algorithms/GeneratePeaks-v1.rst
Changeset: ed2ee51af0f680cdb6e606fa4dc6e61238e99949
comment:50 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9571_UsageExamples'
Full changeset: 707a9dc716d7ae7458158c6b6cb68d1a08a5001a
comment:51 Changed 6 years ago by Nick Draper
re #9571 category comment missed
Changeset: fd8845cad9958f4bd46cb3565217424e4d5f26f2
comment:52 Changed 6 years ago by Andrei Savici
merge conflict. Refs #9571
Changeset: a67c321dd9a5987cff9ed0e24185b88de4023422
comment:53 Changed 6 years ago by Nick Draper
Merge branch 'feature/9571_UsageExamples' into develop
re #9571 Conflicts:
Code/Mantid/docs/CMakeLists.txt Code/Mantid/docs/source/algorithms/GeneratePeaks-v1.rst
Changeset: ed2ee51af0f680cdb6e606fa4dc6e61238e99949
comment:54 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10414