Skip to content

Latest commit

 

History

History
494 lines (331 loc) · 10.5 KB

File metadata and controls

494 lines (331 loc) · 10.5 KB

iGrad - User Guide

1. Introduction

Sick of having tracking your university progress the manual way? Start getting rid of your Excel sheets and scribbled down notes and download iGrad right now!

What is iGrad?

iGrad is the app to track your university progress, for students who are frustrated with the limited features the university provides, by students who are frustrated by the limited features the university provides.

iGrad offers users the ability to create custom courses and graduation requirements, ensuring the maximum degree of flexibility when planning and keeping track of your progress

iGrad also retrieves data directly from NUS Mods, ensuring that module information is always up to date.

iGrad calculates your CAP at every step, ensuring you never have to use a CAP calculator again

Finally, the iGrad team is always open to feedback and suggestions from the public will always be followed up on.

2. Features

2.1. Course Builder

iGrad was built with every NUS student in mind. Our custom course builder allows you to build the course of your dreams.

2.2. Modular Credits (MCs) Tracker

We are sick of counting our MCs at the beginning of every semester too. Easily see how many MCs you have left in order to apply for graduation.

2.3. Cumulative Average Point (CAP) Tracker

No more googling CAP calculators. iGrad’s CAP tracker keeps track of your CAP at every step and even offers predictive services so you know how well you have to do in order to achieve your dream Cumulative Point Average (CAP).

3. Components

75425925 9774ff80 597e 11ea 87f5 228f95b5c84f

3.1. Courses

A course is simply a group of requirements. It is also how we keep track of your overall CAP and MCs.

3.2. Requirements

A requirement consists of at least one module. Fulfill all modules within a requirement to complete it.

3.3. Modules

A module is the building block of all other components. Mark your modules as done and give it a grade. You can also add optional memos to help you remember why you took the module.

4. Walkthrough

4.1. Start up the application

4.2. Enter your course details

4.3. Key in your graduation requirements

4.4. Assign your modules

4.5. Mark a module as done

4.6. Key in a memo

4.7. Track your MCs

4.8. View your CAP

4.9. Export your data

5. Command List

5.1. help

Displays a help message to the user. Lists all possible commands and provides a link to the user guide online.

Command Format

help
⚠️
Constraints

NIL

💡
Expected Outcome

A help message should be displayed


5.2. course

Add, modify or remove your course.

Command Format

course add n/COURSE_NAME

course modify COURSE_NAME: [n/COURSE_NAME] [u/MCs]

course remove n/COURSE_NAME

Command Sample

/*
 * Creating a course named "Computer Science"
 */
course add n/Computer Science


/*
 * Renaming your current course to "Information Systems"
 */
course modify Computer Science: n/Information Systems

/*
 * Removing your current course
 */
course remove

Constraints

  1. (all): You can only have at most one course at any one time

  2. course remove: Removing a course removes all data from the system (including modules, requirements, etc)

Expected Outcome

ℹ️
You should be able to see the added and/or modified course title in the top panel. For remove course, all data would be reset

5.3. requirement

Add, modify or remove a graduation requirement category (under a course).

Command Format

1. requirement add n/REQUIREMENT_NAME: u/NO_OF_MCS


/*
 * At least one option must be specified.
 */
2. requirement modify n/REQUIREMENT_NAME: [n/REQUIREMENT_NAME] [u/NO_OF_MCS]


3. requirement remove n/REQUIREMENT_NAME

Command Sample

/*
 * Adding a requirement named "Unrestricted Electives" which
 * requires 32 MCs to fulfill
 */
requirement add n/Unrestricted Electives: u/32


/*
 * Renaming a requirement named "Unrestricted Electives" to "Math and Sciences", and
 * changing the number of MCs to 20 (to fulfill)
 */
requirement modify n/Unrestricted Electives: n/Math and Sciences u/32


/*
 * Removing a requirement named "Unrestricted Electives"
 */
requirement remove n/Unrestricted Electives

Constraints

⚠️
  1. (all): Requirement names have to be unique

  2. (all): The number of MCs under all requirements have to be in total equals (strictly) to number of MCs for your course

Expected Outcome

ℹ️
You should be able to see the created and/or modified requirement details reflected in the main panel

5.4. assign

Assigns (and creates) a module under a graduation requirement category.

Command Format

1. assign n/REQUIREMENT_NAME: n/MODULE_CODE, t/MODULE_TITLE u/MCs; ...

Command Sample

/**
* Assigns (and creates) a module "LAJ1201" (4 MCs) and another module "CS1101S" (4 MCs) to the requirement "Unrestricted Electives"
*/
assign n/Unrestricted Electives: n/LAJ1201 u/4, n/CS1101S u/4

Constraints

⚠️
  1. A module cannot be assigned if there are not enough MCs left under a graduation requirement (category).

  2. The module code (e.g, CS1101S, ST2334), have to be unique

Expected Outcome

ℹ️
You should be able to see the newly assigned module(s) displayed in the main panel, under their respective requirement categories. main panel

5.5. module

Modify or remove a module. You would be able to tag (modify) a module with information such as; semester, grade or memo notes information.

Command Format

/*
 * SEMESTER is specified in format Y_S_ ( e.g. Y1S2 - Year 1 Semester 2 )
 */


/*
 * At least one option must be specified.
 */
1. module modify n/MODULE_CODE: [n/MODULE_CODE] [n/MODULE_TITLE] [u/MCs] [s/SEMESTER] [g/GRADE] [m/MEMO_NOTES]


2. module remove n/[MODULE_CODE]

Command Sample

/*
 * Tagging the module, CS1101, with "Y1S2" and grade "A+", and also renaming it to CS1101S
 */
module modify n/CS1101: n/CS1101S s/Y1S2 g/A+


/*
 * Tagging the module, ST2234, with "Y2S1" and giving it a memo "pretty easy module"
*/
module modify n/ST2334: s/Y2S1 m/pretty easy module


/*
 * Removing a module named "CS1101S"
 */
module remove n/CS1101S

Constraints

⚠️
  1. (module modify) There must be enough MCs left under a graduation requirement (category) for all modules.

  2. (all) The module code (e.g, CS1101S, ST2334), have to be unique

Expected Outcome

ℹ️
You should be able to see the modified module details reflected in the main panel

5.6. exam

View your examination results.

Command Format

/**
* SEMESTER is optional.
* If not specified, displays results for all semesters.
*/
exam s/SEMESTER

Command Sample

/**
* Displays exam results for Year 3 Semester 2
*/
exam s/Y3S2

Constraints

⚠️

-Nill

Expected Outcome

ℹ️
You should be able to view your exam results (in a pop-up)

5.7. achieve

Calculates the average grade needed to achieve the CAP you desire/

Command Format

1. achieve c/DESIRED_CAP

Command Sample

/**
* Calculates the avergae grade needed
* to achieve a CAP of 4.50
*/
achieve c/4.50

Constraints

⚠️

-Nill

Expected Outcome

ℹ️
You should be able to view the average grade needed to achieve the CAP you desire (in a pop-up)

5.8. export

Exports all data in a (prettified) text file. If information is sufficient, this file can be submitted to NUS as a study plan.

Command Format

1. export

Constraints

⚠️

-Nill

Expected Outcome

ℹ️
A text file "study_plan.txt" should be generated in the same folder as the iGrad application.

5.9. exit

Exits the program

Command Format

exit

Constraints

⚠️

-Nill

Expected Outcome

ℹ️
The application should exit

6. FAQs

I’m not an NUS student. Can I still use iGrad?

As long as your university follows a similar hierachical structure! However, we will be unable to provide features such as validation from NUSMods.

7. Cheat Sheet

This segment contains all the commands detailed in this guide in a consolidated list

help

course add n/COURSE_NAME

course modify: [n/COURSE_NAME] [u/MCs]

course remove n/COURSE_NAME

requirement add n/REQUIREMENT_NAME: u/NO_OF_MCS

requirement modify n/REQUIREMENT_NAME: [n/REQUIREMENT_NAME] [u/NO_OF_MCS]

requirement remove n/REQUIREMENT_NAME

module add n/MODULE_CODE [n/MODULE_TITLE] [n/DESCRIPTION]

module modify MODULE_CODE: [n/MODULE_CODE] [n/MODULE_TITLE] [u/MCs] [s/SEMESTER] [g/GRADE] [m/MEMO_NOTES]

module remove n/[MODULE_CODE]

assign REQUIREMENT_NAME: n/MODULE_CODE

exam s/SEMESTER

achieve c/DESIRED_CAP

export

exit

8. Glossary

Course

A course is the entire programme of studies required to complete a university degree

Graduation requirement

Requirements specified by the university in order for a student to graduate

Module

Each module of study has a unique module code consisting of a two- or three-letter prefix that generally denotes the discipline, and four digits, the first of which indicates the level of the module

Cumulative Average Point (CAP)

The Cumulative Average Point (CAP) is the weighted average grade point of the letter grades of all the modules taken by the students.

Semester

A semester is a part of the academic year. Each semester typically lasts 13 weeks in NUS.

Modular Credits (MCs)

A modular credit (MC) is a unit of the effort, stated in terms of time, expected of a typical student in managing his/her workload.

NUS Mods

A timetabling application built for NUS students, by NUS students. Much like this iGrad!

Handy Links