Open In Colab   Open in Kaggle

Intro#

Overview#

Welcome to the course content template. The aim of this booklet is to provide you with instructions on how to create buildable course content in the jupyter book format. We will cover everthing you need to know in order to build a book, collaborate with content creators, and host an html version of the book on github pages. Happy creating!

Prerequisite knowledge#

Ideally you have some knowledge of:

  • git

  • github

  • python

  • python jupyter notebooks

  • github CI/CD

Do not be discouraged if you are missing some of the prerequisites, we will give you a step by step explaination of how to go about building your course.

This course content template acts as a meta template; it provides you with instructions on how to use it while itself working and building like a course book would. We have included templates to be filled in where appropriate, and have included content for some of our courses to illustrate how it has been used. We hope that you find this helpful and enjoy the creating process.

Limitations#

It is highly encourage (borderline mandatory :p) that you stick to python packages that are easily installable using pip. If you need to install obscure supporting libraries, or specific verions of C compilers, this will cause you (and us) more headaches than necessary. If you want to use some obscure package, please try not to, or find another way to include the functionality of the desired package.

It is also strongly advised that you decide on a pythong version for the book, stick to it, and make sure that all of your content creators are using the same version. Mixing python versions will also create a lot of headaches. What ever version you decide on, be sure to specify that in the github workflows. This template is using python 3.9.

With love, the Neuromatch tech team