Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check Documentation and add algorithm usage examples #10470

Closed
martyngigg opened this issue Jun 10, 2014 · 1 comment
Closed

Check Documentation and add algorithm usage examples #10470

martyngigg opened this issue Jun 10, 2014 · 1 comment
Assignees
Labels
Documentation Issues and pull requests related to documentation High Priority An issue or pull request that if not addressed is severe enough to postponse a release.
Milestone

Comments

@martyngigg
Copy link
Member

This ticket is blocks : TRAC9653

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. SuggestTibCNCS.py
  2. SuggestTibHYSPEC.py
  3. TestWorkspaceGroupProperty.py - only used for testing - no example needed
  4. UpdatePeakParameterTableValue.py
  5. CreatePeaksWorkspace.cpp
  6. IdentifyNoisyDetectors.cpp
  7. OneMinusExponentialCor.cpp
  8. SANSDirectBeamScaling.cpp - unused alg may be removed
  9. StripVanadiumPeaks.cpp - two versions
  10. LoadLOQDistancesFromRaw.cpp - unused alg to be removed
  11. LoadSampleDetailsFromRaw.cpp
  12. AnvredCorrection.cpp
  13. FindUBUsingMinMaxD.cpp
  14. MaskPeaksWorkspace.cpp - very complex setup or large files - code block only
  15. OptimizeCrystalPlacement.cpp
  16. OptimizeLatticeForCellType.cpp
  17. PredictFractionalPeaks.cpp - code block only ticket 9642 created
  18. TransformHKL.cpp
  19. FindReflectometryLines.py
  20. LoadLogPropertyTable.py
  21. MonteCarloAbsorption.cpp

These are the leftovers from http://trac.mantidproject.org/mantid/ticket/9574.

@martyngigg
Copy link
Member Author

This issue was originally trac ticket 9627

@martyngigg martyngigg added High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Documentation Issues and pull requests related to documentation labels Jun 3, 2015
@martyngigg martyngigg added this to the Release 3.2 milestone Jun 3, 2015
martyngigg added a commit that referenced this issue Nov 26, 2015
martyngigg added a commit that referenced this issue Nov 26, 2015
The method is most often called in a loop so floods the log messages.
Refs #10470
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation High Priority An issue or pull request that if not addressed is severe enough to postponse a release.
Projects
None yet
Development

No branches or pull requests

2 participants