How process-intelligence-research/ai-in-bio-chemical-engineering-lecture-coding works
Below are step-by-step guidelines tailored to this project:
Project Type and Purpose
• Since this is a teaching repository, it’s not a typical full-stack application but rather a collection of independent, modular code examples.
Analyzing the File Structure
• At the top level, you have global files (e.g., .gitignore, LICENSE, README.md, requirements.txt) that indicate configuration, documentation, and dependency management.
• Each lecture (Lecture 1 through Lecture 7) is contained in its own directory. Notice that each contains its unique notebook files (.ipynb) and sometimes additional resources (e.g., Lecture 4 includes a .pth model file and extra documentation).
• This modular structure tells us that each lecture can be thought of as an independent component with its associated examples and resources.
Additional Insights from the README
• The README clearly outlines the purpose of each lecture and instructs users on how to run notebooks online via Google Colab, which suggests external integration.
• The “Run code online” instructions indicate that the system is designed to be interactive and accessible, hinting at a process where the notebook serves as both documentation and executable example.
a. Main Components:
• Global Repository Root: Display global files (LICENSE, README.md, requirements.txt) that define the overall project configuration.
• Lecture Modules: Each folder (Lecture 1, Lecture 2, etc.) becomes a component. Within these, sub-components can be the individual notebooks (e.g., Lecture1_examples.ipynb) and any additional resource files (e.g., Lecture4_PINN.ipynb, CS1_Physical_inputs_ANN.pth).
• External Tools/Platforms: Mark an “External Execution Environment” such as Google Colab, which is leveraged to run these notebooks.
• Documentation/Contact: Represent the repository’s documentation and contact information as support or peripheral components.
b. Relationships and Interactions:
• That the Global Repository Metadata (e.g., requirements.txt) is a shared dependency for all lecture modules.
• Optionally, indicate modular isolation: each lecture is self-contained and independent, implying minimal inter-module communication.
c. Architectural Patterns and Design Principles:
• Modular Decomposition: Each lecture is an independent module, which is the primary structural design.
• Separation of Concerns: Global configuration files are separated from the educational content (i.e., the notebooks).
• Extensibility: New lectures can be added into the same structural hierarchy without impacting existing modules.
d. Technologies, Frameworks, and Libraries:
• Python and Jupyter Notebook as the primary coding environment.
• Google Colab for cloud execution.
• Specific libraries might be deduced from requirements.txt (if expanded), but note that the use of pre-trained model files (e.g., .pth in Lecture 4) suggests deep learning frameworks like PyTorch.
• The README badges and logos indicate integration with GitHub as well, supporting open-source practices and community sharing.