Ticket #11191 (closed: fixed)
Update PhaseQuad user example
Reported by: | Raquel Alvarez Banos | Owned by: | Raquel Alvarez Banos |
---|---|---|---|
Priority: | minor | Milestone: | Release 3.4 |
Component: | Muon | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Martyn Gigg |
Description
Write a more useful doc test for PhaseQuad algorithm. Currently, in the user example, only two spectra are loaded from a muon dataset, and some counts in the input workpsace are checked. Something related to the output workpsace should be tested instead, and, given that the algorithm will typically be used with a complete dataset, all spectra should be loaded. Also, add a second user example to illustrate how to use the algorithm when a phase table is given as input.
Change History
comment:2 Changed 6 years ago by Raquel Alvarez
- Status changed from new to verify
- Resolution set to fixed
This is being verified as pull request #324.
comment:3 Changed 6 years ago by Martyn Gigg
- Status changed from verify to verifying
- Tester set to Martyn Gigg
comment:4 Changed 6 years ago by Martyn Gigg
Could we also remove the temporary PhaseList file after we are finished? This just avoids having random files scattered around the build directories. This can be done outside of the test by adding the following lines underneath the .. testoutput:: ExPhaseQuadList section:
`python .. testcleanup:: ExPhaseQuadList
import os try:
os.remove(phaselist_path)
except OSError:
pass
`
See CreateDummyCalFile-v1.rst for an example.
comment:6 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 Remove phase list used in doc
Changeset: b5bb805155f64dd94492dda36ef96fc8846fa78b
comment:7 Changed 6 years ago by Raquel Alvarez
I have just seen I missed the first comment, I will modify that too.
comment:8 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 write file to home dir and change file name
Changeset: f2be2a93862fd5af7d796df0ecdbb8f0687226c3
comment:10 Changed 6 years ago by Martyn Gigg
It looks like this doesn't merge cleanly with master any more. Could you merge master to your branch?
comment:11 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 Fixing conflict
Changeset: 095c4c835ea628e5888308e773c3cb162574812a
comment:12 Changed 6 years ago by Martyn Gigg
Jenkins, retest this please
comment:13 Changed 6 years ago by Raquel Alvarez
Jenkins, retest this please
comment:14 Changed 6 years ago by Martyn Gigg
One of the builds has failed with a git error. I don't think it is worth pushing this through the build servers again. I'll just wait until the build finish and merge it then.
comment:15 Changed 6 years ago by Martyn Gigg
The rhel6 failure is nothing to do with the changes here. The documentation tests have passed and rhel6 built before.
comment:16 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 Update doc and user examples
Changeset: b9f701e1a2cfd3b8e179ebda7efbbda2665af0e0
comment:17 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 Remove phase list used in doc
Changeset: b5bb805155f64dd94492dda36ef96fc8846fa78b
comment:18 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 write file to home dir and change file name
Changeset: f2be2a93862fd5af7d796df0ecdbb8f0687226c3
comment:19 Changed 6 years ago by Raquel Alvarez Banos
Re #11191 Fixing conflict
Changeset: 095c4c835ea628e5888308e773c3cb162574812a
comment:20 Changed 6 years ago by Martyn Gigg
- Status changed from verifying to closed
Merge pull request #324 from mantidproject/11191_update_PhaseQuad_doc
Update Muon PhaseQuad documentation and user examples
Full changeset: a759afa7fca90df956aba2091c90a5676688dedb
comment:21 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 12030
Re #11191 Update doc and user examples
Changeset: b9f701e1a2cfd3b8e179ebda7efbbda2665af0e0