Update README

This minor update changes the README style and adds more content to it.

Improved computation and score

Merge pull request #9 from UCA-Datalab/develop

v1.1.3

Fix web issues

Fix some issues with the dataloaders.py script, that caused errors in our web application.

You can check our web here!

UCM Modelling Week, and minor upgrade to config

In this release, we include the new combine.py script, which is used to merge the different NPI score files into a single one - that adds the province and AC column to identify the region affected. The output of this new script will be used during the Modelling Week 2021, hosted in the faculty of Mathematics of Complutense University (Madrid).

We also updated the config to work better with the Spanish provinces names.

Informative log and small refactorization

This release makes two major changes:

• Includes informative log messages for debugging the code. Also raises a warning any time an unexpected value is found during preprocessing (last version modified the value according to certain rules, without warning about it).
• Refactors the code, moving functions to the appropriate module. Mainly, we ensure that the preprocessing is easier to follow than before.

Our next step is to revise the scoring process.

COVID NPI for Spain

To use this package, you need to have the NPI data from Spain. This data is stored in files named "Medidas_CCAA_YYYYMMDD.xlsm", being "CCAA" the acronym of the Autonomous Community (for example, MAD for Madrid), and "YYYYMMDD" the date when the data was collected (different CCAA may have different dates). These xlsm files must be placed in the same folder (for instance, "datos_NPI"). From now on, the route to that folder is called path_raw.

You also need a "Taxonomía.xlsx" file. The route to it is called path_taxonomia. This excel file has several sheets, each of them dedicated to a specific ambit where NPI are applied (like education, sports or restaurants). The sheets contain the scores assigned to each action and item, depending on their severity. We use "Taxonomía.xlsx" to score the NPI applied to different ambits.

This package contains the scripts and functions required to read and preprocess the data of path_raw, then score the actions and items taken, according to path_taxonomia. The final output will be one csv file per province, containing the daily scores of each item and ambit.