Ticket #9568 (closed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

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

Description (last modified by Nick Draper) (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. PlotAsymmetryByLogValue.cpp
  2. ConvertAxisByFormula.cpp
  3. MuonGroupDetectors.cpp
  4. RenameWorkspaces.cpp
  5. IQTransform.cpp
  6. AsymmetryCalc.cpp
  7. RemoveExpDecay.cpp
  8. ApplyDeadTimeCorr.cpp
  9. CalculateFlatBackground.cpp
  10. SmoothNeighbours.cpp
  11. IQTransform.cpp
  12. AlphaCalc.cpp
  13. MuonCalculateAsymmetry.cpp
  14. MuonLoad.cpp
  15. SaveDetectorsGrouping.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Karl Palmen to Arturs Bekasovs
  • Status changed from new to assigned
  • Description modified (diff)

comment:2 Changed 6 years ago by Nick Draper

  • Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation and add algorithm usage examples

comment:3 Changed 6 years ago by Arturs Bekasovs

  • Status changed from assigned to inprogress

Refs #9568. PlotAsymmetryByLogValue

Changeset: 93a51d8d146c189477f9a22c89c6a34cda7ce67c

comment:4 Changed 6 years ago by Arturs Bekasovs

Refs #9568. ConvertAxisByFormula

Changeset: eb6d55d93de990ca89028986c446a2858ac3c78e

comment:5 Changed 6 years ago by Arturs Bekasovs

Refs #9568. MuonGroupDetectors

Changeset: 26df43b1f441f4411b7053a18a6e6f2464b04988

comment:6 Changed 6 years ago by Arturs Bekasovs

Refs #9568. RenameWorkspaces

Changeset: ce517455cef8419a2ce076d5f16436c90cb58ffc

comment:7 Changed 6 years ago by Arturs Bekasovs

Refs #9568. Removed clean up sections

Workspaces should be cleaned up automatically now

Changeset: 92fc6158540fc6bc3b71bd691b29569f20b01188

comment:8 Changed 6 years ago by Arturs Bekasovs

Refs #9568. AsymmetryCalc

Changeset: 4d6af78278d9f4a323f554637dab86020af50b8a

comment:9 Changed 6 years ago by Arturs Bekasovs

Refs #9568. RemoveExpDecay

Changeset: 3327e2c761e10d2e3bb7af6623c87288d12f5767

comment:10 Changed 6 years ago by Arturs Bekasovs

Refs #9568. ApplyDeadTimeCorr

Changeset: 9c3a66c9565b0b914ded08bcddf121df97a23221

comment:11 Changed 6 years ago by Arturs Bekasovs

Refs #9568. CalculateFlatBackground

Changeset: 3e697d7c54a3ed2016e74fff94ffdcd409faa0fd

comment:12 Changed 6 years ago by Arturs Bekasovs

Refs #9568. AlphaCalc

Changeset: f1cac732df787d56e91763ace35b4fa66e730256

comment:13 Changed 6 years ago by Arturs Bekasovs

Refs #9568. SaveDetectorsGrouping

Changeset: 673aca1c8438ea5718aed5e75622ee2ac8f9a2cd

comment:14 Changed 6 years ago by Arturs Bekasovs

Refs #9568. Create workspaces instead of loading files

Changeset: 3ccb09ab205fef1c64ec684eb14d16555b79acf8

comment:15 Changed 6 years ago by Arturs Bekasovs

Refs #9568. SmoothNeighbours

Changeset: b5908411e9b616737d5d9ccc53f24163ca56b26f

comment:16 Changed 6 years ago by Arturs Bekasovs

Refs #9568. IQTransform

Changeset: cfc10eb0a0a8b6b754501fec14551522a4cc4458

comment:17 Changed 6 years ago by Arturs Bekasovs

Refs #9568. MuonCalculateAsymmetry

Plus a small fix for it in alg. property default value display

Changeset: 15bb56caf52bffeac503d4170aa0b82c4d3725b2

comment:18 Changed 6 years ago by Arturs Bekasovs

Refs #9568. MuonLoad

Changeset: 654c23747febed8232eb0ab260f3e42fffd2dbcd

comment:19 Changed 6 years ago by Arturs Bekasovs

Refs #9568. Various style/test improvements

Changeset: 15de630d4d45eb2af5a85581cda47e181e3f031a

comment:20 Changed 6 years ago by Arturs Bekasovs

Refs #9568. Attempt to fix errors

Python < 2.7 requires format fields to be numbered.

Changeset: 227859699fe08859478a9431809031da26873e1d

comment:21 Changed 6 years ago by Arturs Bekasovs

Tester:

You probably know what to do. :-)

For all the algorithms in the list, check that the documentation looks fine, the usage examples seem to be useful and run successfully on build servers.

Note that IQTransform has a duplicate in the list.

Last edited 6 years ago by Arturs Bekasovs (previous) (diff)

comment:22 Changed 6 years ago by Arturs Bekasovs

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

comment:23 Changed 6 years ago by Nick Draper

re #9568 fix to allow single bin workspaces in CreateSampleWorkspaces

Changeset: 79cf1dab8fc21e91c6cd1b9fee4898ddc65cfbf6

comment:24 Changed 6 years ago by Arturs Bekasovs

  • Status changed from verify to reopened
  • Resolution fixed deleted

comment:25 Changed 6 years ago by Arturs Bekasovs

  • Status changed from reopened to inprogress

Refs #9568. Uncomment accidentally commented clean-up code

Changeset: f5ad06f01ef8f9bf0419d318ca85899e02fa8fee

comment:26 Changed 6 years ago by Nick Draper

  • Status changed from inprogress to closed

Merge remote-tracking branch 'origin/feature/9568_docs_and_usage_examples'

Full changeset: ​942aefd8b0a30157a4b0c4de02d11566f8d577d2

comment:27 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10411

Note: See TracTickets for help on using tickets.