Merge pull request #456 from carpentries-incubator/bielsnohr/ukaea-march-2025

Updates from UKAEA March 2025 Run

Author: bielsnohr

episodes/32-software-architecture-design.md

@@ -131,6 +131,8 @@ goal of having *maintainable* code, which is:
 Now that we know what goals we should aspire to, let us take a critical look at the code in our
 software project and try to identify ways in which it can be improved.
 
+## Designing a New Feature for Our Project
+
 Our software project contains a pre-existing branch `full-data-analysis` which contains code for a new feature of our
 inflammation analysis software, which we will consider as a contribution by another developer.
 Recall that you can see all your branches as follows:
@@ -154,7 +156,7 @@ This bit of functionality is handled by `inflammation-analysis.py` in the projec
 The new data analysis code is located in `compute_data.py` file within the `inflammation` directory
 in a function called `analyse_data()`.
 This function loads all the data files for a given a directory path, then
-calculates and compares standard deviation across all the data by day and finaly plots a graph.
+calculates and compares standard deviation across all the data by day and finally plots a graph.
 
 :::::::::::::::::::::::::::::::::::::::  challenge
 

episodes/34-code-refactoring.md

@@ -95,12 +95,12 @@ we refactor or change code in the future.
 Start from the skeleton test code below:
 
 ```python
+from inflammation.compute_data import analyse_data
+
 def test_analyse_data():
-    from inflammation.compute_data import analyse_data
-    path = Path.cwd() / "../data"
+    path = os.path.join( os.getcwd(), "../data")
     data_source = CSVDataSource(path)
     result = analyse_data(data_source)
-
     # TODO: add assert statement(s) to test the result value is as expected
 ```
 
@@ -115,7 +115,6 @@ When determining the correct return data result to use in tests, it may be helpf
 result equals some random made-up data, observe the test fail initially and then
 copy and paste the correct result into the test.
 
-
 :::::::::::::::::::::::::
 
 :::::::::::::::  solution
@@ -134,11 +133,10 @@ Putting this together, our test may look like:
 
 ```python
 import numpy.testing as npt
-from pathlib import Path
+from inflammation.compute_data import analyse_data
 
 def test_analyse_data():
-    from inflammation.compute_data import analyse_data
-    path = Path.cwd() / "../data"
+    path = os.path.join( os.getcwd(), "../data")
     data_source = CSVDataSource(path)
     result = analyse_data(data_source)
     expected_output = [0.,0.22510286,0.18157299,0.1264423,0.9495481,0.27118211,

episodes/fig/mvc_arch.svg

@@ -1,4 +1,4 @@
-# Notes for using slides
+# Notes for Using Slides
 
 Some quick information about how to use the slides when delivering the course.
 
@@ -29,12 +29,33 @@ jupyter-notebook #  or `jupyter-lab`
 > jupytext
 > ```
 
-Use the RISE extension to Jupyter to view the slides.
-This allows you to enter the slideshow from the Jupyter notebook web interface.
+Use the RISE extension of Jupyter to view and edit the slides.
+There is now a substantial interface difference between the two modalities (`jupyter-notebook` vs `jupyter-lab`).
+
+## Viewing and Editing Slides in Jupyter Notebook
+
 There should be a "projector screen" button on the Jupyter notebook toolbar next to the kernel name
 (you might need to go to the 'View' menu to get the toolbar to show).
-Click the button, or press `Alt-r` to launch the RISE presentation view.
-Use spacebar to advance slides. Presenter view with `t`.
+Click this button, or press `Alt-r` to launch the RISE presentation view.
+
+## Viewing and Editing Slides in Jupyter Lab
+
+- Click on the folder icon on the left-hand panel to get the file viewer
+- Right click on the slide files you want to view or edit
+- Select "Open With ▶" then "Rise Slides"
+- The rendered version of the slides should come up, and you can edit them from here.
+  One downside is that the notes are not also displayed, unless you get the presenter view as described below.
+- If you need to edit notes, it might be best to edit the markdown file directly.
+  You can do this from the file explorer again selecting "Open With ▶" and then "Jupytext Notebook".
+- The type of slide is set by using the "Property Inspector" on the right hand panel (two cogs icon).
+
+## Navigating
+
+Use `Space` to advance slides, `Shift + Space` to go back.
+The arrow keys on your keyboard will not work like you expect!
+Bring up presenter view with `t`, which will show the notes for a given slide.
+
+## Saving Slides
 
 Saving the slides from the Jupyter interface should only save to the markdown source file.
 If you find you have ended up with some `.ipynb` files in the `slides/` directory,