Skip to content

ROADMAP.md

Latest commit

 

History

History
65 lines (46 loc) · 3.74 KB

ROADMAP.md

File metadata and controls

65 lines (46 loc) · 3.74 KB

Project Summary & Welcome

Welcome to the roadmap for the "Air quality dashboard" project. As part of the "Programming for Data Sciences" course at the University of Bern, groups of four students each work on small projects in the field of data science. This document contains the roadmap for one of these projects, on which students will work in April and May of 2024. It includes information about the functional aspects of the finished product, a guide to getting started with the project, and a timeline for the project.

The data required for the Air quality dashboard will be imported from a CSV file that has been collected by the WHO’s Global Health Observatory. It will be possible for users to explore information about the dataset.

Users will be able to select one or multiple countries as well as a period. The program will then provide the user with information about the maximum values of pm10, pm25, and NO2 in the countries during the selected period.

The program will also provide the users with visualizations about different trends of multiple values which are indicators of air pollution for distinct cities and countries.

How to Get Involved

Before starting to work on the project it is important to read this file as well as the README file of this project. Contributors should also read the file "Group projects" which can be found on Ilias. This file contains the original description of the task.

To work on the project, take a look at the section Milestones and Tasks. Start working on the Milestone which is due next. If all work has already been done for this milestone, start working on the next milestone if possible. It also is always possible to add additional features which are not required by the original description of the project, but which might be interesting for the users of the program.

Timeline

This section contains important dates, tasks, and milestones that will have to be reached to finish the project.

Milestones and Tasks

These are the milestones of the project that are already known as of the time of the writing of this document.

Choose a project + Project management . . . . . . . . . . . . . . . . . . . . . . . . . Deadline: April 25

Tasks:

  1. Submit README, ROADMAP and member.txt file
First deliverable + GitHub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deadline: May 2

Tasks:

  1. Creating git repository
  2. Implement the following functionalities:
  • Importing the Data and creating a dataframe
  • Modify Dataframe, adjust the columns, datatypes ...
  • Creating User-interaction, allowing to get information about the data via terminal.
  1. Adding code-comments
  2. Cleaning code
Second deliverable + Classes + Refactoring . . . . . . . . . . . . . . . . . . . . . Deadline: May 16

Tasks:

  1. Allowing the User to explore the data further:
  • User can get information about maximum, minimum, average, median values of different pollution-metrics.
  • User can select one or more countries, select a timespan and get information about the specific data.
  1. Write more resistant code, catching errors or wrong inputs of the user.
  2. More Documentation
  3. Structure Code, eventually add classes
Third deliverable + Unit tests + Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . Deadline: May 23

 Tasks:

  1. Providing Visualizations about the selected data.
  2. Add Unit test
  3. Fix bugs
  4. Refractor and clean Code a final time
  5. Additional Goal if possible: GUI with better User-Interaction than via terminal
Virtual environment + In-person Presentation. . . . . . . . . . . . . . . . . . . . Deadline: May 30

 Tasks:  1. Complete virtual environment steps  2. Gather information for presentation  3. Create and practice presentation  4. Hold presentation