University class scheduler Javascript library

The library can be used to build class schedules for higher education institutions. It contains built-in Typescript declarations, so you can effectively use it with Typescript.

Introduction
Installation
Usage
Contributing
License

Introduction

The library is intended to provide the universal abstract interface for building class schedules. The interface should be implementation-agnostic (algorithm / method used for building the actual schedule), and shouldn't impose specific formulation of the class scheduling problem (specific restrictions / recommendations of the desired schedule).

It also provides genetic algorithm implementation of the abstract interface. You can create, use & distribute your own implementations of the interface.

Installation

Library can be installed using NPM package manager. Since library already contains built-in Typescript declarations, you don't need to install any separate type declaration packages.

Follow the following instructions to install the package:

Create a .npmrc file in the root of your project (if not created yet) and add the following line to it:
```
@nikitakemarskiy:registry=https://npm.pkg.github.com
```

Install the library using NPM

npm install @nikitakemarskiy/university-class-scheduler

Usage

The library was is compiled to ES2016-compatible code, so you should be able to use it in any environment which supports ES2016. You can use either CommonJS or ESM.

Abstract interface

First of all, we need to consider Scheduler abstract class, which acts as a main class of the library, used to build class schedules:

abstract class Scheduler {
    constructor(params: SchedulerParams);
    abstract generateSchedule(): Schedule;
}

You can use it to create & distribute your own implementations of the class scheduler. Let's pay attention to the abstract generateSchedule(): Schedule method, and namely to its return type of Schedule class:

class Schedule {
    constructor(assignedScheduleCells: Array<AssignedScheduleCell>);
    getAssignedScheduleCells(filter?: ScheduleCellFilter): Array<AssignedScheduleCell>;
    serializeToJSON(): string;
    static deserializeFromJSON(scheduleSerializedToJSON: string): Schedule;
}

Schedule class is used to encapsulate resulting schedule. It exposes getAssignedScheduleCells(filter?: ScheduleCellFilter): Array<AssignedScheduleCell> method, which returns schedule cells after applying the filters passed. It allows to get only needed part of the schedule, e.g. schedule of the specific group, lecturer etc:

type ScheduleCellFilter = {
    lecturerId?: number;
    groupId?: number;
    roomId?: number;
    online?: boolean;
};

You can import everything related to the abstract interface as follows:

import { Schedule, Scheduler, ScheduleCellFilter } from 'university-class-scheduler';

Library also provides genetic algorithm implementation of the Scheduler abstract class, named GeneticAlgorithmScheduler:

import { GeneticAlgorithmScheduler } from 'university-class-scheduler/schedulers/genetic-algorithm';

It exposes extended constructor, which includes discipline classes assigned (to lecturers and groups) and genetic algorithm parameters:

type DisciplineClassAssigned = {
    disciplineClassId: number;
    lecturerIds: Array<number>;
    groupIds: Array<number>;
    assignedScheduleCellsPerCycle: number;
    facultyId?: number;
    facultyDepartmentId?: number;
} & ({
    online: false;
    appropriateRoomTypeIds: Array<number>;
} | {
    online: true;
});

type GeneticAlgorithmParams = {
    populationSize: number;
    eliteIndividualsCount: number;
    crossoverIndividualsFraction: number;
    geneMutationProbability: number;
    maxIterations: number;
};

class GeneticAlgorithmScheduler extends Scheduler {
    constructor(
      params: SchedulerParams & { disciplineClassesAssigned: Array<DisciplineClassAssigned> },
      geneticAlgorithmParams: GeneticAlgorithmParams
    );
    generateSchedule(): Schedule;
}

There is also a repository with usage samples.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE.txt for more information.

NikitaKemarskiy/university-class-scheduler