How process-intelligence-research/computational_practicum_lecture_coding works
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).