Consider creating a fake for `GenericNeXusWorkflow`
Open
Nobody has claimed this yet.
essreduce
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 17
Description
Usage in a unit test:
def test_loki():
wf = LokiWorkflow(nexus_workflow=FakeGenericNeXusWorkflow())
wf.compute(IofQ[SampleRun])
This would allow for bypassing file I/O as well as dealing with large data (or having to create small files). The challenge is that unless instrument parameters are reasonable the workflow may fail or return data that is not verifiable, e.g., if all data is in unphysical regions.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the test_loki example and inspect GenericNeXusWorkflow, LokiWorkflow, and FakeGenericNeXusWorkflow usage. Define reasonable instrument parameters so LokiWorkflow.compute can bypass file I/O and produce verifiable data; done means the unit-test scenario works without large or generated input files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100