scipp / scipp/ess

Integration testing package

Open
#101 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

essreduce
Dominant language
Python
Stars
1
Forks
3
Avg merge
2d 11h
Merged PRs (30d)
17

Description

We and ECDC need to run integration testing between ESS NeXus files and the Scipp ESS packages. This will need to be run in multiple places such as the JSON template file repo as well as CODA. We therefore would like to implement test helpers in a centralized place.

I think the helpers will ultimately depend on the ess<technique> packages, so having this in essreduce may not be ideal. We should consider creating ess_integration_testing or something similar.

Incomplete list of what the helpers may need to to:

  • Run Chexus.
  • Load with ScippNexus, raise if there are unexpected warnings.
  • Load with GenericNeXusWorkflow. This will require knowledge of the expected or required monitor and detector names.
  • Load with instrument-specific loader.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing how integration testing is run in the JSON template file repository and CODA, then review the existing essreduce workflow entry point and the listed Chexus and ScippNexus loaders. Define the centralized package boundary and the expected monitor and detector inputs. Done means reusable helpers cover the listed loading and warning checks across those locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.