scipp / scipp/ess

Use Nexus files for dream workflow instead of geant4

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

Nobody has claimed this yet.

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

Description

Would be nice to use a Nexus file (like the ones @celinedurniak made for a stap demo a while ago) which is basically simulation data inserted in a Nexus file.
So that we can use the GenericNexus workflow instead of the geant4 workflow.

Note that we are using some nexus files in the tests, but it would be nice to do the same in the docs.

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

Compare the Nexus files already used in the tests with the documentation for the current geant4 workflow. Trace the GenericNexus and geant4 workflow entry points, then update the relevant docs so the example uses a Nexus file and GenericNexus workflow; confirm the documented workflow is consistent with the test examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.