From 5c271dce53c3c1e37299682cf5218fbd64d98989 Mon Sep 17 00:00:00 2001 From: hmonroedd Date: Tue, 19 May 2026 13:42:00 -0400 Subject: [PATCH 1/2] update readme and env --- README.md | 6 +++++- environment.yml | 6 +----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ff8568bd..58db0a55 100644 --- a/README.md +++ b/README.md @@ -22,4 +22,8 @@ git clone https://github.com/festim-dev/FESTIM-workshop conda env create -f environment.yml ``` -3. You should then be able to execute the notebooks with the ``festim-workshop`` environment \ No newline at end of file +3. Compile the book locally + +``` +jupyter-book build book +``` \ No newline at end of file diff --git a/environment.yml b/environment.yml index 9f907385..3eba3560 100644 --- a/environment.yml +++ b/environment.yml @@ -4,15 +4,11 @@ channels: - defaults dependencies: - - python<3.13 - - pip=23.3 - setuptools<82 - wheel<0.45 - jupyter-book<2.0 - - python<3.14 # som pyvista incompatibility issues with python 3.14 + - python<3.14 # some pyvista incompatibility issues with python 3.14 - pip=23.3 - - setuptools<82 - - wheel<0.45 - jupytext # necessary to open MyST files using BinderHub https://jupyterbook.org/en/stable/interactive/launchbuttons.html#launchbuttons-binder - sphinx-tags - ipywidgets From 5cb21223055269eba010c25c1641be0f6e74ac40 Mon Sep 17 00:00:00 2001 From: hmonroedd Date: Tue, 19 May 2026 13:42:05 -0400 Subject: [PATCH 2/2] added URL --- book/_toc.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/book/_toc.yml b/book/_toc.yml index ea23dbc6..73121d6d 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -7,6 +7,8 @@ parts: - caption: Getting started chapters: - file: content/applications/task01 + - url: https://festim.readthedocs.io/en/latest/installation.html + title: Installation - caption: Fundamentals chapters: