Introduction

SEPlanner is a lightweight desktop application for Computer Engineering undergraduates to plan for the Student Exchange Programme, optimised for use via Command Line Interface (CLI).

Content Page

Quick Start

  1. Ensure that you have Java 11 or above installed.
  2. Download the latest version of SEPlanner from here.
  3. Copy the file to the folder you want to use as the home folder for your SEPlanner.
  4. In your preferred command line interface, navigate to that directory.
  5. Enter the command java -jar tp.jar.
  6. If you can see the graphic below, congrats! You are ready to start using SEPlanner 
                                                        /(#######################(*
                                              /(#(((((((((((###############(((((((.
                                          (#((((((###((######################(((((((/
                                         /#(((((((((((((((((#################((((((((((((,
                                       (#((((((((((((((#########################(((((((((((*
                                     /(((((((((((((((##########################((((######((((.
                                    #(((((((((((((##############################((##(((#####((/
                                  .##((((((#(((#################################((((((((((((((((
                                   ###(((######(#################################(((((((((((((((((
                                 (###(((#######################################(((((((((((((((((#,
                                .######((((####################################(((((((((((((((((((
                                *#########((###################################(#(((((((((((((((((
                                /##########(((((((((#############################(((((((((((((((((
                                *############(((((((((((####################################((((((
                                 ###########((((((((((((((((###############################(#(((#(
                                 (##########((((((((((((((((((((#############################((((.
                                  ###########(#((((((((((((((((((((((#######################(((#/
                                   ############(#((((((((((((((((((########################(#((/
                                    (############(((((((((((((((((########################(#((,
                                     .############(#(((((((((((((#########################(((
                                       ,##########(#((((((((((###########################((
                                          ##########((((((((############################/
                                            .########(((#############################(
                                                *####((###########################.
                                                     ,##(###################(

    d888888o.   8 8888888888   8 888888888o   8 8888                  .8.          b.             8 b.             8 8 8888888888   8 888888888o.
  .`8888:' `88. 8 8888         8 8888    `88. 8 8888                 .888.         888o.          8 888o.          8 8 8888         8 8888    `88.
  8.`8888.   Y8 8 8888         8 8888     `88 8 8888                :88888.        Y88888o.       8 Y88888o.       8 8 8888         8 8888     `88
  `8.`8888.     8 8888         8 8888     ,88 8 8888               . `88888.       .`Y888888o.    8 .`Y888888o.    8 8 8888         8 8888     ,88
   `8.`8888.    8 888888888888 8 8888.   ,88' 8 8888              .8. `88888.      8o. `Y888888o. 8 8o. `Y888888o. 8 8 888888888888 8 8888.   ,88'
    `8.`8888.   8 8888         8 888888888P'  8 8888             .8`8. `88888.     8`Y8o. `Y88888o8 8`Y8o. `Y88888o8 8 8888         8 888888888P'
     `8.`8888.  8 8888         8 8888         8 8888            .8' `8. `88888.    8   `Y8o. `Y8888 8   `Y8o. `Y8888 8 8888         8 8888`8b
 8b   `8.`8888. 8 8888         8 8888         8 8888           .8'   `8. `88888.   8      `Y8o. `Y8 8      `Y8o. `Y8 8 8888         8 8888 `8b.
 `8b.  ;8.`8888 8 8888         8 8888         8 8888          .888888888. `88888.  8         `Y8o.` 8         `Y8o.` 8 8888         8 8888   `8b.
  `Y8888P ,88P' 8 888888888888 8 8888         8 888888888888 .8'       `8. `88888. 8            `Yo 8            `Yo 8 888888888888 8 8888     `88.

Program run through

This SEPlanner allows the user to search for mapping through our platform. To do so, users can follow the following steps:

  1. Add partner universities the user is interested in.
  2. Add potential NUS modules that the user wants to add.
  3. Search for potential mapping for a particular selected university.
  4. Select a mapping and add the mapping.

:information_source: Information about this guide:

:bulb: Tip: Tips give helpful information to make your experience better.
:exclamation: Caution: Warnings caution you about certain actions that might be dangerous.

:information_source: Note: Notes are important pieces of information.

Features

Viewing all available universities:

Displays all modules from the master list of universities that the user can choose from.

Format: list /muni

Example of usage:

  • Input: list /muni
    Expected output: 
    Here are the universities and module mappings in the list:  
[1] - Aarhus School of Business  
[2] - Aarhus University  
[3] - Arizona State University  
...  
[78] - Uppsala University  
[79] - Waseda University  
[80] - Western University

Viewing all selected universities:

Displays all universities added, as well as all module mappings added to the university by the user.

Format: list /suni

  • Example 1
    Input: list /suni
    Expected output: 
    Here are the universities and module mappings in your list:
[40] - Technical University of Munich
  1 | IE4056 - WI001098 : Introduction to Production Scheduling Theory
[80] - Western University

Viewing all available modules:

Displays all modules from the master list of modules that the user can choose from.

Format: list /mmod

  • Example 1
    Input: list /mmod
    Expected output: 
    Here are the modules in the list:  
[1] ACC1701X : Accounting for Decision Makers  
[2] ACC2706 : Managerial Accounting  
[3] AR2102 : Design 4  
...  
[803] TR3008 : Technological Innovation  
[804] UD5221 : Urban Design Theory and Disco  
[805] UD5628 : Critique of Contemporary Urban Design

Viewing all selected modules

Displays all modules from the master list of modules that the user can choose from.

Format: list /smod

  • Example 1
    Input: list /smod
    Expected output: 
    Here are the modules in the list:
[102] CS3220   : Computer Architecture
[319] IE4044   : Exchange Elective
[801] ST4991   : Exchange Enrichment Module
[77] CS1010   : Programming Methodology
[72] CM4271   : MEDICINAL CHEMISTRY
[47] CM1417   : Fundamentals of Chemistry

Adding a partner university

Add a partner university the user is interested into the user selected university list.

Format: add /uni <UNIVERSITY_INDEX> add /uni <UNIVERSITY_NAME

:bulb: Tip: This command accepts either the <UNIVERSITY_INDEX> or <UNIVERSITY_NAME> as arguments. The <UNIVERSITY_INDEX> can be found via list /muni command.
  • Example 1
    Input: add /uni 24
    Expected output: 
    New university added: 
[24] - Korea Advanced Inst of Sci & Tech
  • Example 2
    Input: add /uni University of California
    Expected output: 
    New university added: 
[59] - University of California

Adding a NUS module

Add a NUS module that the user wants to complete during SEP into the user selected module list.

Format: add /mod <MODULE_INDEX> add /mod <MODULE_CODE>

This command accepts either the <MODULE_INDEX> or <MODULE_CODE> as arguments. The <MODULE_INDEX> can be found via list /mmod command.

  • Example 1: using index
    Input: add /mod 77
    Expected output: 
    New module added: 
[77] CS1010   : Programming Methodology
  • Example 2: using module code
    Input: add /mod CS1010
    Expected output: 
    New module added: 
[77] CS1010   : Programming Methodology

Adding a module mapping

Adds a specific pair of module mapping under a selected university.

####Format: add /map <UNIVERSITY_INDEX> <MODULE_MAPPING_INDEX>

:bulb: Tip: The <UNIVERSITY_INDEX> can be found via list /sunicommand and the <MODULE_MAPPING_INDEX> can be found via searchmap <UNIVERSITY_INDEX> command for the specific university.
  • Example 1
    Input: add /map 4 2
    Expected output: 
    The following module mapping has been added under:
[4] Boston University
CS1231 - MET CS 248 : Discrete Mathematics
CS1231 - CAS CS131 : Combinatoric Structures

Finding a specific university

Look for universities that matches the user entered keyword.

  • The output also consists of the index of the university, which is needed for subsequent commands.
    ####Format: find /uni <KEYWORD>
  • Example 1
    Input: find /uni California
    Expected output: 
    [59] - University of California
[60] - University of California, Berkeley
[61] - University of California, Davis
[62] - University of California, Irvine
[63] - University of California, Los Angeles
[64] - University of California, Merced
[65] - University of California, Riverside
[66] - University of California, San Diego
[67] - University of California, Santa Barbara
[68] - University of California, Santa Cruz

Finding a specific module

Look for modules that matches the user entered keyword.

  • The output also consists of the index of the module, which is needed for subsequent commands.

    Format: find /mod <KEYWORD>

  • Example 1
    Input: find /mod CS1010
    Expected output: 
    [77] CS1010   : Programming Methodology
[78] CS1010E  : Programming Methodology
[79] CS1010J  : Programming Methodology
[80] CS1010S  : Programming Methodology

Searching for available module mappings:

Displays all available module mappings for a specific university that matches the list of selected modules.

Mappings here are labeled with a mapping index, which will be used for add /map and remove /map commands.

Format: searchmap <UNIVERSITY_INDEX>

  • Example 1
    Input: searchmap 4
    Expected Output: 
    Potential mappings for Boston University:
[1] CS1231 - MET CS 248 : Discrete Mathematics
[2] CS1231 - CAS CS131 : Combinatoric Structures

Removing a selected university

Remove a partner university from the user selected university list.

Format: remove /uni <UNIVERSITY_INDEX> remove /uni <UNIVERSITY_NAME

  • Example 1: using index
    Input: remove /uni 4
    Expected output: 
    This university is removed: 
[4] - Boston University
  • Example 2: using university name
    Input: remove /uni Boston University
    Expected output: 
    This university is removed: 
[4] - Boston University

Removing a selected NUS module

Removes a module from the user selected module list.

Format: remove /mod <MODULE_CODE> remove /mod <MODULE_INDEX>

  • Example 1: using module index
    Input: remove /mod 81
    Expected output: 
    The following module has been removed: 
[81] CS1231 : Discrete Structures
  • Example 2: using module code
    Input: remove /mod CS1231
    Expected output: 
    The following module has been removed: 
[81] CS1231 : Discrete Structures

Removing a selected module mapping

Removes a module mapping under a selected university.

Format: remove /map <UNIVERSITY_INDEX> <MAPPING_INDEX>

  • Example 1
    Input: remove /map 4 2
    Expected output: 
    The following module mapping has been removed:
[4] Boston University
CS1231 - CAS CS131 : Combinatoric Structures

FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder.

:exclamation: Caution: Do not delete the /data directory or any of its files as this will cause you to lose your saved information!

Q: How do I save my selected universities and modules?
A: All your universities, modules and module mappings are automatically saved at each command and will be auto-loaded on program start.

Command Summary

Command Format Purpose
add add /uni <UNI_INDEX> add /mod <MOD_INDEX> add /map <UNI_INDEX> <MAP_INDEX> Add a university/module/mapping
remove remove /uni <UNI_INDEX> remove /mod <MOD_INDEX> remove /map <UNI_INDEX> <MAP_INDEX> Remove a university/module/mapping
list list /muni list /mmod list /suni list /smod List master/selected university list or module list
searchmap searchmap <UNI_INDEX> Search for potential mappings for the selected university
find find /uni <KEYWORD> find /mod <KEYWORD> Find the possible university or module
exit exit Exit the application

Glossary

  1. UNI_INDEX - The unique identifier corresponding to a particular university.
  2. MOD_INDEX - The unique identifier corresponding to a particular module.
  3. MAPPING_INDEX - The identifier corresponding to a particular module mapping withing a university. Note: this value changes accordingly with the module selected list.
  4. university selected list - The list of universities selected by you.
  5. module selected list - The list of modules selected by you.