55 Write mobility data

[HenrZu]

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

• Save data about the commuters during mobility
• Any Indices (or Groups of indices) can be chosen as input. Additionally, the total number of commuters is saved
• Additionally, it is possible to save only selected edges

If need be, add additional information and what the reviewer should look out for in particular:

• This functionality should be used carefully because if we save to many compartments from the edges, theres a large amount of storage necessary

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

• Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
• New code adheres to coding guidelines
• No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
• Tests are added for new functionality and a local test run was successful (with and without OpenMP)
• Appropriate documentation for new functionality has been added (Doxygen in the code and Markdown files if necessary)
• Proper attention to licenses, especially no new third-party software with conflicting license has been added
• (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

• Corresponding issue(s) is/are linked and addressed
• Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
• Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
• No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
• On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

Closes #55

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.63%. Comparing base (d4ed967) to head (97b44fd).
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #971      +/-   ##
==========================================
+ Coverage   96.44%   96.63%   +0.18%     
==========================================
  Files         135      137       +2     
  Lines       11286    11196      -90     
==========================================
- Hits        10885    10819      -66     
+ Misses        401      377      -24     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[HenrZu]

Using the setup in our simulation with ~30.000 edges and 50 simulation days, the size of the Edges.h file is 135mb.

[HenrZu]

There is an inconsistency in our project between the use of the terms migrated and mobility. I would leave them here for now and edit this PR after merging so that we only use mobility.

[reneSchm]

I have not looked at everything yet, and we should first discuss whether the condensed edge result (see my other comment), but here are some more things I found.

[reneSchm]

There is still some documentation that is missing new arguments, briefs or the param flags (i.e. [in], [out], [inout]). Please also make sure to use full sentences.

[reneSchm]

I think functionality wise this branch is fine, only the documentation needs a little touch up.

Could you please also add a short comment at the start of each new test that explains what it does, and, optimally, states the test case?