From 86315c3f171a096ac71ed9b86cfc86183ba7917b Mon Sep 17 00:00:00 2001 From: PaulJonasJost Date: Tue, 27 Jan 2026 15:54:02 +0100 Subject: [PATCH] Added youtube video to tutorial. --- README.md | 5 ++++- docs/source/conf.py | 1 + docs/source/tutorial.rst | 5 +++++ pyproject.toml | 1 + 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 92fb9b6..ea95bff 100644 --- a/README.md +++ b/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), diff --git a/docs/source/conf.py b/docs/source/conf.py index 967ad8c..22323e4 100644 --- a/docs/source/conf.py +++ b/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"] diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst index 6530612..ffe23cd 100644 --- a/docs/source/tutorial.rst +++ b/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. diff --git a/pyproject.toml b/pyproject.toml index cf3f2a4..ca5df03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ doc = [ "myst-parser", "sphinx_copybutton", "sphinx-design", + "sphinxcontrib-youtube", ] [project.urls]