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 #10416

Closed
NickDraper opened this issue Jun 3, 2014 · 1 comment
Closed

Check Documentation and add algorithm usage examples #10416

NickDraper opened this issue Jun 3, 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

@NickDraper
Copy link
Contributor

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

Check the documentation of the following algorithms, and make the usage examples for those without (*) followed.

  1. CalculateZscore.cpp
  2. EstimatePDDetectorResolution.cpp
  3. FixGSASInstrumentFile.cpp
  4. CreateLogTimeCorrection.cpp
  5. SaveGSASInstrumentFile.cpp
  6. ExtractMaskToTable.cpp
  7. CountEventsInPulses.cpp
  8. ExportTimeSeriesLog.cpp
  9. FitPeak.cpp
  10. InvertMask.cpp
  11. SortEvents.cpp
  12. ProcessBackground.cpp (*)
  13. RefinePowderInstrumentParameters3.cpp (*)
  14. FitPowderDiffPeaks.cpp (*)
  15. LeBailFit.cpp (*)
  16. RefinePowderInstrumentParameters.cpp (*)
  17. ExportExperimentLog.py
  18. ExportSampleLogsToCSVFile.py
  19. MergeLogs.cpp
  20. ProcessDasNexusLog.cpp (*)
  21. RenameLog.cpp
  22. SaveDspacemap.cpp
  23. SaveFullprofResolution.cpp
  24. CreateLeBailFitInput.py
  25. ExaminePowderDiffProfile.py (*)
  26. LoadFullprofFile.py (*)
  27. RefinePowderDiffProfileSeq.py (*)
  28. SelectPowderDiffPeaks.py (*)
@NickDraper
Copy link
Contributor Author

This issue was originally trac ticket 9573

@NickDraper NickDraper 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
@NickDraper NickDraper added this to the Release 3.2 milestone Jun 3, 2015
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