281 Scaling of commuter migration/mobility data

[HenrZu]

Implements scaling for the commuter mobility data.

• The Scaling is based on the center point of each county. This method is efficient, but also sometimes inaccurate.
• In order to have the input file (center points) also for the test cases, it was added to the constructor
• Since no scaling of commuter mobility was done before, the comparison values of the unit tests had to be adjusted as well.

Merge Request - GuideLine Checklist

Guideline to check code before resolve WIP and approval, respectively.
As many checkboxes as possible should be ticked.

Checks by code author:

• There is at least one issue associated with the pull request.
• The branch follows the naming conventions as defined in the git workflow.
• New code adheres with the coding guidelines
• Tests for new functionality has been added
• A local test was succesful
• There is appropriate documentation of your work. (use doxygen style comments)
• If new third party software is used, did you pay attention to its license? Please remember to add it to the wiki after successful merging.
• If new mathematical methods or epidemiological terms are used, has the glossary been updated ? Did you provide further documentation ?
  is present or referenced. Please provide your references.
• The following questions are addressed in the documentation*: Developers (what did you do?, how can it be maintained?), For users (how to use your work?), For admins (how to install and configure your work?)
• For documentation: Please write or update the Readme in the current working directory!

Checks by code reviewer(s):

• Is the code clean of development artifacts e.g., unnecessary comments, prints, ...
• The ticket goals for each associated issue are reached or problems are clearly addressed (i.e., a new issue was introduced).
• There are appropriate unit tests and they pass.
• The git history is clean and linearized for the merge request.
• Coverage report for new code is acceptable.

Closes #281

[codecov-commenter]

Codecov Report

Merging #291 (22fd400) into main (8b25d83) will increase coverage by 0.13%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #291      +/-   ##
==========================================
+ Coverage   91.23%   91.36%   +0.13%     
==========================================
  Files          77       79       +2     
  Lines        4721     4854     +133     
==========================================
+ Hits         4307     4435     +128     
- Misses        414      419       +5     

Impacted Files	Coverage Δ
cpp/memilio/utils/custom_index_array.h	97.76% <0.00%> (-1.40%)	⬇️
cpp/models/abm/location.cpp	99.03% <0.00%> (-0.97%)	⬇️
cpp/models/abm/time.h	100.00% <0.00%> (ø)
cpp/models/abm/world.h	100.00% <0.00%> (ø)
cpp/models/abm/person.h	100.00% <0.00%> (ø)
cpp/models/abm/household.h	100.00% <0.00%> (ø)
cpp/models/abm/parameters.h	100.00% <0.00%> (ø)
cpp/models/abm/simulation.h	100.00% <0.00%> (ø)
cpp/memilio/utils/stl_util.h	100.00% <0.00%> (ø)
cpp/models/abm/household.cpp	100.00% <0.00%> (ø)
... and 11 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8b25d83...22fd400. Read the comment docs.

[mknaranja]

Looks good. Only some small modifications necessary. But let us also again discuss implications/statistics for the changes.

[mknaranja]

Is it possible to tag the centers with the county ID? Then we would also only need one bigger file and one with the changes with respect to the other.

[HenrZu]

Added the tags in the dataframe.
I had also considered creating a large file and uploading only the changes for the reduced dimension. However, both files are created from different geojsons and therefore the coordinates are slightly different. Thus, it may be better to upload 2 individual files.

[mknaranja]

Please introduce some value tests where no scaling happened.

[HenrZu]

added in latest commit

[mknaranja]

Please use default argument 'None' and check if this is 'None'

[HenrZu]

added in latest commit

[mknaranja]

Could you replace migration with mobility everywhere?

[HenrZu]

Did this in the last commit for getCommuterMobility.py and test_epidata_getCommuterMobility.py