Skip to content

Latest commit

 

History

History
77 lines (64 loc) · 3.57 KB

README.md

File metadata and controls

77 lines (64 loc) · 3.57 KB
Raw

Project Title: COMP2811 UI Final Project Coursework

Overview

This application is designed to monitor and analyse water quality data, with a focus on pollutant tracking and compliance with safety standards. It was developed using C++/Qt6 with a modular and user-friendly interface that adapts to changes in locale for basic internationalisation.

Getting Started

Prerequisites

  • C++17 or higher
  • Qt6 libraries, including:
    • QtWidgets
    • QtCharts
    • QtWebView (optional, for web content)

Installation and Setup

  1. Extract the Starter Code:
  • Unzip the provided starter code package to a working directory.

  1. Build the Project:

    • Create a build directory and run cmake: 
      mkdir build && cd build
cmake ..
    • Compile the project: 
      make
    • Run the application: 
      ./[application-executable-name]

  2. Data Setup:

    • Place your CSV dataset in the specified directory (/data folder).
    • Ensure that the application has access to the data file, and adjust file paths as necessary.

Application Structure

Main Components

  • Dashboard: Provides an overview of the application’s main pages and core functionality.
  • Data Page: Displays pollutant data in a table format, allowing us to browse relevant fields. Utilises the model/view architecture from the starter code.
  • Analysis Pages:
    • Pollutant Trends: Visualises changes in pollutant levels over time.
    • Safety Compliance: Displays alerts for pollutant levels that exceed recommended limits.
    • Geographical Hotspots: Provides a map view or heat map of sampling points.
    • Summary Statistics: Calculates and displays averages, maximums, minimums, and other summary data.

Key Features

  • Internationalisation: The app supports language changes based on system locale settings.
  • Modular UI: Using a "card" approach, each data type or control is grouped logically within the interface.
  • Tooltips: Hovering over elements displays additional context, improving usability.

Design Choices

  • Model/View Architecture: Chosen for flexibility in data handling and to separate data presentation from underlying storage.
  • Data Visualisation: Includes basic charts and compliance indicators to ensure intuitive data interpretation.
  • "Card" Layout: The UI is modularised into “cards,” each focused on a specific data group or control area.

Included Files

  • Source Files: Core source files such as main.cpp, dataset.cpp, model.cpp, etc.
  • Consent and Participant Information Sheet (PIS): Blank templates for ethical compliance, as required in evaluations.
  • COMP2811_CW3_Requirements Detailed requirements and expectations for the project.
  • COMP2811 Feedback Fruits Tasks Overview: List of required Feedback Fruits tasks

Known Issues

  • List any known bugs or limitations here. This may include compatibility issues, unsupported data formats, etc.

Future Development

  • Briefly describe potential features, optimisations, or additional datasets that could be integrated in future versions.

Acknowledgments

  • Acknowledge any sources, datasets, or resources that contributed to this project.
  • I would like to thank Nick Efford for all his work on this module.
  • Samson Fabiyi and Danyang Zheng for their input and management of XJCO2811 at SWJTU.

Contact

For questions or collaboration inquiries, contact:

  • [Julian Brooks] - [[email protected]]
  • Module: COMP2811 - User Interfaces - University of Leeds