diff --git a/README.md b/README.md index ff8568b..58db0a5 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/book/_toc.yml b/book/_toc.yml index ea23dbc..73121d6 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: diff --git a/environment.yml b/environment.yml index 9f90738..3eba356 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