Continuation of the documentation ticket #9581

[Alex Buts]

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.IntegrateEllipsoids.cpp 1.FindPeaksMD.cpp 1.CentroidPeaksMD.cpp 1.CentroidPeaksMD2.cpp 1.IntegratePeaksMD.cpp 1.IntegratePeaksMD2.cpp

1. SNSPowderReduction.py

Script Vickie kindly generated to help with integration tickets. It might help you write it quicker.

######################################################################
#Python Script Generated by GeneratePythonScript Algorithm
######################################################################
Load(Filename=r'/home/vel/systemtests/Data/TOPAZ_3132_event.nxs',OutputWorkspace='TOPAZ_3132_event',LoadMonitors='1')
ConvertToMD(InputWorkspace='TOPAZ_3132_event',QDimensions='Q3D',dEAnalysisMode='Elastic',Q3DFrames='Q_sample',LorentzCorrection='1',OutputWorkspace='TOPAZ_3132_md',MinValues='-25,-25,-25',MaxValues='25,25,25',SplitInto='2',SplitThreshold='50',MaxRecursionDepth='13',MinRecursionDepth='7')
FindPeaksMD(InputWorkspace='TOPAZ_3132_md',PeakDistanceThreshold='0.37680000000000002',MaxPeaks='50',DensityThresholdFactor='100',OutputWorkspace='TOPAZ_3132_peaks')
FindUBUsingFFT(PeaksWorkspace='TOPAZ_3132_peaks',MinD='3',MaxD='15',Tolerance='0.12')
CopySample(InputWorkspace='TOPAZ_3132_peaks',OutputWorkspace='TOPAZ_3132_event',CopyName='0',CopyMaterial='0',CopyEnvironment='0',CopyShape='0')
IndexPeaks(PeaksWorkspace='TOPAZ_3132_peaks',Tolerance='0.12')
ShowPossibleCells(PeaksWorkspace='TOPAZ_3132_peaks')
SelectCellOfType(PeaksWorkspace='TOPAZ_3132_peaks',CellType='Orthorhombic',Apply='1')
CopySample(InputWorkspace='TOPAZ_3132_peaks',OutputWorkspace='TOPAZ_3132_event',CopyName='0',CopyMaterial='0',CopyEnvironment='0',CopyShape='0')
IntegrateEllipsoids(InputWorkspace='TOPAZ_3132_event',PeaksWorkspace='TOPAZ_3132_peaks',RegionRadius='0.25',PeakSize='0.20000000000000001',BackgroundInnerSize='0.20000000000000001',BackgroundOuterSize='0.25',OutputWorkspace='TOPAZ_3132_peaks')

The cross links for algorithms fixed in #9581:

1. SofQW.cpp
2. SofQW3.cpp
3. SofQW2.cpp
4. Logarithm.cpp
5. ConvertToYSpace.cpp
6. DetectorEfficiencyCor.cpp
7. PDFFourierTransform.cpp
8. ConvertToMDMinMaxLocal.cpp
9. ConvertToMDMinMaxGlobal.cpp
10. PreprocessDetectorsToMD.cpp
11. ConvertToMD.cpp
12. CompareMDWorkspaces.cpp
13. SavePAR.cpp
14. SavePHX.cpp
15. CreateMDHistoWorkspace.cpp
16. MergeMD.cpp
17. QueryMDWorkspace.cpp
18. OneStepMDEW.cpp
19. GroupDetectors2.cpp
20. LoadInstrument.cpp
21. UpdateInstrumentFromFile.cpp
22. LoadDetectorInfo.cpp

also should be checked.

[Alex Buts]

(In #9581) Closed as it is to avoid big documentation merge.

Please, note that some cross-links are incorrect in initial algorithms. I am aware of this and will fix this in #9799

[Alex Buts]

refs #9799 Initial changes to IntegrateEllipsoids

Changeset: d426b3b29c1deac0ac09c4ccdcf1e470cafd1b62

[Nick Draper]

Make sure you check the links in the properties text and summary for ConvertToMD - in general avoid links there.

[Alex Buts]

refs #9799 Integrate peaks V1 and V2

Changeset: 34adc7a25cbadb4207b0f5d2967cce4b5710ae19

[Alex Buts]

refs #9799 running FindPeaksMD-v1.rst

it is long but let it run for now.

Changeset: 77f6d8af590679a9a68926d9afee857d1a5b6dbe

[Alex Buts]

refs #9799 Fixing conflict with develop

Merge branch 'feature/9799_SphinxDocs' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/LoadDetectorInfo-v1.rst

Changeset: 828fe6c62a98813b3d61a0fed0d477bdceeda886

[Alex Buts]

refs #9799 CentroidPeaksMD and the disabling test in FindPeaksMD

Changeset: 7de3b4b75dcef67bca8abfb7922972f2c8a2021f

[Alex Buts]

refs #9799 Cross references fixed

Changeset: d5c23986dfab536aa4ffc4d49404806407bdcf94

[Alex Buts]

refs #9799 conflicts with develop

Merge branch 'feature/9799_SphinxDocs' into develop

Conflicts:

Code/Mantid/Framework/MDAlgorithms/src/ConvertToMDParent.cpp Code/Mantid/docs/source/algorithms/GroupDetectors-v2.rst Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst Code/Mantid/docs/source/algorithms/SofQW2-v1.rst Code/Mantid/docs/source/algorithms/SofQW3-v1.rst

Changeset: 869a04d4729242438946a3a967821c4ad64c98a0

[Alex Buts]

refs #9799 syntax error in properties

Changeset: 365b3228e68e584499c2b9e4c8b8fa8bfff258f7

[Alex Buts]

fixed subj to allowing tests with large files. otherwise fixed as it is.

[Alex Buts]

refs #9799 resolving conflicts with master

Merge branch 'master' into feature/9799_SphinxDocs

Conflicts:

Code/Mantid/docs/source/algorithms/GroupDetectors-v2.rst Code/Mantid/docs/source/algorithms/LoadDetectorInfo-v1.rst Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst Code/Mantid/docs/source/algorithms/SofQW2-v1.rst Code/Mantid/docs/source/algorithms/SofQW3-v1.rst

Changeset: 4556301a5694331446551038b9d96b499e1bd996

[Alex Buts]

refs #9799 fixing merge conflicts with develp

Merge branch 'feature/9799_SphinxDocs' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/SofQW2-v1.rst Code/Mantid/docs/source/algorithms/SofQW3-v1.rst

Changeset: 599c624e372bce3668012248001133b6cc079acf

[Alex Buts]

refs #9799 removed references to MDTransfFactory page from properties

Changeset: 202415f4d97bb9cc071dd600a7163930e12fa0af

[Alex Buts]

refs #9799 conflicts with develop

Merge branch 'feature/9799_SphinxDocs' into develop

Conflicts:

Code/Mantid/Framework/MDAlgorithms/src/ConvertToMDParent.cpp

Changeset: 17adb189d70eed63a5e14b7196d58d34b06a2e26

[Andrei Savici]

NOTE about hyperlinks

If you use the same name for the hyperlinks, you MUST make them anonymous using two underscores:

`MD <http://mysite.com/MD1.html>__`
and
`MD <http://mysite.com/MD2.html>__`

This is your problem when you have two links named "md transformation factory" pointing to different sites

[Alex Buts]

refs #9799 Trying to fix warning 8

Changeset: 0a29ad9bfe9bafbd962b440e122e1ea19b5bbb3c

[Alex Buts]

refs #9799 conflicts with develop

Merge branch 'feature/9799_SphinxDocs' into develop

Conflicts:

Code/Mantid/Framework/MDAlgorithms/src/ConvertToMDParent.cpp

Changeset: 2a90933af4b5777bb8546e12ee822da5f6dcc4fd

[Roman Tolchenov]

A couple of issues:

• Descriptions of properties OutputWorkspace and MinValues of ConvertToMD have broken links.
• SavePAR and SavePHX have bad formatting.

[Alex Buts]

refs #9799 Fixing links in ConvertToMD

Changeset: 7b9811de6bbb9aea49c69bf09c7a6322eb15e193

[Alex Buts]

refs #9799 More comments to the code, which has not been executed.

+ minor changes to convertToMD

Changeset: 73add231600735390eb664006d47a7093b7f4ecd

[Roman Tolchenov]

This commit message ended up in a wrong ticket:

refs #977 Par and Phx descriptions reformatted as a tables.

Changeset: d747972505f5fcbef6a057b78b30b07713d57b33

[Roman Tolchenov]

Merge remote-tracking branch 'origin/feature/9799_SphinxDocs'

Full changeset: ​dfaec7050157c227a25bcb0ec1774d6c4e85a010

[Stuart Campbell]

This ticket has been transferred to github issue ​10641