Ticket #9589 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by: Nick Draper Owned by: Michael Wedel
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #9630 Tester: Nick Draper

Description (last modified by Michael Wedel) (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, DiffractionFocussing 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

Documented, with usage examples:

  1. PoldiAutoCorrelation5.cpp
  2. PoldiFitPeaks1D.cpp
  3. PoldiMerge.py
  4. PoldiPeakSearch.cpp
  5. LoadSINQ.py
  6. LoadSINQFile.py

Documentation cleaned up, warning about possible change or deprecation added:

  1. PoldiLoadChopperSlits.cpp
  2. PoldiLoadIPP.cpp
  3. PoldiLoadSpectra.cpp
  4. PoldiPeakDetection2.cpp
  5. PoldiRemoveDeadWires.cpp
  6. PoldiProjectAddFile.py
  7. PoldiProjectRun.py
  8. PoldiProjectAddDir.py
  9. PoldiLoadLog.cpp

Moved to #9622:

  1. SINQTranspose3D.cpp
  2. SliceMDHisto.cpp
  3. ViewBOA
  4. ProjectMD

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner changed from Ricardo Leal to Michael Wedel
  • 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 Michael Wedel

  • Status changed from assigned to inprogress

Refs #9589. Cleaned up documentation for PoldiAutoCorrelation.

Added usage examples, checked summary and properties, expanded description and added example spectra.

Changeset: f774ec38ad9c6277763ba0aea55eb527cffaf670

comment:3 Changed 6 years ago by Michael Wedel

Refs #9589. Removed cleanup section from PoldiAutoCorrelation docs.

It became unnecessary after merging the changes from master.

Changeset: 3527a22718d7cbb386646119ac726f3bd9ef6045

comment:4 Changed 6 years ago by Michael Wedel

Refs #9589. Added usage example for PoldiMerge.

It required another data file to make sense.

Changeset: 6ed21a937e50a791badfed5d742173cdeb22ebda

comment:5 Changed 6 years ago by Michael Wedel

Refs #9589. Cleaned up documentation of PoldiPeakSearch.

Changeset: 26c8ec15afce56ce4e57800a069504ceb28cf5bc

comment:6 Changed 6 years ago by Michael Wedel

Refs #9589. Updated docs for legacy POLDI algorithms.

This documentation will not be changed until final decisions about their further treatment have been made.

Changeset: 42ddae4f25f6adb250ae516df386067d323ce89a

comment:7 Changed 6 years ago by Michael Wedel

Refs #9589. Added usage example for PoldiFitPeaks1D.

Changeset: 5449ee7722bead1bd6da0fd865be809e029bf057

comment:8 Changed 6 years ago by Michael Wedel

Refs #9589. Changed category of PoldiFitPeaks1D.

Changeset: 38904cb24c5d68ba7ce33d9bcf39548c2c20b96f

comment:9 Changed 6 years ago by Nick Draper

  • Description modified (diff)

Added a couple that make more sense to be on your list

  1. PoldiAutoCorrelation5.cpp
  2. PoldiLoadLog.cpp

comment:10 Changed 6 years ago by Michael Wedel

Refs #9589. Usage examples for LoadSINQ and LoadSINQFile.

Changeset: c3c422408a3bd3f122a8983b2d1e79153deeecd9

comment:11 Changed 6 years ago by Michael Wedel

For three algorithms there is some additional feedback needed, so they have been put into a new ticket (#9622).

comment:12 Changed 6 years ago by Michael Wedel

Refs #9589. Removed one more redundancy from legacy POLDI algorithms.

Changeset: d25fbdead77c69376dd3599db589690a095677f3

comment:13 Changed 6 years ago by Michael Wedel

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

Algorithms that are definitely in use (PoldiAutoCorrelation, PoldiMerge, PoldiPeakSearch, PoldiFitPeaks1D, LoadSINQ, LoadSINQFile) have been documented properly and equipped with usage examples.

Legacy algorithms for POLDI data processing (PoldiLoadChopperSlits, PoldiLoadIPP, PoldiLoadSpectra, PoldiPeakDetection2, PoldiRemoveDeadWires, PoldiProjectAddFile, PoldiProjectRun, PoldiProjectAddDir, PoldiLoadLog) have a warning attached to them, but the documentation has not been altered beyond basic cleanup and formatting.

Algorithms that need further information have been moved to #9622.

comment:14 Changed 6 years ago by Jay Rainey

  • Status changed from verify to reopened
  • Resolution fixed deleted
  • Description modified (diff)
  • Blocked By 9592 added

I added 9592 as blocker as I added SliceMDHisto.rst in that ticket. As I have no experience with SINQ, and you have written the usage for the other SINQ algorithms in this ticket I re-opened so that you could write the user for SliceMDHisto. Sorry =]

Last edited 6 years ago by Jay Rainey (previous) (diff)

comment:15 Changed 6 years ago by Michael Wedel

  • Description modified (diff)
  • Blocked By 9592 removed

Thanks for the notification. Okay, then I will put it into #9622 along with the three other algorithms that I need more info on and remove the block from this ticket.

If other SINQ-related algorithms appear, without the word "POLDI" in it, please put them into that ticket, as I will likely need more information on that as well before I can document anything. Thanks.

I updated the list in the ticket to reflect the changes.

comment:16 Changed 6 years ago by Michael Wedel

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

comment:17 Changed 6 years ago by Michael Wedel

  • Status changed from verify to reopened
  • Resolution fixed deleted

From the mailing list:

LoadSINQ-v1.rst
-    the call itself is failing
poldi_data = LoadSINQ(Instrument = "POLDI", Year = 2013, Numor = 6904)

    RuntimeError: WorkspaceProperty doesn't point to a workspace

This is due to a path problem which did not appear locally, because the special SINQ data directories were available.

Reopening for fix.

comment:18 Changed 6 years ago by Michael Wedel

  • Status changed from reopened to inprogress

Refs #9589. Fixed LoadSINQ path problem.

When the standard SINQ-paths are not available, LoadSINQ returned without setting the output workspace properly. This commit fixes that behavior and makes the doc-test pass as well.

Changeset: de09c8833ed0348a8ba89425e01d71e7e727cc48

comment:19 Changed 6 years ago by Michael Wedel

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

comment:20 Changed 6 years ago by Michael Wedel

  • Status changed from verify to reopened
  • Resolution fixed deleted

1 Sphinx-warning and 1 Sphinx-error in PoldiProjectRun, reopening for a fix.

comment:21 Changed 6 years ago by Michael Wedel

  • Status changed from reopened to inprogress

Refs #9589. Fixing sphinx warnings in PoldiProjectRun-docs.

Changeset: 48df6e8872cb05df5d6988dd65a671330bcccd6b

comment:22 Changed 6 years ago by Michael Wedel

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

comment:23 Changed 6 years ago by Michael Wedel

  • Blocking 9630 added

comment:24 Changed 6 years ago by Michael Wedel

Refs #9589. Moved data files to UsageData directory.

Changeset: 0af95aba95ce334bdf4d9a6a1f302b4399f904b8

comment:25 Changed 6 years ago by Nick Draper

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

comment:26 Changed 6 years ago by Nick Draper

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9589_check_documentation_sinq_poldi'

Full changeset: 7c878a584f72876add1c09a22fcc60b8fa86f521

comment:27 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10432

Note: See TracTickets for help on using tickets.