# ias-uni-siegen/rl_course architecture

> Architecture diagram of the GitHub repository ias-uni-siegen/rl_course, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ias-uni-siegen/rl_course
- Repository: https://github.com/ias-uni-siegen/rl_course

## Overview

##### Project type and purpose
- This is an educational “course‐ware” repository for a Reinforcement Learning course.
- It contains:
- Lecture source (LaTeX + figures)
- Jupyter‐based exercises (templates & solutions)
- Build scripts to generate PDFs
- CI/CD configuration (GitHub Actions)
- Deployment targets (GitHub Pages for slides)

##### File structure
- Top‐level directories:
- lecture/ — LaTeX sources, figures, build.py, output folder
- exercises/ — nbgrader config, exercise templates, solution notebooks
- course_template/ — scaffolding for new courses (submodule)
- .github/ — CI workflows (buildPDFs.yml)
- misc/, requirements.txt, README.md, LICENSE
- The build pipeline invokes build.py (Python+LaTeX), uses requirements.txt for Python deps, produces lecture.pdf and packages notebooks.
- The GitHub Actions workflow “buildPDFs.yml” runs on push, calls build.py, and likely deploys artifacts to GitHub Pages.

##### README for additional insights
- Describes:
- Python 3.12 + site-packages per requirements.txt
- How to run/build slides and exercises
- Deployment of lecture.pdf to https://…/RL_course/lecture.pdf
- Use of Gymnasium environments for tutorials

##### Final checklist
- Components: lecture source, exercise templates, solutions, build script, CI, hosting
- Data flows: edit → push → build → publish
- Patterns: monorepo + CI/CD + static hosting
- Technologies: LaTeX, Python, Jupyter, GitHub Actions, Pages

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Content Sources
    subgraph "Content Sources"
        direction TB
        lecture_dir["lecture/"]:::content
        lecture_main["main.tex"]:::content
        lecture_fig["fig/"]:::content
        templates_dir["exercises/templates/"]:::content
        nbgrader_config["nbgrader_config.py"]:::content
        solutions_dir["exercises/solutions/"]:::content
    end

    %% Build & Orchestration
    subgraph "Build & Orchestration"
        direction TB
        build_py["build.py"]:::process
        requirements["requirements.txt"]:::process
        latex_toolchain["TeX Live"]:::external
        nbgrader_tool["nbgrader"]:::external
    end

    %% CI/CD
    subgraph "CI/CD Pipeline"
        direction TB
        github_actions["GitHub Actions"]:::cloud
        ci_yaml["buildPDFs.yml"]:::process
    end

    %% Artifacts
    subgraph "Artifacts" 
        direction TB
        artifacts_pdf["lecture.pdf"]:::artifact
        artifacts_nb["exercise notebooks"]:::artifact
    end

    %% Deployment
    subgraph "Deployment & Hosting"
        direction TB
        pages["GitHub Pages"]:::cloud
        students["Students"]:::external
    end

    %% Project Metadata & Scaffolding
    subgraph "Metadata & Scaffolding"
        direction TB
        course_template["course_template/"]:::content
        readme["README.md"]:::content
        license["LICENSE"]:::content
    end

    %% External Services
    subgraph "External Services"
        direction TB
        github_repo["GitHub Repository"]:::cloud
        gymnasium["Gymnasium"]:::external
    end

    %% Connections
    lecture_dir -->|contains| lecture_main
    lecture_dir -->|contains| lecture_fig
    templates_dir -->|config| nbgrader_config
    templates_dir -->|templates| solutions_dir

    lecture_dir -->|feeds| build_py
    templates_dir -->|feeds| build_py
    nbgrader_config -->|configures| nbgrader_tool

    requirements -->|installs deps| build_py
    latex_toolchain -->|used by| build_py
    nbgrader_tool -->|used by| build_py

    github_repo -->|push triggers| github_actions
    github_actions -->|runs| ci_yaml
    ci_yaml -->|calls| build_py

    build_py -->|generates| artifacts_pdf
    nbgrader_tool -->|builds| artifacts_nb

    github_actions -->|publishes| pages
    artifacts_pdf -->|deployed to| pages
    artifacts_nb -->|deployed to| pages

    pages -->|serves to| students

    github_repo -->|hosts code| course_template
    gymnasium -->|used for examples| solutions_dir

    %% Click Events
    click lecture_dir "https://github.com/ias-uni-siegen/rl_course/tree/master/lecture/"
    click lecture_main "https://github.com/ias-uni-siegen/rl_course/blob/master/lecture/main.tex"
    click lecture_fig "https://github.com/ias-uni-siegen/rl_course/tree/master/lecture/fig/"
    click templates_dir "https://github.com/ias-uni-siegen/rl_course/tree/master/exercises/templates/"
    click nbgrader_config "https://github.com/ias-uni-siegen/rl_course/blob/master/exercises/nbgrader_config.py"
    click solutions_dir "https://github.com/ias-uni-siegen/rl_course/tree/master/exercises/solutions/"
    click build_py "https://github.com/ias-uni-siegen/rl_course/blob/master/lecture/build.py"
    click requirements "https://github.com/ias-uni-siegen/rl_course/blob/master/requirements.txt"
    click ci_yaml "https://github.com/ias-uni-siegen/rl_course/blob/master/.github/workflows/buildPDFs.yml"
    click artifacts_pdf "https://github.com/ias-uni-siegen/rl_course/tree/master/lecture/built/"
    click course_template "https://github.com/ias-uni-siegen/rl_course/tree/master/course_template/"
    click readme "https://github.com/ias-uni-siegen/rl_course/blob/master/README.md"
    click license "https://github.com/ias-uni-siegen/rl_course/tree/master/LICENSE"

    %% Styles
    classDef content fill:#D0E8FF,stroke:#3399FF,color:#000;
    classDef process fill:#FFE8B2,stroke:#FF9900,color:#000;
    classDef artifact fill:#D0FFD6,stroke:#33CC33,color:#000;
    classDef cloud fill:#E0E0E0,stroke:#AAAAAA,color:#000;
    classDef external fill:#F0F0F0,stroke:#888888,color:#000;
```
