Quick Start

University Curriculum Enabling Tool

University Curriculum Enabling Tool is an advanced application leveraging fine-tuned Language Models and Retrieval Augmented Generation (RAG) technology to support diverse academic needs:

• Curriculum Builder: Designed for faculty, this tool streamlines the creation and refinement of course content, enabling the development of tailored curricula and continuous improvement of teaching materials.
• Expert Advisor: Lecturers can customize and enhance their teaching resources, generate assignments, quizzes, and research prompts, and access tools to support effective course delivery.
• Learning Companion: Students benefit from personalized learning experiences, including practice quizzes, material summarization, and interactive note-taking, both within and beyond the content provided by lecturers.

Powered by Intel CPUs and GPUs, the tool ensures accurate, contextually relevant responses, making it a valuable asset for curriculum development, teaching, and student learning.

System Requirements

Software Requirements

• Operating System:

Type	Version
Linux	Ubuntu 24.04 Desktop LTS
Windows	Windows 11

Hardware Requirements

• CPU: Intel® Core™ Ultra Processor (Products formerly Meteor Lake-UH) and above
• RAM: Minimum: 32GB, Recommended: 64GB
• Storage: 256GB free space
• GPU: At least one of the following:

Type	Model	Recommended For
Integrated	Intel® Arc™ Graphics	Basic usage
Discrete	Intel® Arc™ A770 Graphics	Enhanced performance

Local Ports Usage

These ports are only used on the local machine (localhost/127.0.0.1) and don't need to be exposed externally.

Port	Service	Required For
8080	Web Interface	Application UI access
8016	Backend	Internal REST API
5950	Ollama Model Serving	LLM inference and embeddings

Disclaimer

Important Notice: This software is currently in pre-production status, designed to run locally on a single system only. For more stable version, please refer to our latest tagged pre-release.

Quick Start Linux

Pre-requisite: Follow the Edge Developer Kit Reference Scripts to install the necessary drivers and compute-related packages for Intel® GPUs

1. Setup - Install system dependencies:

Note: Setup requires administrator privileges as it installs system-level dependencies.

sudo ./setup.sh

1. Install - Install the application from sources to build and package the application. From here, running below will prompt you to enter select either ollama or ovms:

   ./install.sh
   

   However, you can also directly select an AI provider to install via command:
2. OpenVINO Model Server (OVMS)

   PROVIDER=ovms ./install.sh
   

3. Ollama

   PROVIDER=ollama ./install.sh
   

4. Continue Installation - Go to the generated distribution package directory (follow the instruction from previous command):

5. Run - Start the application:

   ./run.sh
   

6. Access - Open the web interface at http://localhost:8080

7. Stop - To stop the application, run:

   ./stop.sh
   

8. Uninstall - To remove the application, run:

   ./uninstall.sh
   

Quick Start Windows

1. System-level setup (Adminstrator required)

# Double click on setup_win.bat and select "Yes"
.\setup_win.bat

This script will perform or install the following if not present and may take a while to complete: - Winget - Python 3.12 (if not not installed or lower version) - Enable PowerShell script execution if needed

1. Install application and its dependencies

# Double click on install_win.bat
.\install_win.bat

This will automatically proceed to installation of application (without administrator privilege) which does the following: - Download and install Node.js locally (22.16.0) - Download and install jq locally - Install npm dependencies - Set up Python virtual environment - Download and configure Ollama - Create environment configuration files

1. Start the application

   # Double-click to run
   .\run_win.bat
   

   Running this command will automatically open a web-browser with http://localhost:8080

2. Stop the application

   # Double click to stop all services
   .\stop_win.bat
   

   IMPORTANT: Please make sure to close all command or terminal prompts that are open after running stop_win.bat

3. Uninstall the application

   # Double click to run uninstall script
   .\uninstall_win.bat
   

Next Steps

The application is now running. Select your persona to get started:

Persona	Intended For	Guide
Curriculum Builder	Faculty	View guide
Expert Advisor	Lecturers	View guide
Learning Companion	Students	View guide

Limitations

1. Startup application on Windows

On Windows, when running run_win.bat, PM2 launches several command prompt windows during operation. These windows can be minimized, but they will remain open. To stop the application, run stop_win.bat and manually close the command prompt windows to properly shut down all services.

1. Running OVMS on Windows

When running any workloads in Windows (e.g. Summary generation), additional command prompts may pop-up repeatingly until the workload has successfully completed.

Troubleshooting

1. Unable to unzip file from Github for Windows

If you have trouble unzipping the downloaded zip file from GitHub on Windows, try extracting it to a folder with a shorter name or path. This issue is caused by Windows' maximum file path length limitation.

Disclaimer

Intel is committed to respecting human rights and avoiding causing or contributing to adverse impacts on human rights. See Intel’s Global Human Rights Principles. Intel’s products and software are intended only to be used in applications that do not cause or contribute to adverse impacts on human rights. Users should comply with all requirements to notify relevant parties that AI was used in the production of materials, as mandated by their employers or professional standards.