Ticket #9583 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Vickie Lynch |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | #9714, #9715 | Tester: | Nick Draper |
Description (last modified by Jay Rainey) (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
- MultipleScatteringCylinderAbsorption.cpp
- SphericalAbsorption.cpp
- UnwrapSNS.cpp
- ConvertUnits.cpp
- AlignDetectors.cpp
- ConjoinWorkspaces.cpp
- CropWorkspace.cpp
- CrossCorrelate.cpp
- DiffractionEventCalibrateDetectors.cpp
- ConvertToDiffractionMDWorkspace.cpp
- ConvertToDiffractionMDWorkspace2.cpp
- SaveZODS.cpp
- BroadcastWorkspace.cpp
- GatherWorkspaces.cpp
- LoadIsawSpectrum.cpp
- NormaliseVanadium.cpp
- PeakIntensityVsRadius.cpp
- SelectCellOfType.cpp
- SelectCellWithForm.cpp
- ConvolveWorkspaces.cpp
- ShowPossibleCells.cpp
- TOFExtinction.cpp
- SortByQVectors.py
- LoadIsawDetCal.cpp
- SaveToSNSHistogramNexus.cpp
- FindUBUsingFFT.cpp
- FindUBUsingIndexedPeaks.cpp
- FindUBUsingLatticeParameters.cpp
- SortHKL.cpp
- IntegratePeakTimeSlices.cpp
- CentroidPeaks.cpp
Change History
comment:1 Changed 6 years ago by Nick Draper
- Status changed from new to assigned
- Owner changed from Jose Borreguero to Vickie Lynch
- Description modified (diff)
- 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 Jay Rainey
I added CentroidPeaks to the usage list as I am unable to write a usage example for it, and thought that the algorithms in this ticket related to it.
Not adding #9592 as a blocker as CentroidPeaks has an .rst file, which also has a description.
comment:4 Changed 6 years ago by Vickie Lynch
- Status changed from assigned to inprogress
Refs #9583 fix html documentation errors
Changeset: d8fe4ff8544e6948544a78a1ad0b0bacb30c1af6
comment:5 Changed 6 years ago by Vickie Lynch
TOFExtinction is not registered as an algorithm and will have documentation when my ticket 9522 is finished.
comment:6 Changed 6 years ago by Vickie Lynch
refs #9583 fix links in PeakIntensityVsRadius
Changeset: e09cf033213071cccdbda67c7f8e65f9ee4f96ce
comment:7 Changed 6 years ago by Vickie Lynch
Refs #9583 fix more links
Changeset: 4096c04b7f77ae7a495f48e71eaa8dd33902a04f
comment:8 Changed 6 years ago by Vickie Lynch
Refs #9583 fix html documentation errors
Changeset: e51ad815924c766ccb6a23965a034bf8ec79baeb
comment:9 Changed 6 years ago by Vickie Lynch
refs #9583 fix links in PeakIntensityVsRadius
Changeset: 38f9b33c3f006d5aa75bc2f47fcf07532a388dfa
comment:10 Changed 6 years ago by Vickie Lynch
Refs #9583 fix more links
Changeset: 0e5403b671387a100995af57413be5cf62a343a3
comment:11 Changed 6 years ago by Vickie Lynch
Refs #9583 add rst files for mpi algorithms
Changeset: a5fedd402b7a30e7776b1daffc064b49c93994f4
comment:12 Changed 6 years ago by Vickie Lynch
Refs #9583 tests for 3 algorithms
Changeset: f4d521cbf8918bf52fbb8eeece7862b0cd7d064f
comment:13 Changed 6 years ago by Vickie Lynch
Refs #9583 more tests
Changeset: be07f792eb9fea338f620cf2a524f00fa20b0e70
comment:14 Changed 6 years ago by Vickie Lynch
Refs #9583 more doc tests
Changeset: 4eef51ba8337f880d16507b59c5d05a2a94bb708
comment:15 Changed 6 years ago by Vickie Lynch
- Status changed from inprogress to verify
- Resolution set to fixed
All the documentation has been checked with changes made and links fixed to be ready for this release. I only work half time on Mantid, so I was not able to finish 31 doc tests. The tests not done are in ticket #9714 for the next release. There is no documentation for TOFExtinction since it is not declared as an algorithm and I am rewriting as my top priority in ticket #9522. The input parameters are not populated for the MPI algorithms, BroadcastWorkspace and GatherWorkspaces. This will be fixed when I am able to add my html files attached to ticket #9715.
comment:17 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:18 Changed 6 years ago by Nick Draper
re #9583 Adding a couple of hyperlinks
Changeset: 5d4217d24f19d0dd571dcf7fac545383e3b0d6fa
comment:19 Changed 6 years ago by Nick Draper
re #9583 Adding a couple of hyperlinks
Changeset: 9948a7cc8a5b8e17f95fcbef9ab823d8fe9470e8
comment:20 Changed 6 years ago by Nick Draper
re #9583 Adding a couple of hyperlinks
Changeset: 44c0c927a6c575c26e4b70a7bcf849942c3542e0
comment:21 Changed 6 years ago by Vickie Lynch
- Status changed from verifying to closed
Merge branch 'feature/9583_documentation_check' of github.com:mantidproject/mantid into feature/9583_documentation_check
Full changeset: 3ab724613ebeb9235404c13d09c2940db4d74ced
comment:22 Changed 6 years ago by Nick Draper
Merge remote-tracking branch 'origin/feature/9583_documentation_check'
Full changeset: b22d97b08ba17ee2fae22f0f6d8759e236491bf4
comment:23 Changed 6 years ago by Andrei Savici
comment:24 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10426