Split user guide and cards on index pages #163
Conversation
| "metadata": {}, | ||
| "source": [ | ||
| "The Estia reduction workflow is created and we set parameters such as region of interest, wavelengthbins, and q-bins." | ||
| "We then need to set the missing parameters which are specific to each experiment (the keys are types defined in [ess.reflectometry.types](../../generated/modules/ess.reflectometry.types.rst))." |
There was a problem hiding this comment.
I think it is useful to mention that the parameters defines the region of interest etc.
There was a problem hiding this comment.
See the comments for the individual parameter groups.
| "wf = EstiaMcStasWorkflow()\n", | ||
| "wf.insert(load_mcstas_events)\n", | ||
| "# Specify input data files:\n", | ||
| "# (The choice of the 2nd 'Ni/Ti-multilayer' file is arbitrary.)\n", |
|
The thumbnails don't seem to exist in the preview: https://remote-unzip.deno.dev/scipp/essreflectometry/artifacts/3259230727/user-guide/estia/index.html but maybe it's not like that in the published version. |
tools/docs/estia-thumbnails.ipynb
Outdated
| "source": [ | ||
| "param_table = pd.DataFrame({\n", | ||
| " Filename[SampleRun]: estia_mcstas_example('Ni/Ti-multilayer')\n", | ||
| "}).rename_axis(index='run')\n", |
There was a problem hiding this comment.
What do you think about renaming this index to sample rotation angle or something like that? Essentially that is the dimension the series runs over.
There was a problem hiding this comment.
I renamed it to sample_rotation to match the coord name.
Apparently I forgot to commit them. |
This is basically the same as what I did with the DREAM user guide. I split the ESTIA guide into a basic notebook that only shows how to reduce some data and an advanced guide that expands on the basic one.
I only did this with the ESTIA docs as the others aren't the main focus of this package.
I removed the sections dealing with different samples because they were identical to the Ni/Ti sample except for different input files. This didn't teach the reader anything new.