Skip to content

New user guide (experiment flow)

Explanation of changes

Closes #96 (closed) , documents #66 (closed)

Documentation on how the different concepts tie together. WIP. I've rewritten the user guide (see RTD preview) and streamlined the overall experience. It is less about the data structures and more about the concepts.

image

This MR is still WIP, but I would very much like some feedback on this already.

  • Introduction
  • Creating a schedule (example could be better, but out of scope of this MR)
  • Compilation
  • Execution -> Instruments
  • Execution -> experiment flow (figure ready, text to be written).

I will also delete most of the old user guide (still present in this MR).

@kel85uk, @dcrielaard, @caenrigen, @adamorangeqs, @jvoven please let me know what you think.

Motivation of changes

Overdue design work that is blocking a lot of progress for the current release.


Merge checklist

See also merge request guidelines

  • Merge request has been reviewed and approved by a project maintainer.
  • Merge request contains a clear description of the proposed changes and the issue it addresses.
  • Merge request made onto appropriate branch (develop for most MRs).
  • New code is fully tested.
  • New code is documented and docstrings use numpydoc format.
  • Changelog has been updated (when applicable).
  • CI pipelines pass
    • black code-formatting passes (gitlab-ci),
    • test suite passes (gitlab-ci),
    • no degradation in code-coverage (codacy),
    • no (serious) new pylint code quality issues introduced (codacy),
    • documentation builds successfully (CI and readthedocs),
    • windows tests pass (manually triggered by maintainers before merging).

For reference, the issues workflow is described in the contribution guidelines.

Edited by Adriaan

Merge request reports

Loading