Type hint fix

[Kieran-Fishwick-TfN]

Describe Changes

updated multi tld API

Task Checklist

• Have unittests been added (testing individual functions and their edge cases)
• Have integration tests been added (if applicable, to test modules of functionality)
• Updated RELEASE.md to reflect changes in PR
• Is the documentation building correctly with a clean version number?
• Have new dependencies been added?
  • Have they been added to either requirements.txt or requirements_dev.txt.
  • Have they been added to setup.cfg

[MattBuckley-TfN]

I think the methodology looks good, I've mainly made comments around cleaning up the code and adding documentation.

Some more general things that need updating are:

• Running isort (specifically on multi_area)
• Fixing pylint issues, many of these are covered by comments for tidying up.
• A bunch of tests are failing due to removing the params argument from MultiAreaGravityModelCalibrator these can just be updated to reflect the API change
• One test is failing due to init params outside the new boundaries for tanner, the init parameter for the test is 4.7... and -1.6..., potentially just bringing those init params within the limits will solve the issue with the test (tests\gravity_model\data\small_and_simple\tanner\calibrate\init_params.json)

There's one additional comment on the code which I couldn't make because you haven't edited that line.
Line 726 in multi_area.py: multi_area.gravity_model function has the wrong type annotation for cost_distributions should be MultiCostDistribution not list[MultiCostDistribution]

[codecov]

Codecov Report

Attention: Patch coverage is 77.77778% with 26 lines in your changes missing coverage. Please review.

Project coverage is 85.29%. Comparing base (33cd564) to head (269942c).
Report is 12 commits behind head on main.

Files with missing lines	Patch %	Lines
src/caf/distribute/gravity_model/core.py	33.33%	14 Missing ⚠️
src/caf/distribute/gravity_model/multi_area.py	87.23%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #46      +/-   ##
==========================================
- Coverage   86.31%   85.29%   -1.03%     
==========================================
  Files          11       11              
  Lines         994     1047      +53     
==========================================
+ Hits          858      893      +35     
- Misses        136      154      +18     

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

[MattBuckley-TfN]

Couple of previous comments haven't been addressed and one new one about a TODO that I think has been completed