From 197ff6a7eda6ecfcc8f46989dca546444093fe68 Mon Sep 17 00:00:00 2001 From: Jack Burgess Date: Fri, 12 Jun 2026 14:13:20 +0100 Subject: [PATCH] feat: update python --- .../Case Study of Voyages data.ipynb | 10 +++++----- .../Fleet distribution per location.ipynb | 12 ++++++------ .../Vessel availability freight rate causality.ipynb | 2 +- tests/endpoints/test_availability_breakdown.py | 2 +- .../endpoints/vessel_availability_breakdown.py | 4 ++-- vortexasdk/endpoints/vessel_availability_search.py | 4 ++-- .../endpoints/vessel_availability_timeseries.py | 4 ++-- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb b/docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb index 5e5983e46..93a9e8070 100644 --- a/docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb +++ b/docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb @@ -116,7 +116,7 @@ }, { "cell_type": "code", - "execution_count": 3, + "execution_count": null, "id": "f2610ef4", "metadata": { "ExecuteTime": { @@ -284,7 +284,7 @@ " exclude_vessel_classes=vessel_class_excl,\n", " filter_destination=heading_to,\n", " exclude_destination=heading_to_excl,\n", - " filter_days_to_arrival=[{\"min\": laycan_min, \"max\": laycan_max}], # specify laycan window\n", + " filter_days_to_arrival={\"min\": laycan_min, \"max\": laycan_max}, # specify laycan window\n", " filter_vessel_scrubbers=\"disabled\",\n", " filter_vessel_status=status,\n", " use_reference_port=True\n", @@ -1440,7 +1440,7 @@ "metadata": {}, "source": [ "# Example 1: Fleet distribution per location\n", - "Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.", + "Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.\n", "\n", "\n", "**Note:** *The `risk_rating` and `risk_rating_excl` parameters (which map to `vessel_risk_level` and `vessel_risk_level_excluded` in the API) may not be available for all accounts. If not available, the filter will be ignored, results will not be filtered by risk level, and vessel_risk_level will not appear in response data.*" @@ -3206,7 +3206,7 @@ " \n", " \n", "\n", - "

164 rows \u00d7 3 columns

\n", + "

164 rows × 3 columns

\n", "" ], "text/plain": [ @@ -3407,4 +3407,4 @@ }, "nbformat": 4, "nbformat_minor": 5 -} \ No newline at end of file +} diff --git a/docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb b/docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb index 6e24369d9..c53e91a1e 100644 --- a/docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb +++ b/docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb @@ -125,7 +125,7 @@ }, { "cell_type": "code", - "execution_count": 6, + "execution_count": null, "id": "f2610ef4", "metadata": { "ExecuteTime": { @@ -293,7 +293,7 @@ " exclude_vessel_classes=vessel_class_excl,\n", " filter_destination=heading_to,\n", " exclude_destination=heading_to_excl,\n", - " filter_days_to_arrival=[{\"min\": laycan_min, \"max\": laycan_max}], # specify laycan window\n", + " filter_days_to_arrival={\"min\": laycan_min, \"max\": laycan_max}, # specify laycan window\n", " filter_vessel_scrubbers=\"disabled\",\n", " filter_vessel_status=status,\n", " use_reference_port=True\n", @@ -1449,7 +1449,7 @@ "metadata": {}, "source": [ "# Example 1: Fleet distribution per location\n", - "Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.", + "Track changes in tanker numbers in a custom set of Vortexa locations. In this example we monitor the supply of MR2 tankers in each basin (Atlantic and Pacific). This can indicate where supply side pressure might come into play for freight rates in various regions, as well as highlight changes in tanker migration patterns.\n", "\n", "\n", "**Note:** *The `risk_rating` and `risk_rating_excl` parameters (which map to `vessel_risk_level` and `vessel_risk_level_excluded` in the API) may not be available for all accounts. If not available, the filter will be ignored, results will not be filtered by risk level, and vessel_risk_level will not appear in response data.*" @@ -1470,7 +1470,7 @@ "name": "stdout", "output_type": "stream", "text": [ - "2024-09-17 15:52:52,899 vortexasdk.client \u2014 WARNING \u2014 You are using vortexasdk version 0.73.0, however version 0.73.1 is available.\n", + "2024-09-17 15:52:52,899 vortexasdk.client — WARNING — You are using vortexasdk version 0.73.0, however version 0.73.1 is available.\n", "You should consider upgrading via the 'pip install vortexasdk --upgrade' command.\n", "Downloading vessel_count for period: 2018-01-01 00:00:00 to 2021-12-31 23:59:59\n", "Downloading vessel_count for period: 2022-01-01 00:00:00 to 2024-09-17 15:53:38.241636\n", @@ -15343,7 +15343,7 @@ " \n", " \n", "\n", - "

196 rows \u00d7 3 columns

\n", + "

196 rows × 3 columns

\n", "" ], "text/plain": [ @@ -42607,4 +42607,4 @@ }, "nbformat": 4, "nbformat_minor": 5 -} \ No newline at end of file +} diff --git a/docs/examples/academy_use_cases/Freight & Voyages/Vessel availability freight rate causality.ipynb b/docs/examples/academy_use_cases/Freight & Voyages/Vessel availability freight rate causality.ipynb index e2ade0f38..f3d2e9eca 100644 --- a/docs/examples/academy_use_cases/Freight & Voyages/Vessel availability freight rate causality.ipynb +++ b/docs/examples/academy_use_cases/Freight & Voyages/Vessel availability freight rate causality.ipynb @@ -211,7 +211,7 @@ " exclude_vessel_classes=vessel_class_excl,\n", " filter_destination=heading_to,\n", " exclude_destination=heading_to_excl,\n", - " filter_days_to_arrival=[{\"min\": laycan_min, \"max\": laycan_max}], # specify laycan window\n", + " filter_days_to_arrival={\"min\": laycan_min, \"max\": laycan_max}, # specify laycan window\n", " filter_vessel_scrubbers=\"disabled\",\n", " filter_vessel_status=status,\n", " use_reference_port=True\n", diff --git a/tests/endpoints/test_availability_breakdown.py b/tests/endpoints/test_availability_breakdown.py index 2831d9527..5bd4fe72c 100644 --- a/tests/endpoints/test_availability_breakdown.py +++ b/tests/endpoints/test_availability_breakdown.py @@ -11,7 +11,7 @@ def test_search(self): df = ( VesselAvailabilityBreakdown() .search( - filter_days_to_arrival=[{"min": 0, "max": 5}], + filter_days_to_arrival={"min": 0, "max": 5}, filter_port=rotterdam, ) .to_df() diff --git a/vortexasdk/endpoints/vessel_availability_breakdown.py b/vortexasdk/endpoints/vessel_availability_breakdown.py index ae0c1c7fb..08f6b2e35 100644 --- a/vortexasdk/endpoints/vessel_availability_breakdown.py +++ b/vortexasdk/endpoints/vessel_availability_breakdown.py @@ -42,7 +42,7 @@ def search( filter_region: Optional[str] = None, filter_port: Optional[str] = None, use_reference_port: bool = False, - filter_days_to_arrival: Optional[List[Dict[str, int]]] = None, + filter_days_to_arrival: Optional[Dict[str, int]] = None, filter_vessel_dwt_min: Optional[int] = None, filter_vessel_dwt_max: Optional[int] = None, filter_vessel_age_min: Optional[int] = None, @@ -212,7 +212,7 @@ def search( "filter_region": filter_region, "filter_port": filter_port, "use_reference_port": use_reference_port, - "filter_days_to_arrival": convert_to_list(filter_days_to_arrival), + "filter_days_to_arrival": filter_days_to_arrival, "filter_vessel_dwt_min": filter_vessel_dwt_min, "filter_vessel_dwt_max": filter_vessel_dwt_max, "filter_vessel_age_min": filter_vessel_age_min, diff --git a/vortexasdk/endpoints/vessel_availability_search.py b/vortexasdk/endpoints/vessel_availability_search.py index aae19fb5f..bdca67c7a 100644 --- a/vortexasdk/endpoints/vessel_availability_search.py +++ b/vortexasdk/endpoints/vessel_availability_search.py @@ -43,7 +43,7 @@ def search( filter_owners: Optional[Union[ID, List[ID]]] = None, filter_effective_controllers: Optional[Union[ID, List[ID]]] = None, filter_destination: Optional[Union[ID, List[ID]]] = None, - filter_days_to_arrival: Optional[List[Dict[str, int]]] = None, + filter_days_to_arrival: Optional[Dict[str, int]] = None, filter_vessel_dwt_min: Optional[int] = None, filter_vessel_dwt_max: Optional[int] = None, filter_vessel_age_min: Optional[int] = None, @@ -219,7 +219,7 @@ def search( "filter_region": filter_region, "filter_port": filter_port, "use_reference_port": use_reference_port, - "filter_days_to_arrival": convert_to_list(filter_days_to_arrival), + "filter_days_to_arrival": filter_days_to_arrival, "filter_vessel_dwt_min": filter_vessel_dwt_min, "filter_vessel_dwt_max": filter_vessel_dwt_max, "filter_vessel_age_min": filter_vessel_age_min, diff --git a/vortexasdk/endpoints/vessel_availability_timeseries.py b/vortexasdk/endpoints/vessel_availability_timeseries.py index 7663a9f2e..f98be5474 100644 --- a/vortexasdk/endpoints/vessel_availability_timeseries.py +++ b/vortexasdk/endpoints/vessel_availability_timeseries.py @@ -46,7 +46,7 @@ def search( filter_region: Optional[str] = None, filter_port: Optional[str] = None, use_reference_port: bool = False, - filter_days_to_arrival: Optional[List[Dict[str, int]]] = None, + filter_days_to_arrival: Optional[Dict[str, int]] = None, filter_vessel_dwt_min: Optional[int] = None, filter_vessel_dwt_max: Optional[int] = None, filter_vessel_age_min: Optional[int] = None, @@ -226,7 +226,7 @@ def search( "filter_region": filter_region, "filter_port": filter_port, "use_reference_port": use_reference_port, - "filter_days_to_arrival": convert_to_list(filter_days_to_arrival), + "filter_days_to_arrival": filter_days_to_arrival, "filter_vessel_dwt_min": filter_vessel_dwt_min, "filter_vessel_dwt_max": filter_vessel_dwt_max, "filter_vessel_age_min": filter_vessel_age_min,