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, 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

1. CheckWorkspacesMatch.cpp
2. GeneratePythonScript.cpp
3. SumSpectra.cpp
4. SortPeaksWorkspace.cpp
5. SplineInterpolation.cpp
6. PlotPeakByLogValue.cpp
7. DensityOfStates.py
8. MuscatData.py
9. MuscatFunc.py
10. Quest.py
11. SofQWMoments.py
12. Symmetrise.py
13. QLines.py
14. FuryFitMultiple.py
15. IndirectTransmission.py
16. OSIRISDiffractionReduction.py
17. ResNorm.py
18. Stitch1D.py
19. Stitch1DMany.py
20. SaveHKL.cpp
21. SaveNexusProcessed.cpp
22. SaveFocusedXYE.cpp
23. SaveGSS.cpp

[Samuel Jackson]

Refs #9584 Add examples for CheckWorkspacesMatch.

Changeset: a88f6fda0cf49b068272e166a8d9327323f34aed

[Samuel Jackson]

Refs #9584 Add examples for GeneratePythonScript.

Changeset: f2c8427d1faf488be2fe4bd194213902d6b39300

[Samuel Jackson]

Refs #9584 Add examples for SortPeaksWorkspace

Changeset: cb149712fe8f952da4b648cdd2f8061d9a136fc2

[Samuel Jackson]

Refs #9584 Add examples for SplineInterpolation

Changeset: 3a00df0746684c4a271b2742a875777b5e05999f

[Samuel Jackson]

Refs #9584 Add examples for PlotPeakByLogValue

Changeset: f721c19301058727f45bc4ba7d4d15e5a14fd26b

[Samuel Jackson]

Refs #9584 Add examples for DensityOfStates.

Changeset: 90419465f869f33303115c1a71878e1c7f9543f8

[Samuel Jackson]

Refs #9584 Add example for SofQWMoments.

Changeset: 1eca175790e959200bd1d9491eb6c49095b048be

[Samuel Jackson]

Refs #9584 Add example for Symmetrise.

Changeset: a649506388761e67c9a6a448eb0bfd377b39de1b

[Samuel Jackson]

Refs #9584 Add example for FuryFitMultiple

Changeset: 2e0c2529f8c840d7e7b508f18d8d2228dd016193

[Samuel Jackson]

Refs #9584 Add examples for IndirectTransmission.

Changeset: 2bcf0586270df3f231010dde46ec9f3bb4099c14

[Samuel Jackson]

Refs #9584 Add examples for Stitch1D.

Changeset: f4cb058bd67d53d35bf9bd258a146d4d3e183b10

[Samuel Jackson]

Refs #9584 Amend example for OSIRISDiffractionReduction.

Changeset: f935e51fe957884eb260601cebd258d182b98966

[Samuel Jackson]

Refs #9584 Add example for Stitch1DMany

Changeset: 248e9feb62e0e1e3fc99f392fa37ae2a9269cb1e

[Samuel Jackson]

Refs #9584 Add example for SaveNexusProcessed

Changeset: 83e430fb15f3842825a92e0a0237a0862e0192a9

[Samuel Jackson]

Refs #9584 Add examples for SaveFocusedXYE

Changeset: 984c7fe88f95ca3759eccc03881dde0e19869824

[Samuel Jackson]

Refs #9584 Add examples for SaveGSS.

Changeset: 9d72d538edf3ea009ace39aabce5eb19ed80f7c7

[Samuel Jackson]

Refs #9584 Add usage example for SaveHKL

Changeset: 76db2150d2526195184357f2604b2ac808013c8f

[Samuel Jackson]

Refs #9584 Add fix broken usage examples.

Changeset: aa380566020f3a15822a0909f2aeaf86edeba93e

[Samuel Jackson]

Refs #9584 Add example for MuscatData

Changeset: 1ec6777aa1bf6f0eaff3df153e38c42c415651ac

[Samuel Jackson]

Refs #9584 Add example for MuscatFunc

Changeset: f041e04e29d8b5d3ff0e332c5e44867a81afd5bc

[Samuel Jackson]

Refs #9584 Add example for QLines

Changeset: 2ff972405c6dfe130056ccdc7428fc90463c902b

[Samuel Jackson]

Refs #9584 Add example for Quest.

Changeset: b16b601250b707c2a768f062080e4492fe54a094

[Samuel Jackson]

Refs #9584 Add example for ResNorm

Changeset: 85c91d7d644873492182b0cf234219a3b9a15515

[Samuel Jackson]

Refs #9584 Update SaveHKL with working example.

Changeset: b86d06bf780cdbfdd47b5497c31de26d243dce5a

[Samuel Jackson]

Refs #9584 Add examples for SumSpectra

Changeset: a0200e6d7014d5a923fcb6308e89ed68f6d13932

[Samuel Jackson]

Refs #9584 Correct code block syntax in Bayes usage examples.

Changeset: bede622f3b6d004bf8f04fb36b33b8005d735680

[Nick Draper]

checked to 6

[Nick Draper]

re #9584 minor changes to the doc of two algs

Changeset: 1afad51cd3b937563ed20d6977dead770ab2f042

[Samuel Jackson]

Refs #9584 Fix warnings.

Changeset: 972d6b9279201a53a10d8eae868026ccd5811f33

[Martyn Gigg]

A few minor things that should be quick to fix.

A few algorithms are missing the

Usage
-----

section header:

• PlotPeakByLogValue
• DensityOfStates

MuscatFunc seems to have a heading for a usage but no actual usage text. I think this is because the branch is not up to date on github. The final commit, in comment 37 only appears on develop on github.

The first bit of text in the summary & description for FuryFitMultiple doesn't quite make sense:

Fits and *_iqt file ...

I assume it is supposed to be Fits and *_iqt file ....

All of the usage examples for the the save tests are using path = os.path.join(config['defaultsave.directory'], however we don't set a default save for a new install so the directory may not be writable on some platforms. Can you replace all

path = os.path.join(config['defaultsave.directory']

with

path = os.path.join(os.path.expanduser("~")

That will put it in the home directory, even on windows, which is guaranteed writable.

[Samuel Jackson]

Refs #9584 Fix Typo.

Changeset: feafe028cdd0381c6e4a4cc98d9e8c00cc29a4fc

[Samuel Jackson]

Refs #9584 Fix missing usage titles.

Changeset: 99548811ef60e3537296267686bc01b8378dc0df

[Samuel Jackson]

Refs #9584 Fix default directory path issues.

Changeset: 55cbd4e6bd256c108d7e6780ec1a2bdc5c5fd87e

[Samuel Jackson]

Merge branch 'feature/9584_alg_usage_examples' of github.com:mantidproject/mantid into feature/9584_alg_usage_examples

Full changeset: ​cf6e1088e7c7ece12af925c4cf2d6e8d45c277c7

[Martyn Gigg]

Merge remote-tracking branch 'origin/feature/9584_alg_usage_examples'

Full changeset: ​97d58e3f830332f395b3ee4bf5dfa520b568121d

[Stuart Campbell]

This ticket has been transferred to github issue ​10427