Package for converting thermo homework assignments


Keywords
thermodynamics, homework, pdf, jupyter, notebook
License
BSD-3-Clause
Install
pip install thermohw==0.7.1

Documentation

thermohw

Homework assignment converter from Jupyter Notebooks to PDF

This package installs a CLI script to convert Jupyter Notebook homework assignments to PDF (with and without solutions) and a set of Notebooks (with and without solutions).

Given a directory structure such as

.
├── homework
|   ├── homework-1
│   │   ├── homework-1-1.ipynb
│   │   ├── homework-1-2.ipynb
│   │   ├── homework-1-3.ipynb
│   │   ├── homework-1-4.ipynb
│   │   ├── homework-1-5.ipynb
│   │   ├── homework-1-6.ipynb
|   ├── homework-2
│   │   ├── homework-2-1.ipynb
│   │   ├── homework-2-2.ipynb
│   │   ├── homework-2-3.ipynb
│   │   ├── homework-2-4.ipynb
...

running

convert_thermo_hw --hw 1

will convert all of the .ipynb files in the homework-1 directory. You can also specify which problems should be converted by the problems argument, which takes a list of integers

convert_thermo_hw --hw 2 --problems 1 3 4

would convert problems 1, 3, and 4 in homework-2.

The option --by-hand allows certain problems to be marked as the solution should be done out by hand

convert_thermo_hw --hw 3 --by-hand 1 2

would mark problems 1 and 2 in homework-3 as to be done by hand instead of with the code.

The output files are placed in a directory called output in the homework-N directory.