Ticket #10052 (closed: fixed)
Check Code and add Usage Examples (selection from category 'Algorithm')
Reported by: | Karl Palmen | Owned by: | Karl Palmen |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.3 |
Component: | Documentation | Keywords: | |
Cc: | anders.markvardsen@… | Blocked By: | #9774, #10197, #10224, #10243 |
Blocking: | #9726, #10229 | Tester: | Roman Tolchenov |
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
Algorithms:
CopyLogs.cpp CreateTransmissionWorkspace.cpp FilterEvents.cpp FindPeaks.cpp GeneralisedSecondDifference.cpp GetTimeSeriesLogInformation.cpp MaskBins.cpp MaskBinsFromTable.cpp NormaliseByCurrent.cpp NormaliseToMonitor.cpp PerformIndexOperations.cpp ReadGroupsFromFile.cpp ReflectometryReductionOne.cpp
Change History
comment:2 Changed 6 years ago by Nick Draper
- Status changed from new to assigned
- Description modified (diff)
comment:3 Changed 6 years ago by Karl Palmen
- Blocked By 9774 added
CreateTransmissionWorkspace is covered by ticket #9774.
comment:5 Changed 6 years ago by Karl Palmen
First usage example for CopyLogs re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: e4f325e31f2751e6016b88b38e0e20c8c6960c37
comment:6 Changed 6 years ago by Karl Palmen
Add CopyLogs usage example for merge strategy KeepExisting re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 337dc6cd89236921370f28a3644cfd77b9679ebc
comment:8 Changed 6 years ago by Karl Palmen
CopyLogs usage example using WipeExisting re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 3c5d857233aba6c229fb6ecc41ba86ae6011c2db
comment:9 Changed 6 years ago by Karl Palmen
Usage example for MaskBins re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 6c9fc6d22fbb7fc444c3d084bf3bdb706f01a2e1
comment:10 Changed 6 years ago by Karl Palmen
Put Usage Example before Related Algorithms in MaskBins re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: e6caefd54cd6b68ac9dda0fb7a053689527597ba
comment:11 Changed 6 years ago by Karl Palmen
MaskBinsFromTable documentation improvements re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 21f5f73275bc8974e1cb6ea5c9e6ba50b57438d6
comment:12 Changed 6 years ago by Karl Palmen
Add usage example to MaskBinsFromTable re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 1908094de6bee311cf067268812850f5e314e621
comment:13 Changed 6 years ago by Karl Palmen
Algorithms requiring work are now:
FilterEvents.cpp FindPeaks.cpp GeneralisedSecondDifference.cpp GetTimeSeriesLogInformation.cpp NormaliseByCurrent.cpp NormaliseToMonitor.cpp PerformIndexOperations.cpp ReadGroupsFromFile.cpp ReflectometryReductionOne.cpp
comment:14 Changed 6 years ago by Karl Palmen
Add usage example for ReflectometryReductionOne re #10052
If more usage examples are required, these will be provided in a separate ticket.
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: e7000de1a69eb64c1374478c12babfdc56348741
comment:15 Changed 6 years ago by Karl Palmen
Usage example for FindPeaks re #10052
Note that this example would crash in a debug build. This is covered by ticket #10224.
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: c48715aa7f130401e08bae1a3a95780445d6e2fa
comment:16 Changed 6 years ago by Karl Palmen
Usage example for ReadGroupsFromFile re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 87bf7027ddc461a0f34d2965f30b9e90a5d45376
comment:17 Changed 6 years ago by Karl Palmen
Correct file name for ReadGroupsFromFile usage example re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 157a8d7aade49d6c1d46e77838f93263f659c252
comment:18 Changed 6 years ago by Karl Palmen
Algorithms requiring work are now:
FilterEvents.cpp GeneralisedSecondDifference.cpp GetTimeSeriesLogInformation.cpp NormaliseByCurrent.cpp NormaliseToMonitor.cpp PerformIndexOperations.cpp
comment:20 Changed 6 years ago by Karl Palmen
Usage example for PerformIndexOperations re #10052
I also added a description of the ProcessingInstructions, which would be of some help to the user, but could be improved. This improvement is covered by ticket #10229.
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: ca5f66dd06fdf842296f39316ba8bca10b3c8ad1
comment:21 Changed 6 years ago by Martyn Gigg
There is a Sphinx warning in PerformIndexOperations-v1.rst: http://builds.mantidproject.org/job/develop_clean/342/warnings3Result/
I think the problem is in the title line (line 32) of the usage example. Sphinx does not allow a space between a word and the emphasizing characters ** at the end of the title.
comment:22 Changed 6 years ago by Karl Palmen
Minor corrections in PerformIndexOperations-v1.rst re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: e28227de4b3261d06df3a48fdf43eb8dc3aae100
comment:23 Changed 6 years ago by Karl Palmen
Usage example for GetTimeSeriesLogInformation re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: f8ab0b2ba7c1f583491073f0e31b8c08a608bf9a
comment:24 Changed 6 years ago by Karl Palmen
Correction of example title re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 81185c1637eb15a36f0d22e36eae9eaaff71042c
comment:25 Changed 6 years ago by Karl Palmen
- Blocked By 10224 added
comment:26 Changed 6 years ago by Karl Palmen
Comment out print statement in FindPeaks usage example re #10052
This will be restored after #10224 has been fixed.
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 4f4d12d5b8b7cc5f0931b347c2bb9205b5507b5f
comment:27 Changed 6 years ago by Karl Palmen
Remaining algorithms are now
FilterEvents.cpp GeneralisedSecondDifference.cpp NormaliseByCurrent.cpp NormaliseToMonitor.cpp
Also FindPeaks will require, the print statement of its usage example restored after #10224 is fixed.
comment:29 Changed 6 years ago by Karl Palmen
FilterEvents will be dealt with by Wenduo Zuo in ticket #10243.
comment:30 Changed 6 years ago by Karl Palmen
Usage Example for NormaliseToMonitor re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: b8b92dc40f08493d43f82f5600f5eb544587dff1
comment:31 Changed 6 years ago by Karl Palmen
Usage Example for GeneralisedSecondDifference re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 1e32352ab34352508ba477d467798fcd29adeb09
comment:32 Changed 6 years ago by Karl Palmen
Usage Example for NormaliseByCurrent re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: b9788ce8f6bc9c5c8129b93a91ee74ef0b7f8d4d
comment:33 Changed 6 years ago by Karl Palmen
Correct log name in NormaliseByCurrent-v1.rst re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 051b3f776c02a6e7539494a531d9f749502f9d86
comment:34 Changed 6 years ago by Karl Palmen
comment:35 Changed 6 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
To test, check the documentation of the algorithms listed.
comment:36 Changed 6 years ago by Karl Palmen
- Status changed from verify to reopened
- Resolution fixed deleted
I need to undo the change in comment 26, to get the planned functionality in the FindPeaks usage example.
comment:37 Changed 6 years ago by Karl Palmen
- Status changed from reopened to inprogress
Restore print statement in FindPeaks usage example re #10052
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 796812a023dfe7c7e9d1aff5d59697ac36077922
comment:38 Changed 6 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
comment:39 Changed 6 years ago by Roman Tolchenov
- Status changed from verify to verifying
- Tester set to Roman Tolchenov
comment:40 Changed 6 years ago by Roman Tolchenov
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/10052_selected_algorithm_docs'
Full changeset: 8f99d162a0596afcbfd3997504c1f63ef34dbbb5
comment:41 Changed 6 years ago by Roman Tolchenov
Merge remote-tracking branch 'origin/feature/10052_selected_algorithm_docs'
Full changeset: 8f99d162a0596afcbfd3997504c1f63ef34dbbb5
comment:42 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10894