CAFDI-7 - Create Multi TLD Gravity Model MVP

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+#Commit for isort + black
+1c8f965bed3dc226550db96eefc54866f521d116

.readthedocs.yaml

@@ -22,5 +22,7 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: docs/requirements.txt
-   - requirements: requirements.txt
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+

RELEASE.md

@@ -20,4 +20,4 @@ there.
 Below, a brief summary of patches made since the previous version can be found.
 
 ### Next Release Notes
-- Updated the license
+- Multi-TLD gravity model added

docs/conf.py

@@ -9,20 +9,15 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
 import sys
 import os
 from pathlib import Path
+import caf.distribute
 
-dir_path = Path(__file__).parents[1]
-source = dir_path / "src" / "caf" / "distribute"
-
-sys.path.insert(0, os.path.abspath(str(source)))
 
-# -- Project information -----------------------------------------------------
 project = "caf.distribute"
 copyright = "2023, Transport for the North"
 author = "Transport for the North"
@@ -80,5 +75,4 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-autodoc_mock_imports = ["caf"]
 autodoc_typehints = "description"

docs/gravity_model.rst

@@ -2,6 +2,8 @@ Gravity Model sub-package
 -------------------------
 
 .. toctree::
+    :maxdepth: 1
 
     core
-    single_area
+    single_area
+    multi_area

docs/index.rst

@@ -44,12 +44,20 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-Contents
---------
+Modules
+-------
 
 .. toctree::
+   :maxdepth: 1
 
    cost_functions
    furness
-   gravity_model
+   utils
+
+Sub-Packages
+------------
 
+.. toctree::
+   :maxdepth: 1
+
+   gravity_model

docs/multi_area.rst

@@ -0,0 +1,2 @@
+
+.. automodapi:: caf.distribute.gravity_model.multi_area

docs/requirements.txt

@@ -1,5 +1,5 @@
 # Required libraries for a doc build
 sphinx-automodapi>=0.16.0
 pydata-sphinx-theme>=0.14.1
-caf.distribute>=0.1.0
-graphviz>=0.20.1
+graphviz>=0.20.1
+versioningit>=2.2.0, < 3.0.0

docs/utils.rst

@@ -0,0 +1,2 @@
+
+.. automodapi:: caf.distribute.utils

pyproject.toml

@@ -24,6 +24,7 @@ dependencies = [
     "pandas>=1.4.0",
     "tqdm>=4.50.2",
     "caf.toolkit>=0.2.1",
+    "matplotlib>=3.8.2"
 ]
 
 [project.optional-dependencies]
@@ -74,6 +75,18 @@ disable = [
     "use-list-literal",
 ]
 
+[tool.isort]
+profile = "black"
+src_paths = ["src", "tests"]
+
+skip = ["__init__.py", "_version.py"]
+skip_glob = [".*"]
+
+# Section commenting
+import_heading_stdlib = "Built-Ins"
+import_heading_thirdparty = "Third Party"
+import_heading_firstparty = "Local Imports"
+
 # Pylint settings
 [tool.pylint.basic]
 good-names = ["df", "fn", "ca", "tp", "to", "x", "x1", "x2", "i", "f", "q", "mu"]
@@ -102,7 +115,7 @@ add-ignore = [
 # Tests
 [tool.pytest.ini_options]
 pythonpath = ["src"]
-addopts = '--cov=caf --cov-report=xml -n auto'
+addopts = '--cov=caf --cov-report=xml -n auto' # comment out this line to debug a test
 
 [tool.coverage.report]
 include_namespace_packages = true

requirements.txt

@@ -6,3 +6,4 @@ numpy>=1.19.0
 pandas>=1.4.0
 tqdm>=4.50.2
 caf.toolkit>=0.2.1
+matplotlib>=3.8.2

src/caf/distribute/cost_functions.py

@@ -4,19 +4,14 @@
 
 # Built-Ins
 import enum
-import random
 import inspect
 import logging
-
-from typing import Any
-from typing import Mapping
-from typing import Optional
-from typing import Callable
+import random
+from typing import Any, Callable, Mapping, Optional
 
 # Third Party
 import numpy as np
 
-# Local Imports
 # pylint: disable=import-error,wrong-import-position
 from caf.toolkit import math_utils
 

src/caf/distribute/furness.py

@@ -7,7 +7,6 @@
 # Third Party
 import numpy as np
 
-# Local Imports
 # pylint: disable=import-error,wrong-import-position
 
 # pylint: enable=import-error,wrong-import-position
@@ -74,6 +73,7 @@ def doubly_constrained_furness(
         The Root Mean Squared Error difference achieved before exiting
     """
     # pylint: disable=too-many-locals
+    # TODO(MB) Incorporate Nhan's furnessing optimisations
     # Error check
     if seed_vals.shape != (len(row_targets), len(col_targets)):
         raise ValueError(
@@ -134,7 +134,7 @@ def doubly_constrained_furness(
             # Calculate the diff - leave early if met
             row_diff = (row_targets - np.sum(furnessed_mat, axis=1)) ** 2
             col_diff = (col_targets - np.sum(furnessed_mat, axis=0)) ** 2
-            cur_rmse = (np.sum(row_diff + col_diff) / n_vals) ** 0.5
+            cur_rmse = ((np.sum(row_diff) + np.sum(col_diff)) / n_vals) ** 0.5
             if cur_rmse < tol:
                 early_exit = True
                 break

src/caf/distribute/gravity_model/__init__.py

@@ -3,8 +3,11 @@
 from caf.distribute.gravity_model.core import GravityModelResults
 from caf.distribute.gravity_model.core import GravityModelRunResults
 from caf.distribute.gravity_model.core import GravityModelCalibrateResults
+from caf.distribute.gravity_model.multi_area import (
+    MultiCostDistribution,
+    MultiDistInput,
+)
 
 # Models
 from caf.distribute.gravity_model.single_area import SingleAreaGravityModelCalibrator
-
-# import MultiTLDGravityModel
+from caf.distribute.gravity_model.multi_area import MultiAreaGravityModelCalibrator