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

h1. Product Vision Statement

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) - dd:mm:yyyy + Time - hh

** Start and end dateTime for prediction of rush level over a timespan, or just start dateTime for prediction at one specific time

* Weather

** automatic prediction from official weather server prediction 

** possibility to manually input custom values - temperature, wind, rain probability, weather conditions (sunny/cloudy/overcast/dark)  

* classroom prefix (-> will be interpreted as building the classroom is in)

h3. Output

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

** Visualization as a "heatmap" showing rush across the campus

** If user put end date an animation of changes in rush level

Prediction is made on the level of buildings, potentially groups of buildings in the city centre, as divided in [[Data sources]]. Rush level is relative to the building it is related to. 50% on FAV does not have to mean the same predicted value of activity as 50% on FST, it depends on usual amount of activity read from data for each specific building

h3. Happy Day use-case

The user will specify a date, time and classroom (e.g. UC, 23.6.2021 7am) 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 user has to option to input custom weather manually. The output of the app will be a text field and a heatmap saying the rush level 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 appeals 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 ZČU.

h3. Product features

Bold parts are part of Minimum viable product.

h4. Server (backend) part

There will be a server application which:

* *Command line application*

* *Runs on linux*

** *Test on openNebula*

** *OS: Debian GNU/Linux 10, version 10.9*

** HW requiremnts: TBD (default settings when creating VM on OpenNebula seem to suffice)

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

* Software designed to support smooth model transition

** *Modular application*, easy to swap parts (for ex. spap for different data parser or data loader or possibly in the future for different data)

* *Configuration file read upon launch*

** *Modifies local data folder path* 

** Modifies link to online directory open data

** Link to weather prediction data

* *Works with zču open data*

** *Data in question: historic weather data, jis activity, computer activity* 

** *Can interpret as whole day*

** *Can interpret as hourly intervals*

* *Works with weeather prediction, always for today, tommorrow and the day after tommorow*

* *Communication with Front end app*

** *HTTPS server implementation*

* *Admin requests*

** Capable of checking for new open data in online files directory

** *Capable of writing out data that the current model was trained on*

** *Capable of updating data at admin request* - download new files from online directory

*** Download for certain timespan

*** *Download for specific month*

** *Capable of retraining prediction model on admin request*

*** Retraining for data from specific timespan -> filter out other files

*** *Can divide day into multiple intervals for which it will predict, or predict for day only*

*** *Capable of rollback*

**** *No history preserved, capable of only switching to the "previous" used model* (only keeps in memory one previous model)

* Capable of fullfiling requests and send answers to more than one client applications.

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

h4. Frontend app

* Able to specify input parameters

** *User able to specify either one speicfic time, or time interval (between today and the day after tommorrow) for which will be created rush prediction*

** *User will be able to specify an arbitrary classroom prefix at ZCU*

** *User has the option to use an automatic weather forecast*

** *User will be able to specify arbitrary weather conditions (e.g. temperature, precipitation)*

* Able to access and visualize prediction using the earlier specified input parameters

** *Heat map type visualisation*

*** *Navigation (zoom, pan)*

*** *Pngs for separate buildings*

*** *Animating colours representing rush level*

** *Center "camera" on selected building* (used when searching for a specific building, so user doesn't have to navigate manually)

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

*** *Rewind, play, move step-by-step*

* *Legend describing* 

** *Buildings* 

** *Rush level visualistaion*

** *Work with application* (instead of tooltips)

* Accessible design

** Tooltips

** Date picker / *tabs to change cells*

** *Visible checkboxes*

** Autocomplete

** *Date format always visible*

* User interface

** *Prevent illogical operations*

** *Web application - WebGL*

*** *Works for multiple browsers (chrome and mozilla, on win and linux)*

** Mobile application - Android

*** Handling mobile specific events

*** Networking issues

*** Problems caused by file system incompatibility

*** Date picker

*** Different input system

*** Different layout

**** New UI script connection

* *Able to download weather prediction*

* *Communication with server*

** *Recieve rush level prediction*

*** *For one specific time*

*** *For time interval*

* *Hosting on a webpage*

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

h2. Project Plan

See Redmine tab Roadmap.

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

MVP - see bold parts of *Key product features*

h3. Technical details

h4. Server application

* *Works with csv format of open data (as specified in [[Data sources]])*

* *Works with json format of weather prediction (as specified in [[Data sources]])*

* Communication - *Implementing protocol* (as specified in [[]])

** *Sends xml files (recieve, send, parse)*

* *Testing*

** *Bugfixes*

h4. Front end application

** Implements protocol - UnityWeb requests

* Pages hosting

** *Github*

** Gitlab

* *Testing*

** *End user testing*

** *Bugfixes according to tests*

h2. Details

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