Open In Colab   Open in Kaggle

Tutorial 6: Professional Development#

Week 1, Day 1: Instructions

By Neuromatch

Content creators: Viviana Greco & Konstantine Tsafatinos

Content reviewers: Konstantine Tsafatinos

Production editors: Konstantine Tsafatinos


Acknowledgments: [Climatematch]

Tutorial Objectives#

Estimated timing of tutorial: [15 mins]

In this tutorial, you will learn how to build the professional development section and updating the repository with your new content.

You will:

  • learn where the professional development folder lives

  • what each file contains

  • learn how to update the prof_dev_materials.yml to reflect the newly created notebook.

It is recommended that you read through all of tutorials 1 through 4 as this tutorial builds upon that knowledge.

Section 1: Folder Structure#

In the projects directory, you will find a subdirectory named professional_development (located at projects/professional_development). This subdirectory contains the following six files:

  • README.md

  • career_features.md

  • career_panels.md

  • prof_dev_material.yml

  • impact_talks.ipynb

We have included examples from our Computational Tools for Climate Science course. Please feel free to use them as a template and edit them to your needs.

Section 2: The career_features.md file#

In this file, you will describe the why, what and how aspects of entering the field as a professional. Treat this as a short intro into the possible paths one can take, and what to expect.

Section 3: The career_panels.md file#

It is encouraged to organize panels of professionals in the field so that student can partipate, ask questions, and gain an understanding of how a future career might look for them. We believe that these kind of events will help facilitate new scientists and researchers in the field.

The career_panels.md file outlines the schedule and organization of these panels. Feel free follow climatematch’s example, or to tweak it for your domain.

Section 4: The impact_talks.ipynb file#

The impact_talks.ipynb file contains a description of the relevant and important topics surrounding the questions of “how” we do research in your domain. You can decide exactly what is important, and what you would like to highlight. We recommend including talks and organizing interactive sessions with students to help solidify and emphasize this knowledge. See the included example for climate to get an idea of what this could look like for your course.

Section 5: Add Content to the prof_dev_material.yml File#

The prof_dev_material.yml File is used in our scripts to help populate the book section “Professional Development” and create a table of contents.

Ensure that the names of the six files listed above exactly match those specified in the prof_dev_material.yml file. This precise naming is necessary for the scripts to correctly identify and incorporate these files into the book.

For guidance on the required file structure and naming, refer to the prof_dev_material.yml file within this template notebook. This file demonstrates the necessary layout and order for the content, which is essential for successfully build the “Professional Development” section of the book.

NOTE: If you follow the same structure and kept the same filenames as the included example, you will likely not need to change this file. Otherwise, if you decided to add new content, or change the names/organization of the the content, be sure to reflect that in the prof_dev_materials.yml file. You can follow the project instructions from W1D1_Tutorial5 on how to change file names and titles.

Summary#

Congrats! You now know:

  1. where the professional development folder lives

  2. what each file contains

  3. how to update the prof_dev_materials.yml

Happy content creating!