Ticket #9573 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by: Nick Draper Owned by: Wenduo Zhou
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Nick Draper

Description (last modified by Wenduo Zhou) (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 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 (*)

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Peter Peterson to Wenduo Zhou
  • 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 Wenduo Zhou

  • Status changed from assigned to inprogress

Refs #9573. Checkpointing work for docs of 2 algorithms.

  1. CalculateZscore;
  2. EstimatePDDetectorResolution

Changeset: 96ba8e7cd9cbbf4f1a694f696306fc7a245fd746

comment:3 Changed 6 years ago by Wenduo Zhou

Refs #9573. Checkpointing work with 2 more algorithms.

  1. CreateLogTimeCorrection
  2. FixGSASInstrumentFile with a new sample file

Changeset: 83e08b284e91ba881727e217047e098f00a38c4e

comment:4 Changed 6 years ago by Wenduo Zhou

Edited 2 more algorithms' doc. Refs #9573.

Changeset: c573622ae5b243c95622ebb516c3ac1d6a71c51c

comment:5 Changed 6 years ago by Wenduo Zhou

Fixed 2 errors. Refs #9573.

Changeset: c0c8b26045348cf59b883ba7b5973743c3c6df1f

comment:6 Changed 6 years ago by Martyn Gigg

Disable doctest while debugging.

Refs #9573

Changeset: 308990d00b83a3518683e72120011ed6b06a8abf

comment:7 Changed 6 years ago by Wenduo Zhou

Refs #9573. Edit 3 more algorithms and fixed 1 other.

Changeset: a09e7bfae76aa17c00c6ab65f6dc9a74f4f9d1a4

comment:8 Changed 6 years ago by Wenduo Zhou

Tried to fix the failure from build server. Refs #9573.

Changeset: 8222cd802785ffba70375acf5bd1c0d5fbaf01a4

comment:9 Changed 6 years ago by Wenduo Zhou

Fixed an error in usage. Refs #9573.

Changeset: 9b07ee1da7929d282f6b6f91bdeea6ad3affeb71

comment:10 Changed 6 years ago by Wenduo Zhou

Fixed a python error. Refs #9573.

Changeset: 853d97f3dd7b8c679fae6d9e97d8f72805be5f43

comment:11 Changed 6 years ago by Karl Palmen

In particular, FitPeak needs to have an adequate information.

comment:12 Changed 6 years ago by Wenduo Zhou

Corrected files' mode. Refs #9573.

Changeset: 54f59fd3cd3ef3c0a1f1e172ca725d0aee54e85a

comment:13 Changed 6 years ago by Wenduo Zhou

Refs #9573. Edited 4 more algorithms' docs.

Changeset: 4325dac57e476145c73a28f075028f3306409fc3

comment:14 Changed 6 years ago by Wenduo Zhou

  • Description modified (diff)

comment:15 Changed 6 years ago by Wenduo Zhou

Corrected some auto-transferred doc. Refs #9573.

Changeset: baba2301ac98f9986ccd544fb3c511073bfe4bbd

comment:16 Changed 6 years ago by Wenduo Zhou

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

comment:17 Changed 6 years ago by Wenduo Zhou

Refs #9573. Attempted to fix 3 usage tests error.

Changeset: 0f3de367c3228ca4627b20533b95f569270368ae

comment:18 Changed 6 years ago by Wenduo Zhou

Removed extra output. Refs #9573.

Changeset: 0b211ede4350abf3b99c1c7f2d9eb4f15ce34e84

comment:19 Changed 6 years ago by Martyn Gigg

Fix usage example test failures.

Problems were due to print statements that should be logger statements or non-matching whitespace between expected/output statements for usage tests. Refs #9573

Changeset: a8feaf77c431e02ab8efe36159ff935a46468717

comment:20 Changed 6 years ago by Nick Draper

  • Status changed from verify to verifying
  • Tester set to Nick Draper

comment:21 Changed 6 years ago by Nick Draper

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9573_doc_usage_wz'

Full changeset: ​6eb70713e4cb697f40b7311e86501b7c1fab4ecc

comment:22 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10416

Note: See TracTickets for help on using tickets.