Merge branch 'main' of https://github.com/UPPMAX/programming_formalisms

.github/workflows/check_schedule.yaml

@@ -0,0 +1,30 @@
+# Check that the schedule has the right order
+name: Check schedule
+
+# Check links on the 21st day of the month.
+# 21st as the first letter of this repo is the 21st letter in the alphabet.
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: "0 0 21 * *"
+
+jobs:
+  check_schedule:
+
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-r@v2
+
+      - name: Install dependencies
+        run: |
+          install.packages(c("remotes", "testthat", "readr", "stringr", "tibble"))
+        shell: Rscript {0}
+
+      - name: Run script
+        run: ./scripts/check_schedule.R
+

.wordlist.txt

@@ -1510,3 +1510,30 @@ criticise
 Yay
 Mariam
 UNDF
+HICexplorer
+Readmes
+Couplers
+Dispensables
+Preventers
+blackbox
+ann
+Huw
+Collingbourne
+acknowledgements
+Acknowledgements
+KamilSJaron
+ov
+readme
+runing
+sacharomyces
+smudgeplot
+READMEs
+pypi
+bacsim
+PyPi
+testPyPI
+Beielstein
+subfunctions
+Stroebe
+Sitzmann
+

README.md

@@ -10,6 +10,7 @@
 [![Check spelling](https://github.com/UPPMAX/programming_formalisms/actions/workflows/check_spelling.yaml/badge.svg?branch=main)](https://github.com/UPPMAX/programming_formalisms/actions/workflows/check_spelling.yaml)
 [![Check markdown](https://github.com/UPPMAX/programming_formalisms/actions/workflows/check_markdown.yaml/badge.svg?branch=main)](https://github.com/UPPMAX/programming_formalisms/actions/workflows/check_markdown.yaml)
 [![Create website](https://github.com/UPPMAX/programming_formalisms/actions/workflows/create_website.yaml/badge.svg?branch=main)](https://github.com/UPPMAX/programming_formalisms/actions/workflows/create_website.yaml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14222353.svg)](https://doi.org/10.5281/zenodo.14222353)
 
 <!-- markdownlint-enable MD013 -->
 

data/README.md

@@ -0,0 +1,3 @@
+# Data
+
+Data being collected during the course.

data/counts/2023_autumn/README.md

@@ -0,0 +1,5 @@
+# Counts
+
+## Other data
+
+- Number of registrations: 40

data/counts/2023_summer/README.md

@@ -0,0 +1,5 @@
+# Counts
+
+## Other data
+
+- Number of registrations: 43

data/counts/2024_autumn/20241118_counts.csv

@@ -0,0 +1,35 @@
+time,n_cam_on,n_cam_off
+9:00,6,0
+9:01,6,1
+9:02,7,0
+9:03,7,0
+9:10,7,0
+9:11,8,0
+9:12,8,1
+9:16,8,1
+9:19,9,0
+9:30,9,0
+9:41,9,0
+10:03,7,2
+10:04,8,1
+10:05,9,0
+10:11,9,0
+10:21,9,1
+10:28,9,1
+10:39,8,2
+10:47,9,0
+10:51,9,0
+11:11,8,1
+13:01,3,5
+13:03,6,2
+13:04,7,1
+13:11,8,0
+14:15,5,3
+14:16,7,1
+14:17,8,0
+14:29,8,0
+14:36,9,0
+14:37,8,1
+15:15,7,2
+15:42,9,0
+

data/counts/2024_autumn/20241119_counts.csv

@@ -0,0 +1,21 @@
+time,n_cam_on,n_cam_off
+9:00,2,2
+9:01,5,1
+9:02,8,0
+9:03,8,0
+9:20,8,0
+9:21,7,1
+9:22,8,0
+9:27,8,0
+9:28,7,0
+9:35,8,0
+10:00,8,0
+13:00,2,2
+13:01,6,2
+13:02,8,0
+13:30,8,0
+14:16,8,0
+14:51,8,0
+14:52,7,1
+15:41,8,0
+

data/counts/2024_autumn/20241120_counts.csv

@@ -0,0 +1,9 @@
+time,n_cam_on,n_cam_off
+11:10,8,1
+11:25,9,0
+11:48,9,0
+13:03,9,0
+14:17,9,0
+15:17,9,0
+15:41,9,0
+15:53,9,0

data/counts/2024_autumn/20241121_counts.csv

@@ -0,0 +1,11 @@
+time,n_cam_on,n_cam_off
+9:01,5,0
+9:02,7,0
+9:23,7,1
+13:00,7,0
+13:01,7,1
+13:45,8,0
+14:00,8,0
+14:15,7,0
+14:40,5,0
+15:50,5,0

data/counts/2024_autumn/20241122_counts.csv

@@ -0,0 +1,9 @@
+time,n_cam_on,n_cam_off
+9:07,7,0
+9:59,7,0
+10:56,7,0
+11:15,6,1
+14:25,7,0
+14:51,7,0
+15:15,5,1
+15:16,6,0

data/counts/2024_autumn/README.md

@@ -0,0 +1,23 @@
+# Counts
+
+Goal of this experiment is to see how important camera usage is for
+keeping learners in an online course.
+
+## Data description
+
+`[date]_counts.csv` field|Description
+-------------------------|-------------------------------------
+`time`                   |Time
+`n_cam_on`               |Number of learners with the camera on. This excludes teacher(s) and assistants
+`n_cam_off`              |Number of learners with the camera on. This excludes teacher(s) and assistants
+
+## Other data
+
+- Number of registrations: 23
+
+## Conclusions
+
+The amount of learners present throughout the course was around 8 (mostly
+9, but 7 on Friday). Hence, we should expect `n_registrations / 3`
+active particpants.
+

data/counts/2024_summer/README.md

@@ -0,0 +1,16 @@
+# Counts
+
+Goal of this experiment is to see how important camera usage is for
+keeping learners in an online course.
+
+## Data description
+
+`[date]_counts.csv` field|Description
+-------------------------|-------------------------------------
+`time`                   |Time
+`n_cam_on`               |Number of learners with the camera on. This excludes teacher(s) and assistants
+`n_cam_off`              |Number of learners with the camera on. This excludes teacher(s) and assistants
+
+## Other data
+
+- Number of registrations: 33

docs/data_structures/class_design.md

@@ -144,7 +144,7 @@ On the other hand, a Python developer can at least see that this convention
 was broken.
 
 Note that some other programming languages completely disallows
-you from modifying a so-called 'private' member variabel.
+you from modifying a so-called 'private' member variable.
 
 ## Inheritance and polymorphism quote
 
@@ -168,7 +168,7 @@ well `[Gamma et al., 1995]`
 
 ## Exercise
 
-### Exercise: write a class with an invariant.
+### Exercise: write a class with an invariant
 
 - Pick a class at your skill level:
 

docs/data_structures/expressive_data_type.md

@@ -58,7 +58,7 @@ def get_bacteria_initialization(parameters): return parameters[3]
     Also, reading such a list is too uninformative: which `uniform`
     belong to which parameter?
 
-Using [a dictionary (`dict`)](https://docs.python.org/3/tutorial/datastructures.html#dictionaries) 
+Using [a dictionary (`dict`)](https://docs.python.org/3/tutorial/datastructures.html#dictionaries)
 can be considered good enough,
 until you've read up about classes:
 
@@ -81,7 +81,7 @@ def get_bacteria_initialization(parameters):
 
 When having read up on classes,
 one understands these are dictionaries
-with extra properties, such 
+with extra properties, such
 as **a name**.
 
 ## Good data structures increase expressiveness

docs/data_structures/has_a_relation.md

@@ -232,7 +232,7 @@ classDiagram
 
 ???- question "Answer for the particle"
 
-    ```
+    ```text
     class Position:
         def __init__(self, any_x, any_y):
           self.x = any_x