Ticket #9615 (closed: fixed)
Add algorithm usage examples
| Reported by: | Nick Draper | Owned by: | Michael Reuter |
|---|---|---|---|
| Priority: | critical | Milestone: | Release 3.2 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Nick Draper |
Description (last modified by Michael Reuter) (diff)
Cloned from #9614:
Cloned from #9580:
A dd testable algorithm usage examples.
There is help on how to document the algorithms in the following links: 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
- FakeMDEventData.cpp
- IndexSXPeaks.cpp
- GenerateEventsFilter.cpp
- GetEi.cpp
- Transpose.cpp
- SpatialGrouping.cpp
- FindDetectorsPar.cpp
- LoadCalFile.cpp
- LoadDspacemap.cpp
- LoadNexusLogs.cpp
- SaveDaveGrp.cpp
Change History
comment:3 Changed 6 years ago by Michael Reuter
- Milestone changed from Release 3.2 to Release 3.3
- Description modified (diff)
- Summary changed from Check Documentation and add algorithm usage examples (cloned) (cloned) to Add algorithm usage examples
comment:6 Changed 6 years ago by Michael Reuter
- Status changed from new to assigned
- Milestone changed from Release 3.3 to Release 3.2
comment:10 Changed 6 years ago by Michael Reuter
Refs #9615. Doing LoadCalFile.
Changeset: 08b43f83a5d2fe05395a5c0b962dae15722b4ad5
comment:11 Changed 6 years ago by Michael Reuter
Refs #9615. Adding GetEi and LoadDspacemap.
Changeset: d51cd2636afccd8c2c5b12eadbd86f2d924c1d3e
comment:12 Changed 6 years ago by Michael Reuter
Refs #9615. Adding Transpose.
Changeset: c7eec30387ea68712fc64b4ae1abb7b51fac7a50
comment:13 Changed 6 years ago by Michael Reuter
Refs #9615. Adding LoadNexusLogs.
Changeset: 7c6fa8b63d0ff437bd31d7676c81ebf297ee7d94
comment:14 Changed 6 years ago by Michael Reuter
Refs #9615. Adding SpatialGrouping.
Changeset: 2aaf7daf05f6523dbfbb672e30a009d499c02797
comment:15 Changed 6 years ago by Michael Reuter
Refs #9615. Adding SaveDaveGrp.
Changeset: 455bb39a1c2c9c77a555373d70b2effb24763f75
comment:16 Changed 6 years ago by Michael Reuter
Refs #9615. Adding three more algorithms.
- FindDetectorsPar, GenerateEventsFilter and IndexSXPeaks.
Changeset: 860c8e202edfdd4a3778f361e92371cbc8c9f487
comment:17 Changed 6 years ago by Michael Reuter
Refs #9615. Adding FakeMDEventData.
Changeset: 0b125346a32678134f78557b2f3f223698ed8b94
comment:18 Changed 6 years ago by Michael Reuter
- Status changed from inprogress to verify
- Resolution set to fixed
The branch can be found here.
To test: Check out all the usage example text on the pages and make sure the docs-test target runs.
comment:19 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:20 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9615_usage_examples'
Full changeset: bc223b46e37a37106b6861120878e33144aba656
comment:21 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10458
Is this clone of a clone here for a reason?