search

charlesfrye / psych101d-demo

Subset of demonstration materials for PSYCH101-D, "Data Science for Research Psychology"
0 stars 0 forks source link

Save lectures in .html format #4

Open ANaka opened 5 years ago

ANaka commented 5 years ago

I haven't used jupyter notebooks as slides before, probably many students will not have either. I figured out how to convert them to slides and view them in my browser, but I didn't know at first that I needed to run the notebooks before doing this so it was confusing at first. I understand the motivation behind saving the notebooks with the outputs cleared from all the cells, but maybe it makes sense to also include .htmls of the notebooks with all the appropriate outputs so that someone can easily see the slides after cloning the repo

ANaka commented 5 years ago

Oh wait, I didn't realize you need to be running a process for the slides to be interactive/formatted correctly. Nevertheless, still probably makes sense to have the notebook outputs pre-generated since running the simulations can take a while. Maybe just in the notebooks makes more sense

charlesfrye commented 5 years ago

The issue with including the outputs is that the outputs cause issues for version control.

  1. They inflate the size and line count of the nb.
  2. They are often random, and so vary even when the code doesn't vary, introducing extraneous diffs.
  3. Even when non-random, they are sensitive to upstream changes and so can introduce hard-to-read diffs.

I will try to make the description of how to use the Slides notebooks more clear in the readme.