Ticket #9587 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and Add Algorithm Usage Examples - Part 1

Reported by: Nick Draper Owned by: Peter Parker
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Anders Markvardsen

Description (last modified by Peter Parker) (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, 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. SaveCanSAS1D.cpp
  2. SaveNXSPE.cpp
  3. SaveCanSAS1D2.cpp
  4. RetrieveRunInfo.py
  5. SANSBeamFluxCorrection.cpp
  6. CreateEmptyTableWorkspace.py
  7. SANSWideAngleCorrection.py
  8. FindDetectorsInShape.cpp
  9. LoadPreNexusMonitors.cpp
  10. SaveNISTDAT.cpp
  11. SaveRKH.cpp
  12. UnwrapMonitor.cpp
  13. LoadInstrumentFromRaw.cpp
  14. LoadRawBin0.cpp
  15. LoadInstrumentFromNexus.cpp
  16. ChopData.cpp
  17. ConvertSpectrumAxis.cpp
  18. MergeRuns.cpp
  19. LoadMuonLog.cpp
  20. CreatePSDBleedMask.cpp [Already done elsewhere]
  21. FindCenterOfMassPosition2.cpp [Already done elsewhere]

The rest have been moved to #9804.

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Ross Miller to Peter Parker
  • Status changed from new to assigned
  • 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 Peter Parker

  • Status changed from assigned to inprogress

Refs #9587 - Docs for SaveCanSAS1D versions 1 and 2.

Changeset: 94a23cd08d3afcfca86c93e27d7f98c435229352

comment:3 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for SaveNXSPE.

Changeset: a3202ac76ee1f927ec839166f0b8a90ce802a004

comment:4 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for CreateEmptyTableWorkspace.

Changeset: 66382909211387800e77a5c0f86a4fb8758250ad

comment:5 Changed 6 years ago by Peter Parker

Refs #9587 - Slight amendments.

Changeset: 9562e6197fa26285cf31605e8130ff76660fddd7

comment:6 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:7 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for FindDetectorsInShape.

Changeset: 9e5df049a3d8da06f1a84f65feb64bbe2b8ba91e

comment:8 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:9 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:10 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for LoadPreNexusMonitors.

Changeset: c9f7924aef6833120751cc749f2c0c7c1cb50ffc

comment:11 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for SaveRKH.

Changeset: 05852b3e0c0d3ed973cf13f4e45651619c68ccf7

comment:12 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for RetrieveRunInfo.

Changeset: b986c2ac82e730521f7b380e768220c428dbf4e2

comment:13 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:14 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:15 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for SANSBeamFluxCorrection.

Changeset: 94e193b8d678e35f22e8651e4e4dfb434c8e9add

comment:16 Changed 6 years ago by Peter Parker

Refs #9587 - Correct usage example.

Changeset: ab68fa0d5602f9f59a7b40abc22d1d1de192fa59

comment:17 Changed 6 years ago by Peter Parker

Merge branch 'feature/9587_alg_documentation' into develop

Conflicts:

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

Looks like Jay was also given UnwrapMonitor. Use my example instead of his. Refs #9587.

Changeset: 62e4f553d8096fab67ffddd2cedcf4f16ca55db1

comment:18 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:19 Changed 6 years ago by Peter Parker

Refs #9587 - Hopefully fix broken usage example test.

Changeset: b1c7cc3274f608794727dda0c9df1085dc1caeed

comment:20 Changed 6 years ago by Peter Parker

Refs #9587 - Attempt at narrowing down weird build failure.

Changeset: 81220945a28b507a5c14959cca2fe8738d428007

comment:21 Changed 6 years ago by Peter Parker

Merge branch 'bugfix/9641_clear_prop_man_data_service' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/GetEi-v2.rst

Looks like we've had a conflict here before, caused by a slight difference in indentation in GetEi-v2.rst. Hopefully I've picked the right one to avoid people further conflicts. Refs #9587.

Changeset: c88bdca833d8e97ef656fd6bf9f3f4076ab22f80

comment:22 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for SaveNISTDAT.

Changeset: e5e7dec06943bb2b4b010966e07ce25419fa6ff2

comment:23 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for SANSWideAngleCorrection.

Changeset: 49db0b92504e7cd687cb8547c63699c88974c096

comment:24 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:25 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for LoadInstrumentFromRaw.

Changeset: 9161d269979d9dadd0459c298edb4645d3dac3c6

comment:26 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for LoadRawBin0.

Changeset: a2bffb2a36161ada9d4eddf3480ec1a9ef324d0e

comment:27 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:28 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for LoadInstrumentFromNexus.

Changeset: 3cda8ff97400ac57aeff232d25226f991310e038

comment:29 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:30 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for ChopData plus amendments.

Changeset: 995fecd68caced66102dea30f0ab8b553a6c805d

comment:31 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:32 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for ConvertSpectrumAxis V1.

Shamelessly steal from Martyns V2 docs.

Changeset: 1f74f41a40aa5252e779a114510d587ba885adb6

comment:33 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:34 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for MergeRuns.

Changeset: 7910d608617f69c423ecfe34bd0443c35e3a27fc

comment:35 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:36 Changed 6 years ago by Peter Parker

Refs #9587 - Silence warnings.

Changeset: 1580414d066a8356181d20bbe99eb4bef3c2c448

comment:37 Changed 6 years ago by Peter Parker

Refs #9587 - Fix errors.

Very strange, since these all ran fine on my Win 64 build...

Changeset: b41ca7db4967a25653ccd003075b26447cfec806

comment:38 Changed 6 years ago by Peter Parker

Refs #9587 - Remove call to temperamental method in usage example.

Changeset: fdb0aa7d37d96d9f39529774e8bc6a369444f2b9

comment:39 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:40 Changed 6 years ago by Peter Parker

Merge branch 'master' into feature/9587_alg_documentation

Conflicts:

Code/Mantid/docs/source/algorithms/CalculateTransmission-v1.rst Code/Mantid/docs/source/algorithms/LoadRawBin0-v1.rst Code/Mantid/docs/source/algorithms/MergeRuns-v1.rst Code/Mantid/docs/source/algorithms/Q1D-v2.rst Code/Mantid/docs/source/algorithms/UnwrapMonitor-v1.rst

Refs #9587 - Merge in master, fixing conflicts.

Changeset: c2ac7596435c1f0e56571871cdcf31f64a121830

comment:41 Changed 6 years ago by Peter Parker

Refs #9587 - Docs for LoadMuonLog.

Changeset: 150e3e0570784e9f55e163ba97564c53e1f6a119

comment:42 Changed 6 years ago by Peter Parker

  • Description modified (diff)

comment:43 Changed 6 years ago by Peter Parker

Merge branch 'feature/9587_alg_documentation' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/LoadRawBin0-v1.rst Code/Mantid/docs/source/algorithms/MergeRuns-v1.rst Code/Mantid/docs/source/algorithms/Q1D-v2.rst Code/Mantid/docs/source/algorithms/UnwrapMonitor-v1.rst

Refs #9587.

Changeset: ac8857c6e12d3bca16fec98675a01ef2d0a2a77e

comment:44 Changed 6 years ago by Peter Parker

  • Description modified (diff)
  • Summary changed from Check Documentation and add algorithm usage examples to Check Documentation and Add Algorithm Usage Examples - Part 1

comment:45 Changed 6 years ago by Peter Parker

  • Status changed from inprogress to verify
  • Resolution set to fixed

Testing as per other documentation tickets. I'm open to constructive criticism about the algorithms I've documented.

The 8 remaining algorithms I had have been moved to #9804.

comment:46 Changed 6 years ago by Anders Markvardsen

  • Status changed from verify to verifying
  • Tester set to Anders Markvardsen

comment:47 Changed 6 years ago by Anders Markvardsen

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9587_alg_documentation'

Full changeset: ​355ee4ac3388c57b99e6f2e37e4bd641485579f2

comment:48 Changed 6 years ago by Peter Parker

Merge branch 'feature/9587_alg_documentation' into develop

Conflicts:

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

Looks like Jay was also given UnwrapMonitor. Use my example instead of his. Refs #9587.

Changeset: 62e4f553d8096fab67ffddd2cedcf4f16ca55db1

comment:49 Changed 6 years ago by Peter Parker

Merge branch 'bugfix/9641_clear_prop_man_data_service' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/GetEi-v2.rst

Looks like we've had a conflict here before, caused by a slight difference in indentation in GetEi-v2.rst. Hopefully I've picked the right one to avoid people further conflicts. Refs #9587.

Changeset: c88bdca833d8e97ef656fd6bf9f3f4076ab22f80

comment:50 Changed 6 years ago by Peter Parker

Merge branch 'feature/9587_alg_documentation' into develop

Conflicts:

Code/Mantid/docs/source/algorithms/LoadRawBin0-v1.rst Code/Mantid/docs/source/algorithms/MergeRuns-v1.rst Code/Mantid/docs/source/algorithms/Q1D-v2.rst Code/Mantid/docs/source/algorithms/UnwrapMonitor-v1.rst

Refs #9587.

Changeset: ac8857c6e12d3bca16fec98675a01ef2d0a2a77e

comment:51 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10430

Note: See TracTickets for help on using tickets.