CUQI-DTU / CUQI-Book

Apache License 2.0
0 stars 2 forks source link

Find solution for the build environment/Jupyter book to enable including CIL/FENICS/PyTorch based code in the book #44

Closed amal-ghamdi closed 1 month ago

amal-ghamdi commented 1 month ago

Description:

The CUQI-Book/training material contains code that uses CIL/FEniCS/PyTorch. Find out if it is possible to set up the book compilation environment to render executed notebooks that use these libraries (can we set one environment or maybe multiple, each used for the corresponding notebook). If not possible or feasible, find a workaround solution, for example, adding directives to not execute these notebooks or decide on where to place these notebooks if it is not possible to include them in the CUQI-Book

Definition of done:

Notes:

The suggested workaround solution is to ignore the notebooks depending on CIL/FEniCS/PyTorch from execution

amal-ghamdi commented 1 month ago

Hi @jakobsj, May I ask you to review this issue. Many thanks! The solution of this issue is in the Notes section of the issue description box above

jakobsj commented 1 month ago

I very much like the solution of diplaying the already locally offline executed notebooks with results as part of the book. Perhaps a heads-up should be given somewhere that execution is disabled and so a reader would have to run it elsewhere. Approving.

amal-ghamdi commented 1 month ago

thank you @jakobsj for you review. I added the comment about the heads-up to the list of your book comments: #57