Slight Documentation Update (#227)

Added the youtube video as well as mentioning the examples.

Author: PaulJonasJost

README.md

@@ -59,7 +59,10 @@ After loading a PEtab problem, PEtab-GUI will look something like this:
 
 ### Examples
 
-A set of real-world PEtab problems is available in the
+PEtab-GUI comes with two examples of its own, which can be immediately loaded from
+the `File` menu.
+
+A more extensive set of real-world PEtab problems is available in the
 [PEtab benchmark collection](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab).
 
 Download and unpack the [archive](https://github.com/Benchmarking-Initiative/Benchmark-Models-PEtab/archive/refs/heads/master.zip),

docs/source/conf.py

@@ -24,6 +24,7 @@
     "myst_parser",  # For Markdown support
     "sphinx_copybutton",  # To allow copying code snippets
     "sphinx_design",  # For better design elements
+    "sphinxcontrib.youtube",  # For embedding YouTube videos
 ]
 
 templates_path = ["_templates"]

docs/source/tutorial.rst

@@ -124,6 +124,11 @@ Quick Start: Your First PEtab Problem
 
 This section provides a complete, hands-on walkthrough to create your first PEtab parameter estimation problem from scratch.
 You will create a simple conversion model where species A converts to species B, import measurement data for both species in matrix format, and validate the complete problem.
+You can also watch a tutorial video covering similar steps and create your first PEtab problem alongside it.
+
+.. youtube:: n4EJFuZt9eU
+   :align: center
+
 
 **What we'll build**: A model describing first-order conversion of species A to species B, with experimental measurements for both species at different time points.
 

pyproject.toml

@@ -39,6 +39,7 @@ doc = [
     "myst-parser",
     "sphinx_copybutton",
     "sphinx-design",
+    "sphinxcontrib-youtube",
 ]
 
 [project.urls]