Creating a Training Module: A Train-the-Trainer Guide

Creating a Training Module: A Train-the-Trainer Guide#

A comprehensive guide for developing effective training modules using Jupyter Book, specifically designed for researchers with machine learning experience who want to become trainers in the HEP community.

This program focuses on the development of training materials, equipping you with the technical skills to create engaging and reproducible training content.

Learning Objectives#

  • Create interactive, reproducible content using Jupyter Book and MyST Markdown

  • Set up automated workflows with GitHub Actions for continuous integration and deployment

  • Provide seamless student setup using requirements.txt

Prerequisites#

Technical Skills#

  • Python programming (you should be comfortable with packages, virtual environments)

  • Basic Git/GitHub knowledge (clone, commit, push, pull requests)

  • Command line familiarity (running commands, navigating directories)

Software Requirements#

  • Python 3.9+

  • Git and a GitHub account

  • A code editor

  • Modern web browser

Table of Content#

Additional Resources#

Official Documentation#

Other Resources#

Contents