# process-intelligence-research/computational_practicum_lecture_coding architecture

> Architecture diagram of the GitHub repository process-intelligence-research/computational_practicum_lecture_coding, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/process-intelligence-research/computational_practicum_lecture_coding
- Repository: https://github.com/process-intelligence-research/computational_practicum_lecture_coding

## Overview

The project is essentially a repository of lecture examples and coding exercises designed for a computational practicum. Its structure is organized by lecture, with two primary series (Q1 and Q2 lectures). Each lecture contains Jupyter notebooks that serve as self-contained code examples on a variety of topics (from programming basics and numerical methods to advanced topics such as PDEs and optimization). There’s also a supporting Python module in one lecture (the "managing modules and packages" folder) and supplementary data files (e.g., CSV and NPY files) which support some of the analyses.

##### Main Components
a. Repository Root: Acts as the container for all lecture materials.
b. Lecture Series: Two major groups – Q1 Lectures and Q2 Lectures.
- Q1 Lectures: Cover introductory topics, linear/nonlinear systems, numerical methods for integration/differentiation, differential equations (both initial and boundary value problems), and other related topics.
- Q2 Lectures: Cover advanced programming techniques, partial differential equations, optimization (linear/mixed integer), and regression/interpolation methods.
c. Resources and Helpers:
- Jupyter Notebooks: The primary content delivery medium across all folders.
- Supporting Code Modules: For example, in q2_lecture_1 there is a module “math_utils.py” along with a sub-package "plotting" which contains functionality for linear and quadratic plotting.
- Data Files: For example, the CSV and NPY files that act as input data for notebooks.
d. External Execution Environment: Although not a software component per se, the repository is designed to be deployed and run on platforms like Binder and Google Colab. These environments are an integral part of how users interact with the lectures.

##### Relationships and Interactions Between Components
- Within the Q2 lectures, note that some lectures, like Q2 Lecture 1, illustrate working with reusable modules and packages (i.e., the “managing modules and packages” folder). This shows an extra layer of modularity.

##### Architectural Patterns & Design Principles
- Modularity: Each lecture is self-contained. This emphasizes separation of concerns where each lecture focuses on a specific topic.
- Reusability: The presence of Python modules and sub-packages (as seen in Q2 Lecture 1) suggests a design that promotes code reuse and extensibility.
- Integration with Cloud-based Interactive Tools: The repository is cloud-friendly (Binder, Colab), emphasizing the interactive, run-anywhere paradigm common in educational code examples.

##### Technologies, Frameworks, or Libraries
- Python and Jupyter Notebook: The main platform for delivering the code examples.
- Packages like NumPy and possibly plotting libraries (as inferred from the “plotting” folder) for data analysis and visualization.
- External deployment tools: Binder and Google Colab.
- Standard data formats: CSV and NPY files for data interchange.

##### What
- Component Descriptions: Inside each labeled block, note the key content (e.g., “Introduction and Basic Programming”, “Nonlinear systems”, “Finite Difference Methods”, “Optimization”, “Regression”).
- Lecture folders versus utility modules (like the “plotting” package).
- Data resources (CSV, NPY files) versus code resources (Jupyter notebooks, Python modules).

##### Additional Notes
- Reusable or shared components across lectures (for example, the Python utility functions and the plotting package in Q2 Lecture 1).

## Diagram (Mermaid)

```mermaid
flowchart TD
    RepositoryRoot["Repository Root\n(Contains lectures, .gitignore, LICENSE, README.md, requirements.txt)"]:::root

    subgraph "Q1 Lectures"
        Q1_1["q1_lecture_1\n(Variables, Datatypes, Loops, Functions, Numpy basics & Plotting)"]:::lecture
        Q1_2["q1_lecture_2\n(Nonlinear Equations, Taylor Approximation)"]:::lecture
        Q1_3["q1_lecture_3\n(Linear & Nonlinear Systems)"]:::lecture
        Q1_4["q1_lecture_4\n(Numerical Integration/Differentiation)"]:::lecture
        Q1_5["q1_lecture_5\n(Differential Equations & Numerical Solutions)"]:::lecture
        Q1_6["q1_lecture_6\n(Finite Difference Methods)"]:::lecture
        Q1_7["q1_lecture_7\n(Boundary Value Problems & Optimization)"]:::lecture
    end

    subgraph "Q2 Lectures"
        subgraph "q2_lecture_1"
            Q2_1["q2_lecture_1\n(Advanced Programming & Modular Coding)"]:::lecture
            subgraph "Managing Modules and Packages"
                Q2_1_Modules["00_managing_modules_and_packages.ipynb"]:::lecture
                Q2_1_mathutils["math_utils.py"]:::module
                subgraph "Plotting Package"
                    Q2_1_plot_init["__init__.py"]:::module
                    Q2_1_plot_linear["linear.py"]:::module
                    Q2_1_plot_quadratic["quadratic.py"]:::module
                end
            end
            Q2_1_Additionals["Additional Notebooks\n(OOP, Exceptions, Unit Testing)"]:::lecture
        end
        Q2_2["q2_lecture_2\n(Partial Differential Equations)"]:::lecture
        Q2_3["q2_lecture_3\n(Poisson Equation)"]:::lecture
        Q2_4["q2_lecture_4\n(Optimization Methods)"]:::lecture
        Q2_5["q2_lecture_5\n(Linear & Mixed Integer Programming)"]:::lecture
        Q2_6["q2_lecture_6\n(Regression & Interpolation)"]:::lecture
    end

    Q1_4_Data["cdf_data.csv"]:::data
    Q2_6_Data["measurements.npy"]:::data

    Binder["Binder\n(Cloud-based Execution)"]:::external
    Colab["Google Colab\n(Cloud-based Execution)"]:::external

    %% Connections from Repository Root to Lecture Series
    RepositoryRoot --> Q1_1
    RepositoryRoot --> Q2_1

    %% Sequential learning flow for Q1 Lectures (vertical ordering)
    Q1_1 --> Q1_2
    Q1_2 --> Q1_3
    Q1_3 --> Q1_4
    Q1_4 --> Q1_5
    Q1_5 --> Q1_6
    Q1_6 --> Q1_7

    %% Data dependency in Q1 Lecture 4
    Q1_4 -->|"data"| Q1_4_Data

    %% Sequential flow for Q2 Lectures
    Q2_1 --> Q2_2
    Q2_2 --> Q2_3
    Q2_3 --> Q2_4
    Q2_4 --> Q2_5
    Q2_5 --> Q2_6

    %% Data dependency in Q2 Lecture 6
    Q2_6 -->|"data"| Q2_6_Data

    %% Relationship within q2_lecture_1 managing modules
    Q2_1 --> Q2_1_Modules
    Q2_1 --> Q2_1_Additionals
    Q2_1_Modules --> Q2_1_mathutils
    Q2_1_Modules -->|"includes"| Q2_1_plot_init
    Q2_1_Modules -->|"includes"| Q2_1_plot_linear
    Q2_1_Modules -->|"includes"| Q2_1_plot_quadratic

    %% External execution environment relationship
    RepositoryRoot -->|"executes notebooks on"| Binder
    RepositoryRoot -->|"executes notebooks on"| Colab

    %% Click Events for Repository and Lecture Directories
    click RepositoryRoot "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/."

    click Q1_1 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_1/"
    click Q1_2 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_2/"
    click Q1_3 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_3/"
    click Q1_4 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_4/"
    click Q1_5 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_5/"
    click Q1_6 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_6/"
    click Q1_7 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q1_lecture_7/"

    click Q2_1 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q2_lecture_1/"
    click Q2_2 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q2_lecture_2/"
    click Q2_3 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q2_lecture_3/"
    click Q2_4 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q2_lecture_4/"
    click Q2_5 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q2_lecture_5/"
    click Q2_6 "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/tree/main/q2_lecture_6/"

    click Q2_1_Modules "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q2_lecture_1/00_managing_modules_and_packages/00_managing_modules_and_packages.ipynb"
    click Q2_1_mathutils "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q2_lecture_1/00_managing_modules_and_packages/math_utils.py"
    click Q2_1_plot_init "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q2_lecture_1/00_managing_modules_and_packages/plotting/__init__.py"
    click Q2_1_plot_linear "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q2_lecture_1/00_managing_modules_and_packages/plotting/linear.py"
    click Q2_1_plot_quadratic "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q2_lecture_1/00_managing_modules_and_packages/plotting/quadratic.py"

    click Q1_4_Data "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q1_lecture_4/cdf_data.csv"
    click Q2_6_Data "https://github.com/process-intelligence-research/computational_practicum_lecture_coding/blob/main/q2_lecture_6/measurements.npy"

    %% Styles
    classDef root fill:#BDD7EE,stroke:#1F4E79,stroke-width:2px;
    classDef lecture fill:#FCE4D6,stroke:#953735,stroke-width:2px;
    classDef module fill:#D9E1F2,stroke:#1F4E79,stroke-width:2px;
    classDef data fill:#D9EAD3,stroke:#38761D,stroke-width:2px;
    classDef external fill:#FFF2CC,stroke:#BF9000,stroke-width:2px;
```
