Ticket #9581 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by: Nick Draper Owned by: Alex Buts
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By: #9769
Blocking: #9799 Tester: Nick Draper

Description (last modified by Alex Buts) (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

  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

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner changed from Michael Reuter to Alex Buts
  • Description modified (diff)
  • Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation and add algorithm usage examples

comment:2 Changed 6 years ago by Alex Buts

  • Status changed from assigned to inprogress

refs #9581 First changes to SofQ code (format of properties)

Changeset: a6829aa648d22b38d87e46c5bc13a531b0508ea4

comment:3 Changed 6 years ago by Alex Buts

refs #9581 further playing with SofQW docs

Changeset: 724a1b79c8c203034d76404449bbee54afa71c2c

comment:4 Changed 6 years ago by Samuel Jackson

  • Description modified (diff)

comment:5 Changed 6 years ago by Samuel Jackson

Script Vickie kindly generated for me. 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')

comment:6 Changed 6 years ago by Alex Buts

refs #9581 Intermediate checkout (partial changes)

Changeset: 2bbe5d698c98baa4093199fab42c90e0613656a3

comment:7 Changed 6 years ago by Alex Buts

refs #9581 finished SofQW

Changeset: 50a78bcc5544a211f262d610cdf8dffc8c9f520c

comment:8 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:9 Changed 6 years ago by Alex Buts

refs #9581 Warnings aa

Changeset: b6e834cd5de474757fd92b90ca233e63ccef887d

comment:10 Changed 6 years ago by Alex Buts

refs #9581 SofQW2 modified appropriately

Changeset: 0d412d0a679a3ca72c6535719444f95428f202c2

comment:11 Changed 6 years ago by Alex Buts

refs #9581 SofQW3-v1.rst and its tests

Changeset: 2a90bac3b71e15c6242363af20c4a32efcf253ab

comment:12 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:13 Changed 6 years ago by Alex Buts

refs #9581 Logarithm docs

Changeset: 8d757c3ea2ce83962230b37783049e7ab8338db3

comment:14 Changed 6 years ago by Alex Buts

refs #9581 Intermediate checkout

Changeset: 1e0463771f7c133c5506f868f764d4bda96ba0cc

comment:15 Changed 6 years ago by Alex Buts

refs #9581 ConvertToYSpace sample

Changeset: 9f4fcbe6bcbdc7f888bad7580510ac160401677e

comment:16 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:17 Changed 6 years ago by Alex Buts

refs #9581 DetectorEfficiencyCorrections

Changeset: 2e2cef2e3596a449f9a5c4046c7f77eb89835685

comment:18 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:19 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:20 Changed 6 years ago by Alex Buts

refs #9581 PDFFourierTransform description and usage sample

Changeset: e4b66e86c3f1b75f016a160715c330cb79a192f6

comment:21 Changed 6 years ago by Alex Buts

refs #9581 Intermediate changes to ConvertToMD&related documentation

Changeset: ac7de9814ba43ed2de58a9da2343a194f8346c98

comment:22 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:23 Changed 6 years ago by Alex Buts

refs #9581 ConvertToMD limits

Changeset: c033a9e843b0f7623d630ad14fb1e834bd58710f

comment:24 Changed 6 years ago by Alex Buts

refs #9581 Parts of ConvertToMD

Changeset: 758cba019b718bf7fdea01d7f8d32a92f4d03eb3

comment:25 Changed 6 years ago by Alex Buts

refs #9581 ConvertToMD tests and docs

Changeset: 982697ff12fc6556bde6c8e1457d0b97dd5b3821

comment:26 Changed 6 years ago by Alex Buts

refs #9581 PreprocessDetectorsToMD documentation and test samples

Changeset: 03e8cb61d9e12444636e37be49998740dd65cb7b

comment:27 Changed 6 years ago by Alex Buts

refs #9581 conflicts with develop (probably due to untested tickets)

Merge branch 'feature/9581_SphinxChanges' into develop

Conflicts:

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

Changeset: 9dacc2f9294a66c4e34866a0e77fd42ade78ed93

comment:28 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:29 Changed 6 years ago by Alex Buts

refs #9581 CompareMDWorkspaces sample&test code

Changeset: a8bcdd54b19d8c5907cb786c29126870f070971b

comment:30 Changed 6 years ago by Alex Buts

refs #9581 SavePAR - initial remarks

Changeset: b5639deaee49662cb166144455f226ad1a726aaa

comment:31 Changed 6 years ago by Alex Buts

refs #9581 SavePAR usage

Changeset: 0b21d10d5009c15d18d4da481610e752fcf910da

comment:32 Changed 6 years ago by Alex Buts

refs #9581 SavePHX usage examples

Changeset: f75747672c09343a1d4b52cc465177088a5fea50

comment:33 Changed 6 years ago by Alex Buts

refs #9581 CreateHistoWorkspace usage samples

Changeset: fdf06e179ad71e9f8eaf2e7bc2e4897246832b69

comment:34 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:35 Changed 6 years ago by Alex Buts

refs #9581 fixing bunch of Sphinx warnings.

Changeset: e1e7b1499499be326bcf7565674cea26e210fd00

comment:36 Changed 6 years ago by Alex Buts

refs #9581 MergeMD usage samples

Changeset: 149bd464b9742a1db2236b517e8fc6fe23fe975a

comment:37 Changed 6 years ago by Alex Buts

refs #9581 QueryMDWorkspace documentation

Changeset: dd0022ce919d42b349c4bd31becaa6810b0d5b3a

comment:38 Changed 6 years ago by Alex Buts

refs #9581 Usage for OneStepMDEW

Changeset: 63ad8c4595647be7bde29b246ece4248c2f2095d

comment:39 Changed 6 years ago by Alex Buts

refs #9581 fixing QueryMDWorkspace on Unix

Changeset: 0b3177feff0c6b52e62563ff163cccef6e28542f

comment:40 Changed 6 years ago by Alex Buts

refs #9581 Intermediate changes to GroupDetectors

Changeset: 081460926274e2a554a99a57c08f421478b76ea5

comment:41 Changed 6 years ago by Alex Buts

refs #9581 Warnings in IntegratePeaksMD

Changeset: 1c0ffdf8dd961f284f69c5db05bb313f8fef06d1

comment:42 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:43 Changed 6 years ago by Alex Buts

refs #9581 GroupDetectors finished

+SNSPowderReduction -- meaningful contents string

Changeset: 70966c2d90b0fb44fa837712acfdadefefb279dc

comment:44 Changed 6 years ago by Alex Buts

refs #9581 LoadInstrument documentation

Changeset: 4a037a39ad9377eeed5f69ae52e525f241b0ac33

comment:45 Changed 6 years ago by Alex Buts

refs #9581 UpdateInstrumentFromFile documentation

Changeset: 0183e98b34250285eaad13db693510986701bbd0

comment:46 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:47 Changed 6 years ago by Alex Buts

refs #9581 updated branch to master and fixing merge conflicts

caused by the documentation changes.

Merge branch 'master' into feature/9581_SphinxChanges

Conflicts:

Code/Mantid/Framework/MDAlgorithms/src/ConvertToMDParent.cpp Code/Mantid/docs/source/algorithms/DetectorEfficiencyCor-v1.rst Code/Mantid/docs/source/algorithms/LoadInstrument-v1.rst Code/Mantid/docs/source/algorithms/MergeMD-v1.rst Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst Code/Mantid/docs/source/algorithms/UpdateInstrumentFromFile-v1.rst

Changeset: 4fb5515109c73ea3c26085c0a9471993491bf20d

comment:48 Changed 6 years ago by Alex Buts

refs #9581 Conflicts with develop

Merge branch 'feature/9581_SphinxChanges' into develop

Conflicts:

Code/Mantid/Framework/MDAlgorithms/src/ConvertToMDParent.cpp Code/Mantid/docs/source/algorithms/DetectorEfficiencyCor-v1.rst Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst

Changeset: 67ca19e977468d619274dc561ba5e62e5012132e

comment:49 Changed 6 years ago by Alex Buts

refs #9581 fixing error related to changes in #9769

Changeset: ae2118ed09902e3b8582cf68f54f77cfef2dad5f

comment:50 Changed 6 years ago by Alex Buts

  • Blocked By 9769 added

comment:51 Changed 6 years ago by Alex Buts

refs #9581 LoadDetectorInfo description

and small changes to number of other files.

Changeset: c1240f929e60df09a5178a427acaea7bf0c43fdb

comment:52 Changed 6 years ago by Alex Buts

refs #9581 LoadDetectorInfo completed

Changeset: 1ad5da84b31b604c4cb5d16ad6d6183fe33578b8

comment:53 Changed 6 years ago by Alex Buts

refs #9581 Resolving conflicts with develop

Merge branch 'feature/9581_SphinxChanges' into develop

Conflicts:

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

Changeset: d6276f1ca5a5b3f5d05c41c67b5f251578732711

comment:54 Changed 6 years ago by Alex Buts

  • Description modified (diff)

comment:55 Changed 6 years ago by Alex Buts

  • Blocking 9799 added

comment:55 Changed 6 years ago by Alex Buts

  • Status changed from inprogress to verify
  • Resolution set to fixed
  • Blocking 9799 removed

Closed as it is to avoid big documentation merge.

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

Last edited 6 years ago by Alex Buts (previous) (diff)

comment:56 Changed 6 years ago by Alex Buts

  • Blocking 9799 added

comment:57 Changed 6 years ago by Nick Draper

  • Status changed from verify to verifying
  • Tester set to Nick Draper

comment:59 Changed 6 years ago by Nick Draper

minor link and other changes. re #9581

Changeset: 0904608503b2023b9159a0fd6f78d746a0f8f8b7

comment:60 Changed 6 years ago by Nick Draper

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9581_SphinxChanges'

Full changeset: a2ea73c8c63a74a1a2fc882267da1517f082faf0

comment:61 Changed 6 years ago by Alex Buts

refs #9581 conflicts with develop (probably due to untested tickets)

Merge branch 'feature/9581_SphinxChanges' into develop

Conflicts:

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

Changeset: 9dacc2f9294a66c4e34866a0e77fd42ade78ed93

comment:62 Changed 6 years ago by Alex Buts

refs #9581 Conflicts with develop

Merge branch 'feature/9581_SphinxChanges' into develop

Conflicts:

Code/Mantid/Framework/MDAlgorithms/src/ConvertToMDParent.cpp Code/Mantid/docs/source/algorithms/DetectorEfficiencyCor-v1.rst Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst

Changeset: 67ca19e977468d619274dc561ba5e62e5012132e

comment:63 Changed 6 years ago by Alex Buts

refs #9581 Resolving conflicts with develop

Merge branch 'feature/9581_SphinxChanges' into develop

Conflicts:

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

Changeset: d6276f1ca5a5b3f5d05c41c67b5f251578732711

comment:64 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10424

Note: See TracTickets for help on using tickets.