Ticket #9585 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Jay Rainey |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | 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
CatalogDownloadDataFiles.cppCatalogGetDataFiles.cppCatalogGetDataSets.cppCatalogKeepAlive.cppCatalogListInstruments.cppCatalogListInvestigationTypes.cppCatalogLogin.cppCatalogLogout.cppCatalogMyDataSearch.cppCatalogPublish.cppCatalogSearch.cppAddPeak.cppUnwrapMonitor.cppExponentialCorrection.cppConvertFromDistribution.cppConvertToDistribution.cpp
Change History
comment:1 Changed 6 years ago by Nick Draper
- Status changed from new to assigned
- Owner changed from Samuel Jackson to Jay Rainey
- 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 Jay Rainey
- Status changed from assigned to inprogress
Limit to prevent ALL investigations returned in Python. Refs #9585.
Changeset: c88d51a3f935c0308fbd0a0469dd9edfa9feec86
comment:3 Changed 6 years ago by Jay Rainey
Updated CatalogSearch property descriptions. Refs #9585.
Changeset: b95892970d985adea2e7f952f8814cb39aaf94a5
comment:4 Changed 6 years ago by Jay Rainey
Improve catalog property descriptions. Refs #9585.
Changeset: 9d5670d05511a3a1c98d643d29acfbae0ed4dd95
comment:5 Changed 6 years ago by Jay Rainey
Added CatalogKeepAlive & CatalogLogin usage. Refs #9585.
Changeset: e7bcbd0d0157fe1ab7384d1b1d6005bc674f5200
comment:6 Changed 6 years ago by Jay Rainey
Added usage to CatalogLogout. Refs #9585.
Changeset: 191b01dede4e1c97d65940acb9d80c6fb94c2e73
comment:7 Changed 6 years ago by Jay Rainey
Added usage to CatalogListInstruments & Investigations. Refs #9585.
- Updated the summary for these algorithms to state difference between single and multiple catalogs.
Changeset: 696ae43ba181821a5b7621a5a0311fa7cc931d18
comment:8 Changed 6 years ago by Jay Rainey
Added usage to CatalogMyDataSearch. Refs #9585.
Changeset: fe516c95cd495852e9082253bb272a1b779528c4
comment:9 Changed 6 years ago by Jay Rainey
Added usage to CatalogSearch. Refs #9585.
Changeset: ed9085c88f6c54cbbf4402154a321eb9f268857c
comment:10 Changed 6 years ago by Jay Rainey
Add usage to CatalogDownloadFiles. Refs #9585.
Changeset: cbacc7558b92056a402bb3a1bfe1eb06b13dabc3
comment:11 Changed 6 years ago by Jay Rainey
Add usage to CatalogPublish. Refs #9585.
Changeset: 8227ea99f15b18b6f92ecc56495962e034022b2d
comment:12 Changed 6 years ago by Jay Rainey
Add usage to CatalogGetDataFiles. Refs #9585.
Changeset: 1d5a1b25f14ae0f6ac6127a7b5d78d3facefe21f
comment:13 Changed 6 years ago by Jay Rainey
Add usage to CatalogGetDataSets. Refs #9585.
Changeset: e6768d64ce24f4bf4b6a5d392cab148adb51d379
comment:14 Changed 6 years ago by Jay Rainey
Add detailed description to CatalogDownloadDatafiles. Refs #9585.
Changeset: 6aa50a72a4ad3db303db6fd0df898050528a173f
comment:15 Changed 6 years ago by Jay Rainey
Add usage to ConvertToDistribution. Refs #9585.
Changeset: a91c737c2ea8f8e7e965f5e2a5ba0fef988bd8ae
comment:16 Changed 6 years ago by Jay Rainey
Add usage to ConvertFromDistribution. Refs #9585.
Changeset: 4ab3117fc8ddebac442bb03b07ec5a0a9d2f3086
comment:17 Changed 6 years ago by Jay Rainey
Add usage to UnwrapMonitor. Refs #9585.
Changeset: dfde7271b1264508726ef510fbe3de44ca1c3bcb
comment:18 Changed 6 years ago by Jay Rainey
Correct testoutput for some algorithms. Refs #9585.
Changeset: 86e6dc6f447eaeed0fc7f31ca98601ed366adff2
comment:19 Changed 6 years ago by Jay Rainey
Add ExponentialCorrection usage example. Refs #9585.
Changeset: 4a07f58461efaaa435778db19b800054d0f702ae
comment:20 Changed 6 years ago by Jay Rainey
- Description modified (diff)
Traded Qxy to AddPeak with Peter as Qxy was also in his list.
comment:21 Changed 6 years ago by Jay Rainey
- Description modified (diff)
Removed CalculateTransmission from list as Peter Parker has opted to do that (since it relates to the SANS workflow that he will be working on soon)
comment:22 Changed 6 years ago by Jay Rainey
Add AddPeak usage example. Refs #9585.
Changeset: 3e8b85baa0e792bd58291f8a96166a564e510f90
comment:23 Changed 6 years ago by Jay Rainey
Those left to do are:
- PredictPeaks
- IntegratePeakTimeSlices
comment:24 Changed 6 years ago by Jay Rainey
Traded PredictPeaks -> SetSpecialCoordinates with Owen. #9576.
comment:28 Changed 6 years ago by Jay Rainey
- Description modified (diff)
I do not have the required knowledge to complete IntegratePeakTimeSlices.cpp. Will pass it over to Vicky or another SNS developer.
comment:29 Changed 6 years ago by Jay Rainey
- Status changed from inprogress to verify
- Resolution set to fixed
- Description modified (diff)
Removing SetSpecialCoordinates.cpp from usage list in the description to open this for testing before I leave.
comment:30 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
Reopened because of:
Missing properties table for
- CatalogDownloadDataFiles-v1.html
- CatalogListInstruments
- CatalogListInvestigationTypes
- CatalogLogout-v1
- CatalogPublish (also dialog everything appears disabled)
No page found for OptimizeExtinctionParameters
comment:31 Changed 6 years ago by Nick Draper
- Status changed from verifying to reopened
- Resolution fixed deleted
comment:33 Changed 6 years ago by Jay Rainey
- Status changed from reopened to inprogress
Add note regarding disabled publish dialog. Refs #9585.
- This is to make it clear to the user why the catalog publish dialog is disabled.
Changeset: c756c0c6acbc9d399b20e862ccce9897f4eb343c
comment:34 Changed 6 years ago by Jay Rainey
Fix bug in properties directive. Refs #9585.
- If a property had all empty field for a specific argument then the table would not be built.
Changeset: 1bb435627108b555ace9e3434cdac7f1cc4b33c7
comment:35 Changed 6 years ago by Jay Rainey
- Status changed from inprogress to verify
- Resolution set to fixed
comment:37 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9585_algorithm_documentation_improvements'
Full changeset: 08a73d8c0cf41f5f0f993ef99f738513a71d7b8c
comment:38 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10428