Tutorial pipeline, error correction blurb, and a couple of tutorials

[thisac]

Context for changes

Set the infrastructure to have a gallery containing demos in FlamingPy

• Documentation changes:
  • Demo gallery/tutorials section on flamingpy docs

Example usage and tests

To add a tutorial, use the gallery-item directive from the xanadu-sphinx-theme. For the new document to be compiled its filename should start with run_. Thumbnails will be created out of the first figure generated and stored in tutorials/_out/images/thumb/ with the same name of the tutorial prepended with sphx_glr_.

Example

A new tutorial named run_intro_tutorial.py is created in flamingpy/doc/tutorials/run_intro_tutorial.py. To add the tutorial to the gallery use

.. gallery-item::
    :tooltip: This tutorial is directed at people who are new to FlamingPy.
    :figure: tutorials/_out/images/thumb/sphx_glr_run_intro_tutorial.png
    :description: :doc:`../tutorials/_out/run_intro_tutorial`

on the flamingpy/doc/usage/tutorials.rst file.

Every new tutorial should be a python executable script with ReST formatting.

Performance results justifying changes

• Not Applicable

Workflow actions and tests

This should be tested and built by the Create Documentation / sphinx (pull_request) action.

Expected benefits and drawbacks

Expected benefits:

• Extended documentation with tutorials and examples

Possible drawbacks:

• None

Related Github issues

• Not Applicable

Checklist and integration statements

• My Python and C++ codes follow the coding and commenting styles of this project as indicated by existing files. Specifically, the changes conform to given black, docformatter and pylint configurations.
• I have performed a self-review of these changes, checked my code (including for codefactor compliance), and corrected misspellings to the best of my capacity. I have synced this branch with others as required.
• I have added context for corresponding changes in documentation and README.md as needed.
• I have added new workflow CI tests for corresponding changes, ensuring codecoverage 95% or better, and these pass locally for me.
• I have updated CHANGELOG.md following the template. I recognize that the developers may revisit CHANGELOG.md and the versioning, and create a Special Release including my changes.

[codecov]

Codecov Report

Merging #24 (2fb6c5a) into main (875b0f1) will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #24      +/-   ##
==========================================
+ Coverage   96.27%   96.32%   +0.04%     
==========================================
  Files          35       35              
  Lines        2123     2123              
==========================================
+ Hits         2044     2045       +1     
+ Misses         79       78       -1     

Impacted Files	Coverage Δ
flamingpy/_version.py	100.00% <100.00%> (ø)
flamingpy/utils/viz.py	90.67% <0.00%> (+0.32%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 875b0f1...2fb6c5a. Read the comment docs.

[ilan-tz]

Nice work! A simple and effective pipeline for adding tutorials. Thank you also to @paviudes for the QEC blurb!