Check Documentation and add algorithm usage examples

[Nick Draper]

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

1. IntegrateByComponent.cpp
2. Min.cpp
3. ChangeLogTime.cpp
4. GeneratePeaks.cpp
5. RemovePromptPulse.cpp
6. SassenaFFT.cpp
7. ShiftLogTime.cpp
8. CreateLogPropertyTable.cpp
9. CopySample.cpp
10. AverageLogData.cpp
11. ConvertToReflectometryQ.cpp
12. LoadIsawUB.cpp
13. SaveIsawUB.cpp
14. SetGoniometer.cpp
15. SetUB.cpp
16. NormaliseByThickness.py
17. SavePlot1D.py
18. CheckForSampleLogs.py
19. ConjoinFiles.py
20. CorrectLogTimes.py
21. DakotaChiSquared.py
22. GenerateGroupingSNSInelastic.py
23. GetEiMonDet.py
24. GetEiT0atSNS.py
25. LoadMultipleGSS.py
26. MaskAngle.py
27. MaskBTP.py
28. PearlMCAbsorption.py
29. GenerateGroupingPowder.cpp
30. LoadDetectorsGroupingFile.cpp
31. RemoveLogs.cpp
32. SortDetectors.py

[Andrei Savici]

SortDetectors documentation. Refs #9571

Changeset: 71877cbdcfcaf036bebdbe1d1b5d5f7849ee2700

[Andrei Savici]

Usage examples for RemoveLogs. Refs #9571

Changeset: 8acb1cac0c8cf0b2a832d5f47b5dc156d6850a16

[Pete Peterson]

Re #9571. Moving implementation out of header.

Changeset: 23c56e6d4d400427f1ed88683a9246e88b635014

[Pete Peterson]

Re #9571. Fixing up markup for algorithm documentation.

Changeset: 62603cd15bee6c63a7d3a017137acb8243415f8d

[Andrei Savici]

Documentation for LoadDetectorsGroupingFile. Refs #9571

Changeset: 631a8a2d63bb9e5ff23d34514badaf16bd691048

[Andrei Savici]

Documentation GenerateGroupingPowder. Refs #9571

Changeset: d0ef52a6644a3ae8ce8833aaff3302887cd983ad

[Andrei Savici]

Documentation GenerateGroupingSNSInelastic. Refs #9571

Changeset: b0cf429218fb1c46597c4bbaec786ce1de1ba8ff

[Andrei Savici]

SetUB documentation. Refs #9571

Changeset: 0e47055cc4986caaa8104f4ce02061709d07271a

[Andrei Savici]

Documentation MaskBTP. Refs #9571

Also fixed problem that MaskBTP on an instrument does not show the history

Changeset: 07168905814baef6693555d1596454b63ce09307

[Andrei Savici]

Documentation for SavePlot1D. Refs #9571

Changeset: 22886a415b3f04239f82e2f2ff26e33c9934ca63

[Andrei Savici]

Min usage example. Refs #9571

Changeset: 4c57aa51ab20a5bed73961de965fc2e873a7e91c

[Andrei Savici]

MaskAngle documentation. Refs #9571

Changeset: b4d4a814805b5341e67baff971b61342222ea317

[Andrei Savici]

DakotaChiSquared documentation. Refs #9571

Changeset: 6313d92a5da4e623bdf17474d05ae74444ff257b

[Andrei Savici]

Fixes for documentation. Refs #9571

Changeset: c1e418ee0a519da9565bda01ecc22cf5481b282b

[Andrei Savici]

One more fix for usage tests. Refs #9571

Changeset: bf6cc8b63f6060c81f1cf3c3759ae030cdc2b8bb

[Andrei Savici]

ChangeLogTime documentation. Refs #9571

Changeset: 14930f48ca8404b957b167ea734abcc56aa2e0bf

[Andrei Savici]

Minor changes. Refs #9571

Changeset: d087dfa725f702531eb50cffab119615d7b7f4d8

[Andrei Savici]

Fix descrition of input workspace. Refs #9571

Changeset: bed1ad674150a7469b7543774ab91f6d329e4547

[Andrei Savici]

SaveIsawUB documentation. Refs #9571

Changeset: a1d40d3f9f4e7ca647688c2c2443474b9385eef5

[Andrei Savici]

LoadIsawUB documentation. Refs #9571

Changeset: c2c79968509807f2f0e0c07d9fcba245d8e3ba63

[Andrei Savici]

RemovePromptPulse documentation. Refs #9571

Changeset: e8d778bd0e7eb0adb902c72e97a0d0cc386d6dc8

[Andrei Savici]

AverageLogData documentation. refs #9571

Changeset: 74c5bc88479d801ace6f14d2f25822fad9ac065b

[Andrei Savici]

IntegrateByComponents documentation. Refs #9571

Changeset: 7dc5e95ef7578e9948e2522b797b05923209c65b

[Andrei Savici]

CheckForSampleLogs documentation. Refs #9571

Changeset: 07087370f846f51a6e9a01fc61621dc188ba4e99

[Andrei Savici]

ShiftLogTime documentation. Refs #9571

Changeset: d108708a48899c905a299f4cfc833dd020a4d95b

[Andrei Savici]

GeneratePeaks documentation. Refs #9571

This needs to be rewritten, since major changes happened in the last week. See ticket #9766

Changeset: d7fce4d7a1f3231fca9f58faea706506a2ebba57

[Andrei Savici]

Documentation for CreateLogPropertyTable. Refs #9571

Changeset: 0d27019fc3cd15fb8228694639eaa59cd310ca2d

[Andrei Savici]

CopySample documentation. refs #9571

Changeset: ac6671205878b9b90713ab44fa63205bcb3cb852

[Andrei Savici]

Usage for SetGoniometer. Refs #9571

Changeset: 77ae88e65af2ef1f2237e16798a778052ae78710

[Andrei Savici]

NormaliseByThickness documentation. Refs #9571

Changeset: acd04dea2eb69a97112a0eb45b2d4cd11f492990

[Andrei Savici]

Documentation for LoadMultipleGSS. Refs #9571

Moved example files to usage data directory. Also, a minor change in ConvertToReflectometryQ

Changeset: 468a3c3c1fdd908b39b02f06e78ab1fb76d689d5

[Andrei Savici]

Documentation for GetEiMonDet and GetEiT0atSNS. Refs #9571

Changeset: f4e7c1c0aa16db73c00e2eefa09ae1531df136ea

[Andrei Savici]

Documentation for CorrectLogTimes. Refs #9571

Changeset: 9864bff7d636e540739de9aec09e4880c627ed5e

[Andrei Savici]

Fix some links in SassenaFFT documentation. Refs #9571

Changeset: 5f53c67ab29e1fb777fabcc8b99a8aea7a72916d

[Andrei Savici]

merge conflict. Refs #9571

Changeset: a67c321dd9a5987cff9ed0e24185b88de4023422

[Andrei Savici]

Sphinx warnings. Refs #9571

Changeset: 170bdde7c75c4e66dd6592541cb3424dc84a7b84

[Andrei Savici]

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.

[Andrei Savici]

Note, you might have a merge conflict on GeneratePeaks. The documentation of that will be rewritten

[Andrei Savici]

Fix a link and a warning. Refs #9571

Changeset: 745ecbc75e0a7c7dc282dc6a0db9b862ae4c4058

[Karl Palmen]

There was a merge conflict for GeneratePeaks that I could not resolve. I reopen for this conflict to resolved.

[Andrei Savici]

The conflict could be much easier solved by the tester.

[Nick Draper]

re #9571 resolve conflict

Changeset: 94570d3f63831c5f0dcefecd06db91e5d81db790

[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.

[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

[Nick Draper]

Merge remote-tracking branch 'origin/feature/9571_UsageExamples'

Full changeset: ​707a9dc716d7ae7458158c6b6cb68d1a08a5001a

[Nick Draper]

re #9571 category comment missed

Changeset: fd8845cad9958f4bd46cb3565217424e4d5f26f2

[Andrei Savici]

merge conflict. Refs #9571

Changeset: a67c321dd9a5987cff9ed0e24185b88de4023422

[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

[Stuart Campbell]

This ticket has been transferred to github issue ​10414