How masabhuq/faculty_finder_urms works
Main Components
• Data Source: The Excel files (fall_data.xlsx, spring_data.xlsx) in the src/dataset directory. These serve as the raw input data specifying faculty assignments.
• Data Processing Layer: The core components that process Excel files using the Pandas library. This comprises the processing logic found in the scripts (for instance, in src/scripts/course_manager.py) and any code invoked by app.py.
• Application Entry Point: The app.py file which likely glues together the processing routines and provides an interface (CLI or otherwise) to allow users to input course codes and sections during preregistration.
• Interactive/Exploratory Environment: The Jupyter notebooks located in src/notebook that may be used for further exploration, testing, or demonstration of the processing logic.
• Project Configuration & Management: Files such as pyproject.toml and the .idea folder indicate dependency management and IDE configuration, which although not part of the runtime architecture, should be mentioned as project scaffolding.
Relationships and Interactions Between Components
• Data Flow starts with the raw Excel files (src/dataset) which are read and processed by the processing logic scripts.
• The processing logic (modules in src/scripts, and possibly helper code inside src/__init__.py) uses Pandas to transform the Excel data into an accessible format.
• The app.py file serves as the orchestrator, receiving user input (for section or course code) and invoking the correct routines to look up faculty information.
• The notebooks in src/notebook likely serve as an interactive demonstration of these components or test/experiment on the data processing routines.
Architectural Patterns and Design Principles
• Although this project is relatively small-scale, it demonstrates a separation of concerns:
• Data Input (Excel files under src/dataset),
• Data Processing (scripts handling the business logic in src/scripts),
• Application Logic (the main runner in app.py), and
• Experimentation/Development (Jupyter notebooks in src/notebook).
• This modular structure allows for flexibility: processing logic is decoupled from the application entry point, and both are separated from the raw data.