Documentation for analysis framework

Docs

• Tutorials:

  • Factor out the analysis in Tutorial 1
    • keep the manual steps
    • show how to encapsulate these steps in an analysis subclass
      • guidance/example on user-defined fitting model
    • (notebook scripting and debugging) show how to stop/continue the analysis at any step [see tests for an example]
      • show how to pass an optional argument to a step:
        1. Run till a certain step manually .run_until(...)
        2. Continue analysis from next step
      • show how to use logging and encourage its use in new analyses
    • encourage the use of xarray plotting
    • suggest using fast matplotlib rendering (and point to the matplotlib performance tutorial)
      • and/or not saving pngs (much slower to render vs svgs)
  • New tutorial: how to create a custom analysis flow
    • How to include user-defined methods as steps in the analysis

• User guide:

  • Mention the analysis framework and point to tutorial(s)
  • Update experiment container folder structure

• Description/overview of the analysis

  • to placed in base analysis module docstring (?)
  • list the built in functionalities
    • quantities of interest, best practices, limitations
    • raw vs processed dataset
    • fitting package
    • matplotlib-based plotting
      • figures and axes must be attached to the class object to be saved
  • disclaimer: no multi-dataset paradigm, yet, we are aware of the issue
  • disclaimer: already a powerful framework but we plan a future framework/redesign