Route choice API, link loading, path file generation

[Jake-Moss]

TODO:

• [X] Basic path file computation
• [X] Basic link flow computation
• [X] Adjust existing tests to new API
• [x] API solidification, it should mirror existing APIs. I think I'll go with a thin wrapper around the existing route choice object
• [x] Support multiple matrix slices. Current implementation of link loading assumes a single slice, this isn't difficult to change
• [x] Separate path file generation and link loading for now. Currently the link loading implementation uses the path files as an intermediate result
• [x] Map all outputs back to network IDs, currently everything is in compact form
• [ ] ~Saving of sparse path files into parquet~
• [x] Saving of dense and sparse link flows into results database
• [x] New tests for user facing class
• [ ] General code quality improvements, some methods are deeply intertwine with each other and generally too long, particularly the batched method, which is 252 lines
• [x] Documentation example

[pedrocamargo]

@janzill , can you take a look at this PR sometime before next Tuesday? That would allow Jake to jump straight into it

[pedrocamargo]

@Jake-Moss , the API looks pretty good. I think that with some minor tweaks and the example notebook, it will be perfect.

[Jake-Moss]

Didn't realise dict | dict was a 3.9 feature, I'll fix that next week

[pedrocamargo]

Didn't realise dict | dict was a 3.9 feature, I'll fix that next week

We no longer support Python 3.8, though

[pedrocamargo]

@Jake-Moss , in order to save choice sets to disk, we would need to either save the relationship between compact graph link and link/direction or convert it to link_id/direction.

Compact graphs are not permanent, so this becomes dangerous when saving to disk

[Jake-Moss]

@Jake-Moss , in order to save choice sets to disk, we would need to either save the relationship between compact graph link and link/direction or convert it to link_id/direction.

Compact graphs are not permanent, so this becomes dangerous when saving to disk

What file is that from? I can't see it on the latest commit, I thought that doc string was modified, either way any doc string that mentions the compact links is out of date, except apply_link_loading, which is used by get_load_results to return both https://github.com/AequilibraE/aequilibrae/blob/f55eac93e6c051330f66e56bfdf1af0334d019bf/aequilibrae/paths/route_choice.py#L330-L361 and the translation for the results table happens during its construction https://github.com/AequilibraE/aequilibrae/blob/f55eac93e6c051330f66e56bfdf1af0334d019bf/aequilibrae/paths/route_choice_set.pyx#L1173-L1182

[Jake-Moss]

I believe this is largely ready now, it is lacking select link analysis support, though that will come in a separate PR

[Jake-Moss]

Hmm I thought the CI was fixed...

[pedrocamargo]

Latest Mac-os is now M1...

[Jake-Moss]

Latest Mac-os is now M1...

Hmm that'll do it

[Jake-Moss]

Latest Mac-os is now M1...

I'm not sure what's going on now, the logs files said that the system was build a x86_64 wheel running on arm but deallocate doesn't seem have had an update in the last couple months. I wouldn't have expected that to break it. We'll see how this CI runs, testing locally gave me nothing to go on.

It doesn't seem to be respecting the `--ignore-missing-dependencies``

[Jake-Moss]

This PR is long enough, going to merge into the feature branch and merge develop, hopefully that'll fix some of the CI