User guide

Welcome to the GL02_TriCode user guide!

This guide will help you install and use the GL02_TriCode software to manage and analyze classroom and course scheduling data.

Table of Contents

1. Installation and Requirements
2. How to Use the Software
   • EF0: Get Classrooms for a Course
   • EF1: Get Classroom Capacity
   • EF2: Get Available Timeslots
   • EF3: Get Free Classrooms
   • EF4: Generate Timetable (ICS File)
   • EF5: Rank Classrooms by Occupancy
   • EF6: Rank Classrooms by Capacity

Installation and requirement

• Recent LTS version of Node.js
• npm package management tool

Before using this software, you must install all dependencies using the following command:

npm install

You can then access the software documentation with:

node ./caporalCli.js --help

Software use

You can execute this software in command line. Here are all the useful commands that you could need and how to use them. If there is an error in your command, you will reveive a message explaining why it didn't work, what error you could have made.

EF0

Description: For a given course, gets all the associated classrooms and for which course type it is used (lecture, tutorial, lab work).

Required arguments:

• File path to search in
• Course ID to search for

Example:

node ./caporalCli.js get-classroom ./sample.cru +AP03

EF1

Description: For a given classroom, gets its capacity.

Required arguments:

• File path to search in
• Classroom ID to search for

Example:

node ./caporalCli.js get-capacity ./sample.cru B103

EF2

Description: For a given classroom, gets all available timeslots.

Required arguments:

• Classroom id to search for in all CRU files

Example:

node ./caporalCli.js get-slots B101

EF3

Description: For a given timeslot, gets all available classrooms for this week.

Required arguments:

• Timeslot given as DAY HH:MM

Example:

node ./caporalCli.js get-free-classrooms sample.cru J 12:00

EF4

Description: For given period, creates an ICS file to be used as a timetable.

Required arguments:

• Start date as YYYY-MM-DD (minimum date: 2024-01-01)
• End date as YYYY-MM-DD (maximum date: 2025-12-31)
• Between 1 and 6 course IDs
• [Optional]: Valid file path to create the file in. The file will be created in the current directory if no file path is provided.

Example:

node ./caporalCli.js get-calendar 2024-12-06 2024-12-20 +NF16 +GL02 +PO03

EF5

Description: For a given file, displays a list of classrooms ranked by occupancy and generates a visualization of the classrooms occupancy rate.

Required arguments:

• File path to get classrooms from

Example:

node ./caporalCli.js generate-occupancy sample.cru

EF6

Description: For a given file, displays a list of classrooms ranked by capacity and generates a visualization of the classrooms capacity.

Required arguments:

• File path to get classrooms from

Example:

node ./caporalCli.js rank-classrooms sample.cru