Added distance unit to Shipment Analyzer

BojanaVuckovic · BojanaVuckovic · commit de3132535254 · 2025-07-24T11:01:02.000+02:00
diff --git a/pyloghub/shipment_analyzer.py b/pyloghub/shipment_analyzer.py
@@ -63,6 +63,7 @@ def forward_shipment_analyzer(shipments: pd.DataFrame, cost_adjustment: pd.DataF
     parameters (Dict): Dictionary containing parameters for the analysis.
         Keys and their types:
         - consolidation (bool): Boolean flag to indicate if consolidation should be considered in the analysis.
+        - distanceUnit (str): Distance unit "km" or "mi".
 
     api_key (str): Log-hub API key for accessing the shipment analyzer service.
 
@@ -157,7 +158,8 @@ def forward_shipment_analyzer_sample_data():
     surcharges_df = pd.read_excel(data_path, sheet_name='surcharges', usecols='A:C').fillna("")
 
     parameters = {
-        "consolidation": False
+        "consolidation": False,
+        "distanceUnit": "km"
     }
 
     save_scenario = {
@@ -226,6 +228,7 @@ def reverse_shipment_analyzer(shipments: pd.DataFrame, cost_adjustment: pd.DataF
     parameters (Dict): Dictionary containing parameters for the analysis.
         Keys and their types:
         - consolidation (bool): Boolean flag to indicate if consolidation should be considered in the analysis.
+        - distanceUnit (str): Distance unit "km" or "mi".
 
     api_key (str): API key for accessing the reverse shipment analyzer service.
 
@@ -322,7 +325,8 @@ def reverse_shipment_analyzer_sample_data():
     surcharges_df = pd.read_excel(data_path, sheet_name='surcharges', usecols='A:C').fillna("")
 
     parameters = {
-        "consolidation": False
+        "consolidation": False,
+        "distanceUnit": "km"
     }
 
     save_scenario = {
