Skip to content

Commit

Permalink
Merge pull request #9 from neuromatch/add-prereqs
Browse files Browse the repository at this point in the history 
add prereqs info
  • Loading branch information
@iamzoltan
iamzoltan authored Dec 12, 2023
2 parents ac9032e + 271e7a4 commit c90dc5f
Show file tree
Hide file tree
Showing 3 changed files with 236 additions and 38 deletions.
26 changes: 18 additions & 8 deletions tutorials/W1D1_Instructions/W1D1_Tutorial4.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"execution": {}
},
"source": [
"Within the tutorials directory, you'll find a schedule directory (ie. tutorials/Schedule). In this directory, you'll see the following 4 files:\n",
"- daily_schedules.md\n",
Expand All @@ -180,7 +182,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"execution": {}
},
"source": [
"___\n",
"\n",
Expand Down Expand Up @@ -217,7 +221,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"execution": {}
},
"source": [
"Below is an example of the vars set for this template:\n",
"\n",
Expand All @@ -237,6 +243,15 @@
" "
]
},
{
"cell_type": "markdown",
"metadata": {
"execution": {}
},
"source": [
"We have included the precourse materials from our comp neuro course in the template to demonstrate how it would look. Feel free to use it as a template for your precourse materials."
]
},
{
"cell_type": "markdown",
"metadata": {
Expand All @@ -256,11 +271,6 @@
"\n",
"Happy content creating!"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
}
],
"metadata": {
Expand Down
124 changes: 109 additions & 15 deletions tutorials/W1D1_Instructions/instructor/W1D1_Tutorial4.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"- learn how to create Wrap Ups for a given module (category)\n",
"- learn how to add Bonus Tutorials\n",
"- learn how to add/update the course schedule\n",
"- learn how to add prereqs for your course\n",
"\n",
"It is recommended that you read through all of tutorials 1 through 3 as this tutorial builds upon that knowledge."
]
Expand All @@ -81,10 +82,10 @@
"source": [
"Steps:\n",
"- Choose the image you want to use. This can come from the Art contests during the course, or from somewhere on the web.\n",
"- Add the image to the directory tutorials/Art/\n",
"- Add the image to the directory **tutorials/Art/**\n",
"- Name the image with the follow format: W#D#_DayName-Artist_Name.(jpg or png)\n",
"\n",
"You **must** follow the above format exactly! This includes the underscores and dashes. Here is an example: W2D4_DynamicNetworks-Ekaterina_Morozova.jpg\n",
"You **must** follow the above format exactly! This includes the underscores and dashes. Here is an example: **W2D4_DynamicNetworks-Ekaterina_Morozova.jpg**\n",
"The beginning of the file name (ie. W2D4_) is used to place the image on the landing page for the right day, and the end (ie. -Ekaterina_Morozova) is used to credit the artist. You can find examples [here](https://github.com/neuromatch/course-content-template/tree/main/tutorials/Art)."
]
},
Expand All @@ -109,9 +110,9 @@
"source": [
"Steps:\n",
"- Decide on the format for your wrap up\n",
"- Add the notebook file to the directory tutorials/Module_WrapUps\n",
"- Add the notebook file to the directory **tutorials/Module_WrapUps**\n",
"- Give the file the same name as the module (category) with the file extension .ipynb\n",
"Here is an example of the naming convention: CourseContentTemplateInstructions.ipynb\n",
"Here is an example of the naming convention: **CourseContentTemplateInstructions.ipynb**\n",
"\n",
"**Note**: the category name defined in the materials.yml file may have spaces, but the file name for the wrap up must *not*. Simply remove the spaces and concatenate all the word in the category title together, exactly how they are written in the materials file.\n"
]
Expand All @@ -126,7 +127,7 @@
"\n",
"## Section 3: Bonus Tutorials\n",
"\n",
"You have to option to add bonus tutorials for a given module/category. The process is similar to adding regular tutorials, only the prefix for the folder will be Bonus, instead of the week number and day number. For example, a bonus tutorial within the tutorials directoty would look as follows: tutorials/Bonus_ContentName. \n",
"You have to option to add bonus tutorials for a given module/category. The process is similar to adding regular tutorials, only the prefix for the folder will be Bonus, instead of the week number and day number. For example, a bonus tutorial within the tutorials directoty would look as follows: **tutorials/Bonus_ContentName**. \n",
"\n",
"The Bonus directory should follow a similar structure to the regular tutorials directory by including the follow files within the bonus directory:\n",
"- Bonus_Intro.ipynb\n",
Expand All @@ -138,13 +139,13 @@
"\n",
"\\- day: Bonus\n",
"\n",
"category: Name of the module you want to include a bonus for\n",
"    category: Name of the module you want to include a bonus for\n",
"\n",
"name: Bonus Content Name\n",
"    name: Bonus Content Name\n",
" \n",
"tutorials: N -> The number of tutorials in the bonus.\n",
"    tutorials: N -> The number of tutorials in the bonus.\n",
"\n",
"You should follow all the same conventions described for regular tutorial creation. This template includes a bonus tutorial in the Intructions section that you can use as a template. See the materials.yml file for how to add a bonus to a module."
"You should follow all the same conventions described for regular tutorial creation. This template includes a bonus tutorial in the Intructions section that you can use as a template. See the **materials.yml** file for how to add a bonus to a module."
]
},
{
Expand All @@ -155,7 +156,100 @@
"source": [
"---\n",
"\n",
"## Section 4: Course Schedule\n"
"## Section 4: Course Schedule\n",
"\n",
"We include a daily schedule and links to shared calendars in the course books for reference for the students and TAs. This section will briefly describe where this content lives, and which files to change for your new course."
]
},
{
"cell_type": "markdown",
"metadata": {
"execution": {}
},
"source": [
"Within the tutorials directory, you'll find a schedule directory (ie. tutorials/Schedule). In this directory, you'll see the following 4 files:\n",
"- daily_schedules.md\n",
"- schedule_intro.md\n",
"- shared_calendars.md\n",
"- timezone_widget.md\n",
"\n",
"The time zone widget is managed in another repo and is simply linked to this book; you won't need to really edit that here. The files you want to pay attention to are the **daily_schedules.md** and **shared_calendars.md** files. You should edit them reflect the actual schedules and shared calendars for your newly created course.\n",
"\n",
"**NOTE**: You will need to replace the day names in the daily_schedules.md file to match the name for your course. You will also need to replace the links to the shared calendars (in UTC) to point to the calendars for your course.\n",
"\n",
"We have included examples from our comp neuro course. Please feel free to use them as a template and edit them to your needs."
]
},
{
"cell_type": "markdown",
"metadata": {
"execution": {}
},
"source": [
"___\n",
"\n",
"## Section 5: Course Prereqs\n",
"\n",
"This section briefly describes how to include precourse work for your new course. Generally, the precourse tutorials live in a separate repo. We suggest importing the precourse repo under the neuromatch organization (similar to what you did for this course book), and then naming it something like **yourcourse-precourse** under the neuromatch organization. You can then edit the tutorials for the prereqs directly and decide what to keep and what to change. \n",
"\n",
"**NOTE**: You should follow the structure **exactly** as it is laid out from the imported repo. It is very similar to the structure of the tutorials for the regular book.\n",
"\n",
"You will need to:\n",
"- write all your tutorials in the tutorials directory of the precourse repo\n",
"- use the prefix W0D# for your days of precourse work\n",
"- edit the materials.yml file in the tutorials directory to reflect the names of your days as well as the number of tutorials for each day\n",
"- write an intro for the course/precourse and save it as a .md file in the prereqs directory of the precourse repo\n",
"\n",
"\n",
"After all that is done, you should then edit the **publish-book.yml** workflow file in your course book repo under the .github/workflows directory and change **ONLY** the following env vars to match your new course and precourse repos.\n",
"\n",
"env:\n",
"\n",
"     NB_KERNEL: python\n",
"\n",
"     ORG: neuromatch\n",
"\n",
"     NMA_REPO: new-course-content\n",
"\n",
"     NMA_MAIN_BRANCH: main\n",
"\n",
"     PREREQ_REPO: yourcourse-precourse\n",
"\n",
"     PREREQ_INTRO: MyNewCourse\n",
" "
]
},
{
"cell_type": "markdown",
"metadata": {
"execution": {}
},
"source": [
"Below is an example of the vars set for this template:\n",
"\n",
"env:\n",
"\n",
"     NB_KERNEL: python\n",
"\n",
"     ORG: neuromatch\n",
"\n",
"     NMA_REPO: course-content-template\n",
"\n",
"     NMA_MAIN_BRANCH: main\n",
"\n",
"     PREREQ_REPO: precourse\n",
"\n",
"     PREREQ_INTRO: ComputationalNeuroscience\n",
" "
]
},
{
"cell_type": "markdown",
"metadata": {
"execution": {}
},
"source": [
"We have included the precourse materials from our comp neuro course in the template to demonstrate how it would look. Feel free to use it as a template for your precourse materials."
]
},
{
Expand All @@ -169,11 +263,11 @@
"\n",
"Congrats! You now know:\n",
"\n",
"1. how and where to create new content\n",
"2. how to follow our naming convention\n",
"3. how to prepare the notebooks for our pipeline\n",
"4. how to create branches and pull requests\n",
"5. the basics of our workflows using github actions\n",
"1. how and where to add artwork/images to your day landing page\n",
"2. how and where to add module Wrap Ups\n",
"3. how to include bonus tutorials for a module\n",
"4. how to create/update your course schedules\n",
"5. the basics of adding prereqs to your course notebook\n",
"\n",
"Happy content creating!"
]
Expand Down
Loading

0 comments on commit c90dc5f

Please sign in to comment.