Ticket #9704 (assigned)

Opened 6 years ago

Last modified 5 years ago

Add algorithm usage examples lot 2

Reported by: Nick Draper Owned by: Stuart Campbell
Priority: critical Milestone: Release 3.5
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Nick Draper) (diff)

Cloned from #9612:

Cloned from #9577:

Please 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. DetectorDiagnostic.cpp
  2. ExponentialMD.cpp
  3. LogarithmMD.cpp
  4. MergeMDFiles.cpp
  5. PowerMD.cpp
  6. BinMD.cpp
  7. ConvertToDetectorFaceMD.cpp
  8. MaskMD.cpp
  9. CombinePeaksWorkspaces.cpp
  10. DiffPeaksWorkspaces.cpp
  11. FilterPeaks.cpp
  12. EQSANSAzimuthalAverage1D.py
  13. EQSANSDirectBeamTransmission.py
  14. EQSANSNormalise.py
  15. CreateChopperModel.cpp
  16. CreateModeratorModel.cpp
  17. CreateSimulationWorkspace.cpp
  18. TOFSANSResolution.cpp
  19. LoadParameterFile.cpp
  20. LoadSpec.cpp
  21. SaveMask.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Description modified (diff)
  • Summary changed from Add algorithm usage examples (cloned) to Add algorithm usage examples lot 2

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:3 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.2 to Release 3.3

comment:4 Changed 6 years ago by Karl Palmen

The adding of a flowchart to DetectorDiagnostic is covered by ticket #9126.

comment:5 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.3 to Release 3.4

Moved at the end of R3.3

comment:6 Changed 5 years ago by Karl Palmen

I'm now working on ticket #9126 to add a flowchart to the DetectorDiagnostic documentation.

Karl Palmen

comment:7 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:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10546

Note: See TracTickets for help on using tickets.