Ticket #9576 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

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

Description (last modified by Owen Arnold) (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. SpecularReflectionCalculateTheta.cpp
  2. SpecularReflectionPositionCorrect.cpp
  3. AddSampleLog.cpp
  4. BinaryOperateMasks.cpp
  5. ConvertToMatrixWorkspace.cpp
  6. RebinByPulseTimes.cpp
  7. Stitch1DMD.cpp
  8. SliceMD.cpp
  9. PeaksInRegion.cpp
  10. PeaksOnSurface.cpp
  11. CalculatePeaksHKL.cpp
  12. IntegratePeaksUsingClusters.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Nick Draper to Owen Arnold
  • 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 Owen Arnold

  • Status changed from assigned to inprogress

refs #9576. Usage examples for specular reflection algorithms.

Changeset: 9e29c6f35b259593f396c278107b98f50eb94ffa

comment:3 Changed 6 years ago by Owen Arnold

refs #9576. Additional latex and cross-link.

Changeset: 6c11ddb84fc04bf87daca3e218188c757398c26b

comment:4 Changed 6 years ago by Owen Arnold

refs #9576. Cleanup existing and AddSampleLog.

Changeset: 0e16a061bdfb8bc3d56fab71145c2f016f1c1fe1

comment:5 Changed 6 years ago by Owen Arnold

refs #9576. Do IntegratePeaksUsingClusters.

Changeset: c7cd9f2396aebe2f084dc22c861e03e360e17c06

comment:6 Changed 6 years ago by Owen Arnold

refs #9576. Deprecate Stitch1DMD.

Changeset: eb094024118e63c079d1bb685c4615fb54eadb7f

comment:7 Changed 6 years ago by Owen Arnold

refs #9576. Tests for BinaryOperateMasks and PeaksInRegion.

Changeset: bff047e05121df33e60bde8af397dadf52c30dcd

comment:8 Changed 6 years ago by Owen Arnold

refs #9576. Tests for PeaksOnSurface.

Changeset: 5dc996a27ba8e2805581a1a0540547139fd15455

comment:9 Changed 6 years ago by Owen Arnold

refs #9576. Tests CalculatePeaksHKL.

Changeset: 955ca0cf67c1cf26a049dd43f6da0d4d39c07b2b

comment:10 Changed 6 years ago by Owen Arnold

  • Description modified (diff)

comment:11 Changed 6 years ago by Owen Arnold

refs #9576. ConvertToMatrixWorkspace tested

Minor modification to others to separate test output properly and remove cleanup sections

Changeset: ec0a7cfa5a5cea715b926e8157c94c7caa0084cc

comment:12 Changed 6 years ago by Owen Arnold

  • Description modified (diff)

comment:13 Changed 6 years ago by Owen Arnold

  • Description modified (diff)

comment:14 Changed 6 years ago by Owen Arnold

refs #9576. RebinByPulseTimes tested

Changeset: c9cb86e6045e1a1b77372b119ef8740ef4f7344f

comment:15 Changed 6 years ago by Owen Arnold

refs #9576. More testable examples

Changeset: 4026faf15dfdf058a10581ab9d75d0892fb35d2c

comment:16 Changed 6 years ago by Owen Arnold

refs #9576. Fix sphinx warning

Changeset: e8da5732f24938f9b4a21bdb85908191363b008b

comment:17 Changed 6 years ago by Owen Arnold

Tester:

1) Checkout the branch and run doc-html. View the pages for all the listed algorithms.

2) Either run doc-test, or trust that the RHEL6 build server has. In either case. Look at the build outputs to check that the named algorithms have had their tests run.

For minor issue, please open a new ticket rather than holding this one up.

comment:18 Changed 6 years ago by Owen Arnold

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

comment:19 Changed 6 years ago by Nick Draper

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

comment:20 Changed 6 years ago by Nick Draper

re #9576 added file usage tag

Changeset: 3b0f00d6af5a959633cb6bdd3abc6fa871550f13

comment:21 Changed 6 years ago by Nick Draper

re #9576 Move files to usagedata, added link to AddTimeSeriesLog

Changeset: 6d25fc454d36c56ceaf306eb6fcf9084e4406d22

comment:22 Changed 6 years ago by Nick Draper

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9576_documentation'

Full changeset: 9a693c0e8f2f4b4c397c473525f5e0c88d5e60fe

comment:23 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10419

Note: See TracTickets for help on using tickets.