Ticket #9579 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by: Nick Draper Owned by: Roman Tolchenov
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Samuel Jackson

Description (last modified by Roman Tolchenov) (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

  1. CalculateGammaBackground.cpp
  2. SplineBackground.cpp
  3. ChangeBinOffset.cpp
  4. LoadRaw.cpp
  5. LoadRaw2.cpp
  6. MaskDetectors.cpp
  7. Max.cpp
  8. GroupDetectors.cpp
  9. Integration.cpp
  10. SaveNexus.cpp
  11. SaveCSV.cpp
  12. MaskWorkspaceToCalFile.py
  13. SaveIsawPeaks.cpp
  14. ElasticWindow.cpp
  15. MultiplyRange.cpp
  16. RealFFT.cpp
  17. GetDetectorOffsets.cpp
  18. GetDetOffsetsMultiPeaks.cpp
  19. GroupWorkspaces.cpp
  20. Rebunch.cpp
  21. CreateWorkspace.cpp
  22. MaskDetectorsInShape.cpp
  23. Exponential.cpp
  24. LoadMappingTable.cpp
  25. CalculateTransmissionBeamSpreader.cpp
  26. FFTSmooth2.cpp
  27. Regroup.cpp
  28. SmoothData.cpp
  29. MoveInstrumentComponent.cpp
  30. RotateInstrumentComponent.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Mathieu Doucet to Roman Tolchenov
  • 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 Roman Tolchenov

CalculateGammaBackground will be done in #9574.

comment:3 Changed 6 years ago by Roman Tolchenov

  • Status changed from assigned to inprogress

Re #9579. Added usage section to SplineBackground

Changeset: 0eba20b32057479a17aa4cc55f9f6cab538994d2

comment:4 Changed 6 years ago by Roman Tolchenov

Re #9579. Added Usage section to ChangeBinOffset doc

Changeset: c106149817dff8adbec75d9747e7abe2ccf01f19

comment:5 Changed 6 years ago by Roman Tolchenov

Re #9579. Added usage section for LoadRaw

Changeset: 2c84e1ac34b163cc3dae646ba349a18df6ee592a

comment:6 Changed 6 years ago by Roman Tolchenov

Re #9579. Added usage for MaskDetectors

Changeset: 01f1873b12e639e365a4686893628f5ba9303f8c

comment:7 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:8 Changed 6 years ago by Roman Tolchenov

Re #9579. Defined property type string for a vector<size_t>

Changeset: 486af1f10ae555afd6ed10bacdabe9feec0d0b05

comment:9 Changed 6 years ago by Roman Tolchenov

Re #9579. Added Max usage section.

Changeset: 527cb5bd2eaf39485aa653a1b6fd10853ec22abf

comment:10 Changed 6 years ago by Roman Tolchenov

Re #9579. Done pages for GroupDetectors versions 1 and 2.

Changeset: d835363b541a3cebc49565c84d0035bc74caf3dd

comment:11 Changed 6 years ago by Roman Tolchenov

Re #9579. Forgot the usage data include.

Changeset: 14c6950b50dd0c3c271bf1c2d5780fedee26240c

comment:12 Changed 6 years ago by Roman Tolchenov

Re #9579. Finished page for Integration.

Changeset: 83c633665e596947af06bb14790a479ab298ddfc

comment:13 Changed 6 years ago by Roman Tolchenov

Re #9579. Added Usage to SaveNexus

Changeset: 7f2986b3e4bb78b6afa9e9130e94243eda3f2378

comment:14 Changed 6 years ago by Roman Tolchenov

Re #9579. Added Usage section to SaveCSV.

Added a correction to the mantid docs sphinx extension to deal with nonprintable characters in algorithm properties.

Changeset: b806c1cf93524adeb39cf425d5a2109a1f3d37e5

comment:15 Changed 6 years ago by Roman Tolchenov

Re #9579. Replaced static file with generated one in GroupDetectors.

Changeset: d21cb8370c3055e22b8688a7478e1802705c8d3d

comment:16 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:17 Changed 6 years ago by Roman Tolchenov

Re #9579. Forgot to change an example.

Changeset: cab0a26df2284177d039dfecada3504d0b52160b

comment:18 Changed 6 years ago by Roman Tolchenov

Re #9579. Added Usage section for MaskWorkspaceToCalFile.

Changeset: 5e005428ac0f0745f12a4dc60f6b0a1e335b80ee

comment:19 Changed 6 years ago by Roman Tolchenov

Re #9579. Added Usage section to SaveIsawPeaks

Changeset: eee2ef43b234f4f9116b16c3de8f42908a10fe75

comment:20 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage section for MultiplyRange algorithm

Changeset: a3927964689206696e545a221a549a84e99f1d94

comment:21 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage section for ElasticWindow.

Changeset: 0486970e119404d97622372df6f4be7d50089184

comment:22 Changed 6 years ago by Roman Tolchenov

Re #9579. RealFFT description and usage example.

Changeset: b104572e1cf7013a345e3f27b9d07dbdcf978a32

comment:23 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for GetDetectorOffsets.

Changeset: e4cbdefc628ddd4151f5e06cde7c484f57218bc0

comment:24 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:25 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for GetDetOffsetsMultiPeaks

Changeset: 48e9d19d253059f2026aa3520eb61f076066e333

comment:26 Changed 6 years ago by Roman Tolchenov

Re #9579. Test cleanup for GetDetOffsetsMultiPeaks

Changeset: 7ac131132f140c475aec2ff414257a90ad78f641

comment:27 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for GroupWorkspaces.

Changeset: 4c4d385b3f5577561d6c819190d2550606a3d02e

comment:28 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for Rebunch.

Changeset: 2e71448fca28d4e522a54a9e96222a6edcbde18e

comment:29 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for CreateWorkspace.

Changeset: 65e97d322620a2f266d0322751bcf67ab3245640

comment:30 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for MaskDetectorsinShape.

Changeset: 69d7f0fa6f754f1883472addd34836c784dac997

comment:31 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for Exponential.

Changeset: 32626a75eb7475e1696f28907fc315eae80d34a6

comment:32 Changed 6 years ago by Roman Tolchenov

Re #9579. Ysage example for LoadMappingTable

Changeset: 80a301ace852bf9c13f7aed71cc29da80d289d0e

comment:33 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:34 Changed 6 years ago by Roman Tolchenov

comment:35 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage example for Regroup

Changeset: bd8bf21181c4681d1b161829a40659b23aa4637c

comment:36 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:37 Changed 6 years ago by Roman Tolchenov

Re #9579. MoveInstrumentComponent.

Changeset: 3d2131d2c3c4724efe805b1c07826ecfc3a2383d

comment:38 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:39 Changed 6 years ago by Roman Tolchenov

Re #9579. RotateInstrumentComponent.

Changeset: e4b9c757f3d2a9964ec8dc771269feef372b5379

comment:40 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:41 Changed 6 years ago by Roman Tolchenov

Re #9579. Usage examples for SmoothData

Changeset: df80fd4ee1350a9d4585e297570409217e525ae1

comment:42 Changed 6 years ago by Roman Tolchenov

Merge branch 'master' into feature/9579_check_documentation

Conflicts:

Code/Mantid/docs/sphinxext/mantiddoc/directives/properties.py

Re #9579

Changeset: 07a7074c45c9eaffabff24e02c7ecba848e8a82e

comment:43 Changed 6 years ago by Roman Tolchenov

Re #9579. CalculateTransmissionBeamSpreader.

Changeset: 5d41710d6ab138be8ec1e518a40629b8ade316af

comment:44 Changed 6 years ago by Roman Tolchenov

  • Description modified (diff)

comment:45 Changed 6 years ago by Roman Tolchenov

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

comment:46 Changed 6 years ago by Nick Draper

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

comment:47 Changed 6 years ago by Nick Draper

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Doctest failure on windows in SaveIsawPeaks.

It is the inf value in the file output, it comes through as 1.#INF on windows and inf on linux. Try using the elipsis option as in Pause

.. testoutput:: ExPauseString
   :options: +ELLIPSIS
   
   The algorithm paused for ... seconds.

comment:48 Changed 6 years ago by Roman Tolchenov

  • Status changed from reopened to inprogress

Re #9579. Removed failing line from the output.

Changeset: b09d83afeebae2179960e6840d6e9f1f024a7664

comment:49 Changed 6 years ago by Roman Tolchenov

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

comment:50 Changed 6 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester changed from Nick Draper to Samuel Jackson

comment:51 Changed 6 years ago by Samuel Jackson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9579_check_documentation'

Full changeset: 03912fb17be9e1d28d3fb43384def70f6ef5e5db

comment:52 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10422

Note: See TracTickets for help on using tickets.