Ticket #11610 (closed: fixed)
Add documentation (RST) for algorithm SaveNXTomo
| Reported by: | Federico M Pouzols | Owned by: | Federico M Pouzols |
|---|---|---|---|
| Priority: | major | Milestone: | Release 3.4 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Michael Wedel |
Description (last modified by Federico M Pouzols) (diff)
This algorithm is going to change (several entries being written in the output files need to be revisited, and some others to be added). But for now there should be at least basic documentation about what it does.
While this algorithm saves NXTomo files the usual Mantid way (from workspaces), for practical (performance) reasons there's going to be a sibling algorithm to make NXTomo files directly from collection of image files (see related ticket #11041). So better to have all this explained sooner than later.
Change History
comment:2 Changed 5 years ago by Federico Montesino Pouzols
clarify property doc, and how it runs, re #11610
Changeset: 1db0f03cef4dc6305676c3994d7e43da6ee8fee2
comment:3 Changed 5 years ago by Federico Montesino Pouzols
add algorithm RST doc page, re #11610
Changeset: d20da2566b6e225a6bc300402fb842e91b3ef3ad
comment:4 Changed 5 years ago by Federico Montesino Pouzols
explain single workspace / workspace group, re #11610
Changeset: cac992335f938cbe668b632697c4e0519048d376
comment:5 Changed 5 years ago by Federico Montesino Pouzols
more clear now, and new alg category - tomography, re #11610
Changeset: cdf5f16a74e0dce9114f572f644e404256cbb24f
comment:6 Changed 5 years ago by Federico Montesino Pouzols
a bit more verbose prop description, re #11610
Changeset: 84e0b934918f7a2e8766a2c786580342ff9a43f6
comment:7 Changed 5 years ago by Federico Montesino Pouzols
- Status changed from inprogress to verify
- Resolution set to fixed
This is being verified as pull request #640.
comment:8 Changed 5 years ago by Michael Wedel
- Status changed from verify to verifying
- Tester set to Michael Wedel
comment:10 Changed 5 years ago by Federico Montesino Pouzols
fix typos in usage example, re #11610
Changeset: 12d321cc67e04a12d2c2ca3b6864040bb7b568f8
comment:11 Changed 5 years ago by Michael Wedel
- Status changed from verifying to closed
Merge pull request #640 from mantidproject/11610_add_doc_RST_algorithm_SaveNXTomo
Documentation is clear and understandable.
Full changeset: 5d8ef05d3c11a63ce5bc4dd34d0f151853f2b20f
comment:12 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 12448
