ASWI - Pokročilé softwarové inženýrství » ASWI 2021 » OpenData vlastní téma (KIV) - Tři Mušketýři

h1. Product Vision Statement (WIP)

h2. Project Goals

Creating an application that will based on weather input, predict the attendance in class. User will be able to input their own weather information or choose a prediction based on current weather information or prediction for future days.

h3. Customers and benefits

Can be useful for teachers when planning for activities that require higher attendance. For example, if the teacher wants to give their students a pop quiz about their current knowledge from lectures, to get a better idea of the class's general understanding it would be good to have as many answers as possible. This app would enable to predict the attendance for a class, and therefore to decide if it is worth it to plan a 30min window in the lecture for a quiz or to rather plan something else.

It could also be useful for students to decide how early to get to class to get the best seats. Many classrooms only have a limited number of plugs, and since a lot of students write notes on their laptops, the seats near these plugs are highly valuable. This app would enable the students to look how at how populated the building will be and decide if coming early to the lecture will be necessary to get those good seats.

h3. User input

- Date (or system date)

- Weather (predictions from official weather server prediction with possibility to manually input custom values)

- Building or classroom number (however, classroom number retrieves building data due to spacial granularity)

- Time? (TBD based on the achieved model accuracy)

h3. Output

- Rush level (very calm, calm, average, busy, very busy)

- Based on achieved model quality, visualization may be extended to a "heatmap" showing rush across the campus (TBD later in the process)

h3. Happy Day use-case

The user will specify a date and classroom (e.g. UC-336) for which they wish to get the prediction of attendance. It will be possible to choose to have the weather forecast data for the given day downloaded automatically or input manually. The output of the app will be a text field and a heatmap saying how high the attendance the model predicts (e.g. very high and a brightly lit up building).

h3. Key factors to judge application quality

* Application response time

* UI design appeal to the customer

* Maintainability (as a measure of effort required to update the model with new data)

Prediction quality is not guaranteed at this stage as data quality is out of our control and hugely impacts the output. Quality should also improve over time as more data is collected by UWB.

h3. Key product features

Server - administrative part

* Capable of being updated at admin request

* Capable of extending the model/updating it with new data/changing the model entirely (software designed to support smooth model transition)

Client - end user part

* Able to access prediction using the earlier specified input parameters

* Able to specify input parameters

* Heat map type visualisation

* Able to easily browse prediction across a greater range of time

* Has a web interface and/or mobile interface

h3. System parts & technologies

h4. Server (backend) part

There will be a server application which:

* will retrain prediction model when new data is available (or when a new model is defined by an administrator/maintainer),

* will run predictions based on client app requests and send the response once it is ready.

We decided that the backend will be developed in C# and .NET platform.

h4. Web frontend app

There will be a WebGL application:

* user will be able to specify arbitrary weather conditions (e.g. temperature, precipitation) or use an automatic weather forecast,

* user will be able to specify an arbitrary classroom at UWB,

* these input data will be made into a web request and sent to the server,

* The prediction result will be shown to the user when the response is received.

The app will be written in C# and Unity framework.

h4. Android app

There will be an android app with functionality similar to the web frontend. The app will also be developed with C# and Unity.

h2. Project Plan

h2. Stakeholders

* Development Team

* Project Sponsor

* Project Mentor

* Users: lecturers teaching classes at ZČU

* Users: students attending classes at ZČU

h2. Risks

h3. Available data is too crude

Chances are that the data is not specific enough to make proper predictions for some buildings, much less single classrooms. Hopefully, the model could be improved gradually when there is more data available. In the meantime, the granularity will be selected based on the model quality we achieve.

h3. Our effort estimation may be grossly underestimated

We should define/negotiate a minimum viable product and prioritize individual features.

h3. We proposed an unsuitable technological stack

Due to our unfamiliarity with web programming we've chosen to use technologies closer to our previous experience. These limit us in that the web application will not be easily compatible with mobile platforms. However, in turn, we can easily implement more complex UI and visualizations, and with some extra effort produce both a web and a mobile application using the same components.

h2. Solution

[[Minimum viable product]]

h2. Details

For more details about implementation and processed data consult [[Product details]]