Merge pull request #253 from UCL/saransh/jupyterlite

feat: JupyterLite integration

.github/workflows/build_site.yml

@@ -49,6 +49,13 @@ jobs:
           bundle install
       - name: Build website
         run: bundle exec jekyll build
+      - name: Build the JupyterLite site
+        run: |
+          find . -type d -name .pytest_cache -o -name .ruff_cache -o -name .doctrees | xargs rm -rf
+          mkdir contents
+          mkdir _site/jupyter-lite
+          find ch*/ -type f -name '*.ipynb' ! -name '*.nbconvert.ipynb' -exec rsync -R {} contents/ \;
+          jupyter lite build --contents contents --output-dir _site/jupyter-lite
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -87,3 +87,5 @@ session04/greetings/scripts/
 Gemfile.lock
 .env/
 polynomials.svg
+contents/
+.jupyterlite.doit.db

Makefile

@@ -107,3 +107,4 @@ clean:
 	rm -f ch07dry/datasource*.yaml
 	rm -f ch07dry/example.yaml
 	rm -f notebooks.zip
+	rm -rf contents

_config.yml

@@ -36,3 +36,7 @@ exclude:
   - "*/*.v2.ipynb"
   - "combined_files"
   - "combined.ipynb"
+  - jupyter-lite
+
+keep_files:
+  - jupyter-lite

ch00git/01Intro.ipynb.py

@@ -122,6 +122,11 @@
 # %% [markdown]
 # Commands you can type will look like this, using the %%bash "magic" for the notebook.
 
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+
+
 # %% attributes={"classes": [" Bash"], "id": ""} jupyter={"outputs_hidden": false} language="bash"
 # echo some output
 

ch00git/02Solo.ipynb.py

@@ -14,6 +14,11 @@
 # %% [markdown]
 # ## Solo work with Git
 
+# %% [markdown]
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+
 # %% [markdown]
 # So, we're in our git working directory:
 

ch00git/03Mistakes.ipynb.py

@@ -14,6 +14,11 @@
 # %% [markdown]
 # ## Fixing mistakes
 
+# %% [markdown]
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+
 # %% [markdown]
 # We're still in our git working directory:
 

ch00git/04Publishing.ipynb.py

@@ -14,6 +14,11 @@
 # %% [markdown]
 # ## Publishing
 
+# %% [markdown]
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+
 # %% [markdown]
 # We're still in our working directory:
 

ch00git/05Collaboration.ipynb.py

@@ -13,7 +13,12 @@
 
 # %% [markdown]
 # ## Collaboration
-#
+
+# %% [markdown]
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+# 
 # ### Form a team
 
 # %% [markdown]

ch00git/10Branches.ipynb.py

@@ -13,7 +13,11 @@
 
 # %% [markdown]
 # ## Branches
-#
+# 
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+# 
 # Branches are incredibly important to why `git` is cool and powerful.
 #
 # They are an easy and cheap way of making a second version of your software, which you work on in parallel,

ch00git/11Miscellany.ipynb.py

@@ -14,6 +14,11 @@
 # %% [markdown]
 # ## Git Stash
 
+# %% [markdown]
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+
 # %% [markdown]
 # Before you can `git pull`, you need to have committed any changes you have made. If you find you want to pull, but you're not ready to commit, you have to temporarily "put aside" your uncommitted changes.
 # For this, you can use the `git stash` command, like in the following example:

ch00git/12Remotes.ipynb.py

@@ -13,7 +13,11 @@
 
 # %% [markdown]
 # ## Working with multiple remotes
-#
+# 
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+# 
 # ### Distributed versus centralised
 #
 # Older version control systems (cvs, svn) were "centralised"; the history was kept only on a server,

ch00git/14Bisect.ipynb.py

@@ -13,7 +13,11 @@
 
 # %% [markdown]
 # ## Debugging With Git Bisect
-#
+# 
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+# 
 # You can use
 #
 # ``` bash

ch01python/00pythons.ipynb.py

@@ -218,6 +218,7 @@ def make_figure():
 # `make_figure` function defined in the module.
 
 # %%
+# restart kernel on jupyterlite (browser) before running this
 import draw_eight  # Load the library
 fig = draw_eight.make_figure()
 

ch01python/010exemplar.ipynb.py

@@ -43,6 +43,12 @@
 # By combining them we can feel really powerful but doing minimum work ourselves. The python syntax to import someone else's library is "import".
 
 # %%
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
+
+# install geopy if it is not already installed
+%pip install geopy
+
 import geopy # A python library for investigating geographic information.
 # https://pypi.org/project/geopy/
 

ch02data/061internet.ipynb.py

@@ -69,6 +69,8 @@
 # The Python [Requests](http://docs.python-requests.org/en/latest/) library can help us manipulate URLs and requesting the content associated with them. It is easier to use than the `urllib` library that is part of the standard library, and is included with Anaconda and Canopy. It sorts out escaping, parameter encoding, and so on for us.
 
 # %%
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 
 # %% [markdown]

ch02data/063tabular.ipynb.py

@@ -25,6 +25,8 @@
 # We can request the CSV file text from the URL we used previously:
 
 # %%
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 # Request sunspots data from URL and extract response content as text
 sunspots_csv_text = requests.get('http://www.sidc.be/silso/INFO/snmtotcsv.php').text

ch02data/066QuakeExercise.ipynb.py

@@ -21,6 +21,8 @@
 # We can use the [`requests` Python library](https://docs.python-requests.org/en/latest/) to simplify constructing the appropriate query string to add to the <abbr title="Uniform Resource Locator">URL</abbr> and to deal with sending the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> request.
 
 # %% jupyter={"outputs_hidden": false}
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 
 # %% [markdown]

ch02data/068QuakesSolution.ipynb.py

@@ -21,6 +21,8 @@
 # %% jupyter={"outputs_hidden": false}
 import math
 
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 import IPython
 from IPython.display import Image

ch02data/110Capstone.ipynb.py

@@ -30,6 +30,13 @@
 
 # %%
 # %%writefile greengraph/graph.py
+
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
+
+# install geopy if it is not already installed
+%pip install geopy
+
 import numpy as np
 import geopy
 from matplotlib import pyplot as plt
@@ -87,6 +94,9 @@ def plot_green_between(self, steps):
 
 import numpy as np
 import imageio.v3 as iio
+
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 
 class Map(object):

ch03tests/03pytest.ipynb.py

@@ -13,7 +13,11 @@
 
 # %% [markdown]
 # ## Testing frameworks
-#
+# 
+# **NOTE:** using bash/git commands is not fully supported on jupyterlite yet (due to single
+# thread/process restriction), and the cells below might error out on the browser
+# (jupyterlite) version of this notebook
+# 
 # ### Why use testing frameworks?
 
 # %% [markdown]

ch03tests/05Mocks.ipynb.py

@@ -97,6 +97,8 @@
 # For example, consider the following code that downloads a map from the internet:
 
 # %%
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 
 def map_at(lat, long, satellite=False, zoom=12, 

ch04packaging/010Installation.ipynb.py → ch04packaging/01Installation.ipynb.py

@@ -65,6 +65,12 @@
 # Now, close the Jupyter notebook if you have it open, and reopen it. Check your new library is installed with:
 
 # %%
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
+
+# install geopy if it is not already installed
+%pip install geopy
+
 import geopy
 geocoder = geopy.geocoders.Nominatim(user_agent="mphy0021") 
 

ch04packaging/04documentation.ipynb.py

@@ -79,7 +79,7 @@
 #
 # In writing Greeter, we used the [docstring conventions from NumPy](https://numpy.org/doc/stable/docs/howto_document.html).
 # So we use the [`numpydoc`](https://numpydoc.readthedocs.io/en/latest/) sphinx extension to
-# support these (Note: you will need to install this extension for the later examples to work).
+# support these (**NOTE:** you will need to install this extension for the later examples to work).
 
 # %% [markdown]
 # ```python

ch05construction/08objects.ipynb.py

@@ -84,6 +84,8 @@ def move(self, delta_t):
 # Here's how we can use Python code to get an image back from YUML:
 
 # %%
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 from IPython.display import Image
 

ch05construction/09patterns.ipynb.py

@@ -148,6 +148,9 @@ def yuml(model):
 from numpy.fft import rfft,fft,fftfreq
 from scipy.interpolate import UnivariateSpline
 from scipy.signal import lombscargle
+
+# sending requests to the web is not fully supported on jupyterlite yet, and the
+# cells below might error out on the browser (jupyterlite) version of this notebook
 import requests
 
 

requirements.txt

@@ -31,3 +31,7 @@ dask
 mimesis
 dask-expr
 graphviz
+jupyterlite-core
+jupyterlab
+notebook
+jupyterlite-pyodide-kernel