Merge pull request #171 from hmonroedd/install

Link to install

Author: RemDelaporteMathurin

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
+3. Compile the book locally
+
+```
+jupyter-book build book
+```

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:

book/content/applications/surrogate.md

@@ -230,8 +230,8 @@ We will train several models by simply instantiating `AutoEmulate` with our $X$
 :tags: [hide-output]
 
 from autoemulate import AutoEmulate
-# Run AutoEmulate with default settings
-ae = AutoEmulate(X, Y, log_level="info")
+
+ae = AutoEmulate(X, Y, log_level="info", models=["GaussianProcessRBF"])
 ```
 
 ```{code-cell} ipython3

environment.yml

@@ -4,15 +4,11 @@ channels:
   - defaults
 
 dependencies:
-  - python<3.13
-  - pip=23.3
-  - setuptools<82
+  - setuptools
   - wheel<0.45
   - jupyter-book<2.0
-  - python<3.14  # som pyvista incompatibility issues with python 3.14
+  - python<3.13  # autoemulate is not compatible with Python 3.13 yet
   - 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
@@ -38,4 +34,5 @@ dependencies:
     - h-transport-materials==0.16
     - foam2dolfinx>=1.1
     - openmc2dolfinx
+    - torch<2.12.0
     - autoemulate