287 improve osm maps with tag metadata

r-leyshon commented 5 months ago

Description

FindTags now issues a PerformanceWarning if the OSM file it is being instantiated with is larger than 500 KB.
FindLocations.plot_ids() now has an include_tags parameter, False by default. Setting this to True adds all the tag metadata to the folium map tooltip.
FindLocations.plot_ids() now exposes selected folium map styling parameters.
An example implementation is included in the quarto OSM tutorial.
Finally, all the runners broke when raising PR, as breaking changes with numpy 2.0.0 that had nothing to do with this diff. My solution has been to pin numpy version to that which passed in the previous successful run.

Fixes #287

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

Test configuration details:

OS: macos
Python version: 3.9.13
Java version: openjdk 11.0.19 2023-04-18 LTS
Python management system: pip

Advice for reviewer

Checklist:

[X] My code follows the intended structure of this project
[X] I have performed a self-review of my own code
[X] I have commented my code, particularly in hard-to-understand areas
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[X] I have added tests that prove my fix is effective or that my feature works
[X] New and existing unit tests pass locally with my changes
[X] Any dependent changes have been merged and published in downstream modules

Additional comments

r-leyshon commented 4 months ago

Hey @CBROWN-ONS , I've just implemented your suggestions and pushed the diff to the PR. Thanks for your review on this, some good catches in there.

codecov-commenter commented 4 months ago

Codecov Report

Attention: Patch coverage is 98.24561% with 1 line in your changes missing coverage. Please review.

Project coverage is 98.13%. Comparing base (3fa154e) to head (3004a81).

Files	Patch %	Lines
src/transport_performance/osm/validate_osm.py	98.24%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## dev #294 +/- ## ======================================= Coverage 98.13% 98.13% ======================================= Files 21 21 Lines 1927 1983 +56 ======================================= + Hits 1891 1946 +55 - Misses 36 37 +1 ``` | [Flag](https://app.codecov.io/gh/datasciencecampus/transport-network-performance/pull/294/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datasciencecampus) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/datasciencecampus/transport-network-performance/pull/294/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datasciencecampus) | `98.13% <98.24%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datasciencecampus#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

CBROWN-ONS commented 4 months ago

Thanks for the changes @r-leyshon . All good, will merge this now.

datasciencecampus / transport-network-performance