seq-tool 0.0.1

A Python package implementing the Generalized Sequential Pattern (GSP) algorithm with concurrency support.

seq_tool

The seq_tool is a Python package that implements the Generalized Sequential Pattern (GSP) algorithm. Originally developed as part of the Course Sequencing Analysis Tool (CSAT) to analyze and sequence student course data, the toolkit has been extended to support more generalized use cases. It is designed for applications where analyzing sequential patterns is essential, such as course sequencing or other data patterns.

The package supports grouping items based on a specified granularity using concurrency and provides both a command-line interface (CLI) and a graphical user interface (GUI).

Features

• GSP Algorithm: Analyze sequential patterns using the Generalized Sequential Pattern (GSP) algorithm.
• Granularity-Based Grouping: Use concurrency to group items by a specified time granularity, such as semesters (quarters) or months.
• Command-Line Interface: Run the GSP algorithm from the terminal for efficient scripting and automation.
• Graphical User Interface: Easily configure and run the algorithm using an interactive graphical interface.

Installation

Install via command-line from PyPi:

python3 -m pip install seq-tool

Usage

Command-Line Interface

You can run the GSP algorithm using the CLI. Here’s an example:

seq-cli -i data.csv -s 50,100 -c BIO,CHEM --mode separate -o results --concurrency

For more detailed instructions and examples, please refer to the cSAT Manual.

Graphical User Interface

Launch the GUI for an easy-to-use interface:

seq-gui

The GUI allows you to:

• Load your data file.
• Set support thresholds and categories.
• Group items based on granularity (e.g., semester or month).

Requirements

• Python 3.10 or later
• Dependencies are automatically installed when you run python3 -m pip install seq-tool.

Data Requirements

To understand the required data format, refer to the Data Dictionary.

Example Datasets

Example datasets for testing and exploring the cSAT are available here on Google Drive.

Development Roadmap

• Current: Working on testing and validation on the general case for sequential pattern analysis. Determining how to include the time (span?) to better understand the output.
• Future: Finalize packaging and prepare the toolkit for distribution on PyPi (Python Package Index). Additionally, explore ways to optimize the GSP algorithm, such as implementing parallel execution, to improve performance for large datasets.

License

This project is licensed under the MIT License - see the LICENSE file for details.