swcarpentry / python-novice-inflammation

Programming with Python
http://swcarpentry.github.io/python-novice-inflammation/
Other
299 stars 778 forks source link

Simplify downloading of lesson materials #621

Open tiagopereira opened 5 years ago

tiagopereira commented 5 years ago

This lesson currently has two zip files: data and code. According to the instructions, these end up being unzipped in the same folder. Since the files are so small, I think it would be simpler if they are combined into a single zip file (with directories data/ and code/ inside). This would require a lot less clicking by participants.

In addition, I think it would be very helpful if the setup instructions for these additional materials be added in the workshop template. Currently, the workshop template under Python only directs participants to install Anaconda. Having the link and instructions for the support materials here would help participants get ready before the workshop and save precious time on the day. Besides, it would also remove the requirement of having internet access during the workshop (assuming all installation went well). Often participants come from other Universities/institutions and don't always find it easy/possible to connect to the local wifi.

maxim-belkin commented 5 years ago

Hi, Tiago. You are absolutely right that one zip file is better than two. There is even a PR that implements that: https://github.com/swcarpentry/python-novice-inflammation/pull/593. We, however, also need a rule in our Makefile that will allow us to update this zip archive automatically. Would you be interested in adding such a rule to our Makefile?

tiagopereira commented 5 years ago

Hi @maxim-belkin I can make this change, but I need to start a new PR as I can't modify #593 .

Also, I see a Makefile under code/, but I don't see how it is run (can't find any reference to it in the main Makefile), so am I right to assume that this is only run manually? I could also not find a Makefile for the data/ part, so perhaps the best way is to combine the code/Makefile into the main Makefile? The individual zip files go into the code/ and data/ directories, so what is a good location for the combined file? assets/?