Check Code Documentation and add Usage Examples

[Karl Palmen]

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

Algorithms:

1. CopyLogs.cpp
2. CreateTransmissionWorkspace.cpp
3. FilterEvents.cpp
4. FindPeaks.cpp
5. GeneralisedSecondDifference.cpp
6. GetTimeSeriesLogInformation.cpp
7. MaskBins.cpp
8. MaskBinsFromTable.cpp
9. NormaliseByCurrent.cpp
10. NormaliseToMonitor.cpp
11. PerformIndexOperations.cpp
12. ReadGroupsFromFile.cpp
13. ReflectometryReductionOne.cpp

Crystal:

1. ClearUB.cpp
2. GoniometerAnglesFromPhiRotation.cpp
3. IndexPeaks.cpp
4. ShowPeakHKLOffsets.cpp

MD Algorithms:

1. ThresholdMD.cpp

SINQ:

1. MDHistoToWorkspace2D.cpp

WorkflowAlogirthms:

1. StepScan.cpp

These are the algorithms outstanding from #9567

[Karl Palmen]

Algorithms of category 'Algorithm' delegated to ticket #10052.

[Karl Palmen]

Usage Example for ThresholdMD re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 99dfaba202c9904f261250eb7e1d007f666a0e41

[Karl Palmen]

Add usage example to MDHistoToWorkspace2D-v1.rst re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 7af3197b7c3b05af0067f54141c81c4e37f2f891

[Karl Palmen]

Add start of flowchart for StepScan re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 82680b86b46cf118f78b0357692084f3075df327

[Karl Palmen]

Add flowchart to StepScan-v1.rst re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 98d9ae93024d5f79bf45565b8f5738acc60a8694

[Karl Palmen]

Add usage example to IndexPeaks re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 895192741887f5b3985706c1b6aefef268f4fb38

[Karl Palmen]

(In #10077) Work on ClearUB has been completed in the branch of #9726, so should not be done here.

[Karl Palmen]

Enable ShowPeakHKLOffset to work in python re #9726

This required use of ITable instead of Table in algorithm and unit test for the output.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: bf67c21f53034e3423928fedb68f67be6e5729b0

[Karl Palmen]

Changset accidentally committed to ticket #9762

[Karl Palmen]

Add usage example to GoniometerAnglesFromPhiRotation re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: aab32ad4154ce8ad335a1133b46163cf01f1902a

[Karl Palmen]

Add usage date note to GoniometerAnglesFromPhiRotation re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: b9a3e4be41ecc877d58c1004ec5a4026e2a96e94

[Karl Palmen]

All four crystal algorithms have now had usage examples added.

[Karl Palmen]

(In #10077) All four usage examples have been dealt with in #9726. This ticket can be resolved as duplicate after #9726 has been closed.

[Nick Draper]

Moved to R3.4

[Karl Palmen]

This ticket is awaiting branch to be updated and rendered fit for git checkbuild and eventual merger with source.

[Karl Palmen]

This ticket has documentation added for 7 algorithms

ClearUB.cpp 
GoniometerAnglesFromPhiRotation.cpp 
IndexPeaks.cpp 
ShowPeakHKLOffsets.cpp 

ThresholdMD.cpp 

MDHistoToWorkspace2D.cpp  

StepScan.cpp 

Either merging an up to date master into branch needs doing or copying changes to a new branch.

[Karl Palmen]

I've decided to create new branch and copy the changes into it, merging with later changes if necessary.

[Karl Palmen]

Add data file re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 17bef3de856d2d0940a4d5cd60991676b03f9b25

[Karl Palmen]

Again accidentally committed change set cabebd8cf980611ccfad86338d1be4f3da559f05 to #9762.

[Karl Palmen]

Deal with ShowPeakHKLOffests re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 396588090b1da4073d5278281bafd3d6b04dc2e3

[Karl Palmen]

Add Stepscan flowchart re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: b9f2f7a4af48b5634825fd27cc7c593ba756258f

[Karl Palmen]

This is being verified as ​pull request #666.

[Martyn Gigg]

@KarlPalmen It looks like there is a crash in the unit tests for ShowPeakHKLOffsets

[Karl Palmen]

Make ShowPeakOffsetTest use ITable re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 0396c19e5f0c81bd2bde9e3620149f444b37f90b

[Karl Palmen]

I'm putting the usage data note in now.

[Karl Palmen]

Add usage data not to IndexPeaks re #9726

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 388508cd58344a0a31befdd3ceb8ba43fd5b3972

[Stuart Campbell]

Merge pull request #666 from mantidproject/9726_documentation

Documentation for 7 algorithms including usage examples

Full changeset: ​bf7f69a3c14c3ac53a7240fd26862576bab3d06e

[Stuart Campbell]

This ticket has been transferred to github issue ​10568