Ticket #9909 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Add missing Algorithm Usage examples

Reported by: Nick Draper Owned by: Alex Buts
Priority: major Milestone: Release 3.3
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #7517 Tester: Harry Jeffery

Description (last modified by Nick Draper) (diff)

The following algorithms were found to be missing usage examples or have no rst file at all.

The outstanding documentation tickets were checked, but a match could not be found, so these appear to be missed.

  1. LoadSQW
  2. LoadMD
  3. LoadNXSPE
  4. ConvertToDiffractionMDWorkspace

Please add a usage example wherever possible

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Nick Draper to Alex Buts
  • Status changed from new to assigned
  • Description modified (diff)
  • Summary changed from Add missing Algorithm Usage examples (cloned) to Add missing Algorithm Usage examples

comment:2 Changed 6 years ago by Nick Draper

  • Blocking 7517 added

comment:3 Changed 6 years ago by Alex Buts

  • Status changed from assigned to inprogress

refs #9909 LoadSQW example

Changeset: ea20fd1c88b3caa77c863fbea19d17be692382b7

comment:4 Changed 6 years ago by Alex Buts

refs #9909 LoadMD usage example

Changeset: 9e3b11483c8e70852633dbfb764afaf01cb8363f

comment:5 Changed 6 years ago by Alex Buts

refs #9909 Correct Y-axis units in LoadNXSPE algorithm

Changeset: 9a0cc98abec6a19ba0ecfc6936f9432ef20bcbe0

comment:6 Changed 6 years ago by Alex Buts

refs #9909 LoadNXSPE and SaveNXSPE usage examples

Changeset: f2e84cf52079c77f0f95c5a100364a35daec067b

comment:7 Changed 6 years ago by Alex Buts

refs #9909 ConvertToDiffractionMDWorkspace -- changes in doc-s

and usage.

Changeset: b50c28308a605d948d682d4706b21b2008b0c3e8

comment:8 Changed 6 years ago by Alex Buts

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

I hope it is straightforward to test -- more usage examples and clearer description for the algorithms requested.

comment:9 Changed 6 years ago by Alex Buts

refs #9909 fixing SNS usage tests which fail as their ReferenceResults

do not contain correct Y-axis units.

Changeset: 2054b5a2c190d508642dd1edecbfad2cf60fe0b6

comment:10 Changed 6 years ago by Dan Nixon

  • Status changed from verify to verifying
  • Tester set to Dan Nixon

comment:11 Changed 6 years ago by Dan Nixon

  • Status changed from verifying to verify
  • Tester Dan Nixon deleted

comment:12 Changed 6 years ago by Alex Buts

  • Status changed from verify to reopened
  • Resolution fixed deleted

this change breaks number of system tests. The difference is trivial but needs to be worked at.

comment:13 Changed 6 years ago by Alex Buts

  • Status changed from reopened to inprogress

refs #9909 Another reference file got correct Y-axis units

Changeset: 67b624b585dd3fbf3e4c3ae5760b239ec8b8bc57

comment:14 Changed 6 years ago by Alex Buts

refs #9909 minor -- replaced all tabs with spaces.

Changeset: 7eaa5a91af3e2732ab566b53838ec347d8a8e9cc

comment:15 Changed 6 years ago by Alex Buts

refs #9909 Fixing sphinx warnings

Changeset: c10a6ff364d4bd334acf8f1f1d47443ca5bf79a6

comment:16 Changed 6 years ago by Alex Buts

refs #9909 minor corrections

Changeset: 2758967bf2c87eb970f796e2d8dad1262b880111

comment:17 Changed 6 years ago by Alex Buts

refs #9909 minor comments

Changeset: 6dd1e19ef2df0adfe8d6ad12cf2c1694da98df01

comment:18 follow-up: ↓ 19 Changed 6 years ago by Martyn Gigg

There are some Sphinx warnings in LoadMD-v1.rst & LoadSQW-v1.rst - http://builds.mantidproject.org/job/develop_clean/388/warnings3Result/new/

comment:19 in reply to: ↑ 18 Changed 6 years ago by Alex Buts

Replying to Martyn Gigg:

There are some Sphinx warnings in LoadMD-v1.rst & LoadSQW-v1.rst - http://builds.mantidproject.org/job/develop_clean/388/warnings3Result/new/

Which should have been fixed 3 days ago but looks like developer branch has been reset

comment:20 Changed 6 years ago by Alex Buts

  • Blocked By 10309 added

comment:21 Changed 6 years ago by Alex Buts

  • Blocked By 10309 removed

comment:22 Changed 6 years ago by Alex Buts

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

There appeared to be two tickets done here, as I've discovered writing LoadNXSPE usage doctests that LoadNXSPE does not recover axis units.

Fix for this is trivial but number of system tests verify current state of LoadNXSPE and these tests were fixed by adding proper axis unit to existing reference workspaces.

As the result, the work for this ticket includes modified descriptions, doctests and fix for LoadNXSPE unit. All changes should be trivial to verify but both mantid and system_tests repositories have to be merged to the appropriate masters.

comment:23 Changed 6 years ago by Alex Buts

refs #9989 Load detectors with the data works

though incorrectly for different number of monitors

Changeset: 9ab7bfb1df9963f243a324fcc990bd249c76dd19

Wrong ticket mentioned in commit

Last edited 6 years ago by Alex Buts (previous) (diff)

comment:24 Changed 6 years ago by Dan Nixon

  • Status changed from verify to verifying
  • Tester set to Dan Nixon

comment:25 Changed 6 years ago by Dan Nixon

  • Status changed from verifying to reopened
  • Resolution fixed deleted

One small issue in the example for LoadMD: the call to DeleteWorkspace should have the workspace in quotes, i.e. DeleteWorkspace('mdws')

comment:26 Changed 6 years ago by Alex Buts

  • Status changed from reopened to inprogress

refs #9909 fixed brackets in the LoadSQW sample

Changeset: 5ebf2385fb73de02179414c4f0f2546879339e3a

comment:27 Changed 6 years ago by Alex Buts

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

comment:28 Changed 6 years ago by Harry Jeffery

  • Status changed from verify to verifying
  • Tester changed from Dan Nixon to Harry Jeffery

comment:29 Changed 6 years ago by Harry Jeffery

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9909_AlgorithmUsageExamples'

Full changeset: 9895a3a5e5f60a6b47aac1da727403a34a63ac72

comment:30 Changed 6 years ago by Martyn Gigg

Merge branch 'feature/9909_AlgorithmUsageExamples'

Full changeset: 8756372bb989a2eda75208a0f7f000184214e84d

comment:31 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10751

Note: See TracTickets for help on using tickets.