Submission Architecture Decision Record (ADR)

Submission Architecture Decision Record (ADR)#

Status: DRAFT

12/1/24

Context#

Students are currently directed to export PDFs and submit via Brightspace. This has various tradeoffs — see the comparison below — and I think there might be a better way.

Options#

Format#

Option

Pros

Cons

PDF

Avoids “works on my machine”

No support for interactive plots; Plotly needs extra packages and is fragile; long outputs look bad

HTML

Supports interactive plots; outputs support scrolling, though that must be done by the student

TODO

Notebook

Supports interactive plots; long outputs are collapsable/scrollable by the grader

Can hide long outputs; can interact with interactive plots; TODO

PDF export#

If sticking with PDFs, they can be exported from JupyterHub:

Option

Pros

Cons

Directly, via nbconvert

Single click, in theory

Fragile

As HTML, then Save as PDF

Higher fidelity

Plotly doesn’t re-draw on print, so need to resize window or set dimensions to ensure it fits

Tool#

Option

Supports

Pros

Cons

Brightspace

PDF, HTML

Students are comfortable with it

TODO

Gradescope

PDF, notebook

Supported by both schools; autograder support

Notebook submissions aren’t interactive

Decision#

TODO

Consequences#

TODO