Add workflow helper #68
Conversation
src/ess/dream/__init__.py
Outdated
| def default_parameters() -> dict: | ||
| # QUantities not available in the simulated data | ||
| sample = sc.DataGroup(position=sc.vector([0.0, 0.0, 0.0], unit="mm")) | ||
| source = sc.DataGroup(position=sc.vector([-3.478, 0.0, -76550], unit="mm")) | ||
| charge = sc.scalar(1.0, unit="µAh") | ||
| return { | ||
| RawSample[SampleRun]: sample, | ||
| RawSample[VanadiumRun]: sample, | ||
| RawSource[SampleRun]: source, | ||
| RawSource[VanadiumRun]: source, | ||
| AccumulatedProtonCharge[SampleRun]: charge, | ||
| AccumulatedProtonCharge[VanadiumRun]: charge, | ||
| } | ||
|
|
||
|
|
||
| def DreamGeant4Workflow() -> sciline.Pipeline: | ||
| """ | ||
| Workflow with default parameters for the Powgen SNS instrument. | ||
| """ | ||
| return sciline.Pipeline( | ||
| providers=powder_providers + geant4_providers, params=default_parameters() | ||
| ) |
There was a problem hiding this comment.
- Does this belong into the
__init__.py? - Docstring refers to Powgen.
There was a problem hiding this comment.
- Does this belong into the
__init__.py?
hmm in essans, we have a separate workflow file for loki, in essreflectometry, for Amor, we have the workflow in the __init__.py. We should be consistent and just have a separate workflow file?
- Docstring refers to Powgen.
Bad copy/paste ;-)
There was a problem hiding this comment.
I don't think consistency is the main argument, I thought the __init__.py should generally be kept minimal?
There was a problem hiding this comment.
Shouldn't the workflows be listed in the api-reference?
| "# Mask in time-of-flight to crop to valid range\n", | ||
| "workflow[TofMask] = lambda x: (x < sc.scalar(0.0, unit=\"ns\")) | (x > sc.scalar(86e6, unit=\"ns\"))\n", | ||
| "workflow[TwoThetaMask] = None\n", | ||
| "workflow[WavelengthMask] = None\n", |
There was a problem hiding this comment.
They could, but I thought this would make it obvious what the syntax is if you want to add other masks. I guess this goes back to the discussion on whether these notebooks should only show what is needed, and we need another page that describes everything that can be done in the workflow.
Adds
PowgenWorkflow()andDreamGeant4Workflow()helpers.I also moved the
ess/powder/externalfolder toess/snspowderto be more likeess/isissansinesssans.