Ticket #9578 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Mathieu Doucet |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Nick Draper |
Description (last modified by Mathieu Doucet) (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
CalculateEfficiency.cppEQSANSResolution.cppFindCenterOfMassPosition.cppEQSANSDarkCurrentSubtraction.cppEQSANSLoad.cppEQSANSMonitorTOF.cppEQSANSTofStructure.cppEQSANSPatchSensitivity.cppEQSANSQ2D.cppHFIRDarkCurrentSubtraction.cppHFIRLoad.cppHFIRSANSNormalise.cppRefReduction.cpp(moved to #9636)RefRoi.cpp(moved to #9636)SANSBeamFinder.cppRefLReduction.py(moved to #9636)SANSSensitivityCorrection.cppSANSSolidAngleCorrection.cppSetupEQSANSReduction.cppSetupHFIRReduction.cppSetupILLD33Reduction.cppUSANSSimulation.pyHFIRSANSReduction.pySANSAzimuthalAverage1D.pySANSBeamSpreaderTransmission.pySANSDirectBeamTransmission.pySANSReduction.pyReactorSANSResolution.pyREFLReprocess.py(moved to #9636)SANSAbsoluteScale.pySANSMask.py
Change History
comment:1 Changed 6 years ago by Nick Draper
- Owner changed from Stuart Campbell to Mathieu Doucet
- Status changed from new to assigned
- 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 Mathieu Doucet
- Status changed from assigned to inprogress
Re #9578 docs for CalculateEfficiency
Changeset: bc90006fa84d80dd14db0ce830674fc960bf0ec3
comment:4 Changed 6 years ago by Peter Parker
- Description modified (diff)
Traded SANSBeamFluxCorrection.cpp for RefLReduction.py.
comment:5 Changed 6 years ago by Mathieu Doucet
Re #9578 docs for FindCenterOfMassPosition
Changeset: c84b2ea91ecc261761e2ff10f14b62e5b8965299
comment:7 Changed 6 years ago by Mathieu Doucet
Re #9578 EQSANSDarkCurrentSubtraction
Changeset: 21675dbca986d6237b4d7e7a6aa7ad4879707177
comment:9 Changed 6 years ago by Mathieu Doucet
Re #9578 EQSANSAzimuthalAverage
Changeset: 03e9702d9bed37d6a7a15e8700b328e30293bef5
comment:10 Changed 6 years ago by Mathieu Doucet
Re #9578 SANSAzimuthalAverage1D
Changeset: d7855786a9674a0bb4b32f214b337deaa928267c
comment:12 Changed 6 years ago by Mathieu Doucet
Re #9578 EQSANSResolution
Changeset: b76a8a9e30c5dc2fd330a168d3ae71782cbb1895
comment:14 Changed 6 years ago by Mathieu Doucet
Re #9578 SANSDirectBeamTransmission
Changeset: f155262d81ac66f638a21a03edb367aaeba17635
comment:16 Changed 6 years ago by Mathieu Doucet
Re #9578 SANSBeamSpreaderTransmission
Changeset: 511f57ba5f00e8395571a4305ed086a5acb71164
comment:18 Changed 6 years ago by Mathieu Doucet
Re #9578 add HFIRLoad
Changeset: 8d7e501ce8671e947fe8d51b5ee14f1e6f6cc835
comment:21 Changed 6 years ago by Mathieu Doucet
Re #9578 Add HFIRSANSNormalise
Changeset: 2a549285962c68eeee2d0c81ad77e626ed11ba42
comment:22 Changed 6 years ago by Mathieu Doucet
Re #9578 Add SANSBeamFinder
Changeset: 9842998b08d3f23fa5110adf9fd1d3423b5dc2a7
comment:24 Changed 6 years ago by Mathieu Doucet
Re #9578 Add ReactorSANSResolution
Changeset: 27a37367dc8ab044d8eb617c39d28c2d33623f88
comment:26 Changed 6 years ago by Mathieu Doucet
Re #9578 Add HFIRDarkCurrentSubtraction
Changeset: 2706167abc275f84daf41f5a15d80e9108e03cc5
comment:28 Changed 6 years ago by Mathieu Doucet
Re #9578 adding SANSSolidAngleCorrection
Changeset: 0bf50a71dc299c093e8c175d0b13e0f6aedacfc5
comment:30 Changed 6 years ago by Mathieu Doucet
Re #9578 adding SANSSensitivityCorrection
Changeset: 7c324ae15e0f28cb648f8743337850e9d61536f8
comment:32 Changed 6 years ago by Mathieu Doucet
Re #9578 add EQSANSPatchSensitivity
Changeset: 6417c34f3d70bb1c5f18e402bad3e3734f9e80fb
comment:34 Changed 6 years ago by Mathieu Doucet
Re #9578 add reduction setup algorithms
Changeset: 3cada441d611aed8b99a019f2e56938eb692aef9
comment:36 Changed 6 years ago by Mathieu Doucet
Re #9578 add reduction setup algorithms
Changeset: 5f9e03ea562ab781ea847f39aaa8efb7e1b34ae5
comment:38 Changed 6 years ago by Mathieu Doucet
Re #9578 Add EQSANSLoad
Changeset: 6e29c1d89124495119ead4938c81dfb835a159cc
comment:41 Changed 6 years ago by Mathieu Doucet
Re #9578 Add TOF correction algorithms
Changeset: ea8f3194fea19ce63b762542fb93e1e91a554bfe
comment:44 Changed 6 years ago by Mathieu Doucet
Re #9578 Add EQSANSQ2D
Changeset: ec44e347910d73787fc5289308f00e9770752cdd
comment:49 Changed 6 years ago by Mathieu Doucet
Re #9578 Add SANSMask
Changeset: 6c1fe8fbd835a78530b455201312c8f62ef2f0d7
comment:51 Changed 6 years ago by Mathieu Doucet
Re #9578 adding SANSAbsoluteScale
Changeset: 07093052e0cdc6c183f88a49b2667ddda36ec23b
comment:53 Changed 6 years ago by Mathieu Doucet
Re #9578 adding USANSSimulation
Changeset: 7fdd89117d2ed7914c347e898d36f2c8d6c3e6fe
comment:55 Changed 6 years ago by Mathieu Doucet
Re #9578 Add HFIRSANSReduction
Changeset: d43ef2d132fd7e97fa0246bd7942c556bd9c8ba8
comment:57 Changed 6 years ago by Mathieu Doucet
Re #9578 add SANSReduction
Changeset: 0dd84df1d581b7cb5366ab74e64c49fb9294477a
comment:59 Changed 6 years ago by Mathieu Doucet
- Status changed from inprogress to verify
- Resolution set to fixed
comment:60 Changed 6 years ago by Mathieu Doucet
Re #9578 Add flowchart
Changeset: 042d34bebe1bdaa7e189f68fd1bd9b45d5a68ed9
comment:61 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:62 Changed 6 years ago by Nick Draper
- Status changed from verifying to reopened
- Resolution fixed deleted
Failed:
A few things need to be cleaned up:
There are quite a few links between algorithms these point to the old website and need to be changed to link to the new sphinx pages. eg:
This algorithm extends the `TOFSANSResolution <http://www.mantidproject.org/TOFSANSResolution>`_ to implement the experimentally determined TOF resolution for EQSANS.
Needs to change to
This algorithm extends the :ref:`TOFSANSResolution <algm-TOFSANSResolution>` to implement the experimentally determined TOF resolution for EQSANS.
Also FindCenterOfMassPosition v1 could do with a version=1 arggument on the usage example.
I agree that inner workflow algs to not need usage examples as long as they state somewhere that they are normally used by another algorithm. However EQSANSLoad and EQSANSResolution looked like they might benefit from one.
Stopped testing at EQSANSQ2D
comment:63 Changed 6 years ago by Mathieu Doucet
Someone should update the wiki with a description of how to reference other algorithms. I don't remember seeing it described the way you did in your last comment.
comment:64 Changed 6 years ago by Mathieu Doucet
- Status changed from reopened to inprogress
Re #9578 update algorithm links
Changeset: e7984167b490dc430b1aa85287bebc979f21d89c
comment:65 Changed 6 years ago by Mathieu Doucet
- Status changed from inprogress to verify
- Resolution set to fixed
comment:67 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9578_chk_docs_sans'
Full changeset: 844dd04dff6e880f9489f8c8a0a53c6edb27f4c8
comment:68 Changed 6 years ago by Mathieu Doucet
Re #9578 Add workflow pics
Changeset: 940c9cc31b92981da0e08976a56e9130e4ea5fa4
comment:69 Changed 6 years ago by Mathieu Doucet
Revert "Re #9578 Add workflow pics"
This reverts commit 940c9cc31b92981da0e08976a56e9130e4ea5fa4.
Changeset: 344192dead78c8b0e76f8f58be52de87c57763fc
comment:70 Changed 6 years ago by Mathieu Doucet
Re #9578 Add workflow pics
Changeset: 940c9cc31b92981da0e08976a56e9130e4ea5fa4
comment:71 Changed 6 years ago by Mathieu Doucet
Revert "Re #9578 Add workflow pics"
This reverts commit 940c9cc31b92981da0e08976a56e9130e4ea5fa4.
Changeset: 344192dead78c8b0e76f8f58be52de87c57763fc
comment:72 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10421