Ticket #9610 (assigned)

Opened 6 years ago

Last modified 5 years ago

Add algorithm usage examples (cloned)

Reported by: Nick Draper Owned by: Peter Peterson
Priority: critical Milestone: Release 3.5
Component: Documentation Keywords:
Cc: Blocked By: #9572
Blocking: Tester:

Description (last modified by Peter Peterson) (diff)

Cloned from #9572:


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. ResampleX.cpp
  2. ConvertToEventWorkspace.cpp
  3. AnyShapeAbsorption.cpp now in #9638
  4. ApplyTransmissionCorrection.cpp
  5. ChangePulsetime.cpp
  6. FindPeakBackground.cpp
  7. ClearMaskFlag.cpp
  8. RadiusSum.cpp
  9. CloneWorkspace.cpp
  10. ResetNegatives.cpp
  11. ModeratorTzero.cpp
  12. ModeratorTzeroLinear.cpp
  13. ConvertToHistogram.cpp
  14. ConvertToPointData.cpp
  15. SetUncertainties.cpp
  16. PointByPointVCorrection.cpp
  17. MaskDetectorsIf.cpp
  18. CalibrateRectangularDetectors.py
  19. PDDetermineCharacterizations.py
  20. NexusTester.cpp
  21. PDLoadCharacterizations.cpp
  22. RawFileInfo.cpp
  23. SaveCalFile.cpp
  24. SaveIsawDetCal.cpp
  25. SetSampleMaterial.cpp
  26. SaveIsawQvector.cpp
  27. RemoveLowResTOF.cpp

Change History

comment:1 Changed 6 years ago by Peter Peterson

  • Blocked By 9572 added

comment:2 Changed 6 years ago by Peter Peterson

  • Status changed from new to assigned
  • Description modified (diff)

comment:3 Changed 6 years ago by Peter Peterson

  • Description modified (diff)
  • Summary changed from Check Documentation and add algorithm usage examples (cloned) to Add algorithm usage examples (cloned)

comment:4 Changed 6 years ago by Peter Peterson

  • Description modified (diff)

comment:5 Changed 6 years ago by Peter Peterson

  • Description modified (diff)

Removing AnyShapeAbsorption from the list

comment:6 Changed 6 years ago by Peter Peterson

  • Milestone changed from Release 3.2 to Release 3.3

comment:7 Changed 6 years ago by Peter Peterson

  • Milestone changed from Release 3.3 to Release 3.4

comment:8 Changed 5 years ago by Nick Draper

  • Milestone changed from Release 3.4 to Release 3.5

Moved to R3.5 at the end of R3.4

comment:9 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10453

Note: See TracTickets for help on using tickets.